diff --git a/src/vscode-cli/README.md b/src/vscode-cli/README.md new file mode 100644 index 000000000..a44b25c94 --- /dev/null +++ b/src/vscode-cli/README.md @@ -0,0 +1,23 @@ +# Visual Studio Code CLI (vscode-cli) + +[Visual Studio Code CLI](https://code.visualstudio.com/docs/editor/command-line) (official Microsoft build), which manages the Visual Studio Code Server and `vscode.dev` tunnels. + +## Example Usage + +```json +"features": { + "ghcr.io/devcontainers-contrib/features/vscode-cli:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | Specify the Visual Studio Code CLI version to install; or "latest"; or "commit:<hash>" | string | latest | + +--- + +## Launch + +Run `code serve-web` to download and run Visual Studio Code Server listening on port 8000; or run `code tunnel` to start a `vscode.dev` tunnel. Commands that require a full desktop installation of Visual Studio Code will not work. diff --git a/src/vscode-cli/devcontainer-feature.json b/src/vscode-cli/devcontainer-feature.json new file mode 100644 index 000000000..df8087698 --- /dev/null +++ b/src/vscode-cli/devcontainer-feature.json @@ -0,0 +1,17 @@ +{ + "name": "Visual Studio Code CLI", + "id": "vscode-cli", + "version": "1.0.0", + "description": "Visual Studio Code CLI (official Microsoft build), which manages the Visual Studio Code Server and vscode.dev tunnels.", + "documentationURL": "https://github.com/devcontainers-contrib/features/tree/main/src/vscode-cli", + "options": { + "version": { + "type": "string", + "proposals": [ + "latest" + ], + "default": "latest", + "description": "Specify the Visual Studio Code CLI version to install; or \"latest\"; or \"commit:\"" + } + } +} \ No newline at end of file diff --git a/src/vscode-cli/install.sh b/src/vscode-cli/install.sh new file mode 100644 index 000000000..4853f3f0d --- /dev/null +++ b/src/vscode-cli/install.sh @@ -0,0 +1,52 @@ +#!/usr/bin/env bash + +. ./library_scripts.sh + +VSCODE_VERSION="${VERSION:-"latest"}" + +set -e + +if [ "$(id -u)" -ne 0 ]; then + echo 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.' + exit 1 +fi + +ARCH="$(uname -m)" +if [ "${ARCH}" == "x86_64" ] ; then + if [ -f "/lib/ld-musl-x86_64.so.1" ] ; then + ARCH="alpine-x64" + else + ARCH="linux-x64" + fi +elif [ "${ARCH}" == "aarch64" ] || [ "${ARCH}" == "arm64" ];; then + if [ -f "/lib/ld-musl-aarch64.so.1" ] ; then + ARCH="alpine-arm64" + else + ARCH="linux-arm64" + fi +elif [ "${ARCH}" == "arm" ]; then + ARCH="linux-armhf" +else + echo -e "unsupported arch: ${ARCH}" + exit 1 +fi + +DOWNLOAD_URL="https://update.code.visualstudio.com/${VSCODE_VERSION}/cli-${ARCH}/stable/" + +# make sure /usr/local/lib exists +mkdir -p /usr/local/lib + +# remove existing installations +rm -rf /usr/local/lib/vscode-cli-${ARCH} +rm -f $(command -v code) || true +rm -f /usr/local/bin/code + +DOWNLOAD_PATH=$(mktemp) +clean_download ${DOWNLOAD_URL} ${DOWNLOAD_PATH} + +# download binary and untar +tar xz -C /usr/local/bin -f ${DOWNLOAD_PATH} + +rm ${DOWNLOAD_PATH} + +echo "Done!" diff --git a/src/vscode-cli/library_scripts.sh b/src/vscode-cli/library_scripts.sh new file mode 100644 index 000000000..8f9bd9a0e --- /dev/null +++ b/src/vscode-cli/library_scripts.sh @@ -0,0 +1,179 @@ +#!/bin/bash -i + + +clean_download() { + # The purpose of this function is to download a file with minimal impact on container layer size + # this means if no valid downloader is found (curl or wget) then we install a downloader (currently wget) in a + # temporary manner, and making sure to + # 1. uninstall the downloader at the return of the function + # 2. revert back any changes to the package installer database/cache (for example apt-get lists) + # The above steps will minimize the leftovers being created while installing the downloader + # Supported distros: + # debian/ubuntu/alpine + + url=$1 + output_location=$2 + tempdir=$(mktemp -d) + downloader_installed="" + + function _apt_get_install() { + tempdir=$1 + + # copy current state of apt list - in order to revert back later (minimize contianer layer size) + cp -p -R /var/lib/apt/lists $tempdir + apt-get update -y + apt-get -y install --no-install-recommends wget ca-certificates + } + + function _apt_get_cleanup() { + tempdir=$1 + + echo "removing wget" + apt-get -y purge wget --auto-remove + + echo "revert back apt lists" + rm -rf /var/lib/apt/lists/* + rm -r /var/lib/apt/lists && mv $tempdir/lists /var/lib/apt/lists + } + + function _apk_install() { + tempdir=$1 + # copy current state of apk cache - in order to revert back later (minimize contianer layer size) + cp -p -R /var/cache/apk $tempdir + + apk add --no-cache wget + } + + function _apk_cleanup() { + tempdir=$1 + + echo "removing wget" + apk del wget + } + # try to use either wget or curl if one of them already installer + if type curl >/dev/null 2>&1; then + downloader=curl + elif type wget >/dev/null 2>&1; then + downloader=wget + else + downloader="" + fi + + # in case none of them is installed, install wget temporarly + if [ -z $downloader ] ; then + if [ -x "/usr/bin/apt-get" ] ; then + _apt_get_install $tempdir + elif [ -x "/sbin/apk" ] ; then + _apk_install $tempdir + else + echo "distro not supported" + exit 1 + fi + downloader="wget" + downloader_installed="true" + fi + + if [ $downloader = "wget" ] ; then + wget -q $url -O $output_location + else + curl -sfL $url -o $output_location + fi + + # NOTE: the cleanup procedure was not implemented using `trap X RETURN` only because + # alpine lack bash, and RETURN is not a valid signal under sh shell + if ! [ -z $downloader_installed ] ; then + if [ -x "/usr/bin/apt-get" ] ; then + _apt_get_cleanup $tempdir + elif [ -x "/sbin/apk" ] ; then + _apk_cleanup $tempdir + else + echo "distro not supported" + exit 1 + fi + fi + +} + + +ensure_nanolayer() { + # Ensure existance of the nanolayer cli program + local variable_name=$1 + + local required_version=$2 + # normalize version + if ! [[ $required_version == v* ]]; then + required_version=v$required_version + fi + + local nanolayer_location="" + + # If possible - try to use an already installed nanolayer + if [[ -z "${NANOLAYER_FORCE_CLI_INSTALLATION}" ]]; then + if [[ -z "${NANOLAYER_CLI_LOCATION}" ]]; then + if type nanolayer >/dev/null 2>&1; then + echo "Found a pre-existing nanolayer in PATH" + nanolayer_location=nanolayer + fi + elif [ -f "${NANOLAYER_CLI_LOCATION}" ] && [ -x "${NANOLAYER_CLI_LOCATION}" ] ; then + nanolayer_location=${NANOLAYER_CLI_LOCATION} + echo "Found a pre-existing nanolayer which were given in env variable: $nanolayer_location" + fi + + # make sure its of the required version + if ! [[ -z "${nanolayer_location}" ]]; then + local current_version + current_version=$($nanolayer_location --version) + if ! [[ $current_version == v* ]]; then + current_version=v$current_version + fi + + if ! [ $current_version == $required_version ]; then + echo "skipping usage of pre-existing nanolayer. (required version $required_version does not match existing version $current_version)" + nanolayer_location="" + fi + fi + + fi + + # If not previuse installation found, download it temporarly and delete at the end of the script + if [[ -z "${nanolayer_location}" ]]; then + + if [ "$(uname -sm)" == "Linux x86_64" ] || [ "$(uname -sm)" == "Linux aarch64" ]; then + tmp_dir=$(mktemp -d -t nanolayer-XXXXXXXXXX) + + clean_up () { + ARG=$? + rm -rf $tmp_dir + exit $ARG + } + trap clean_up EXIT + + + if [ -x "/sbin/apk" ] ; then + clib_type=musl + else + clib_type=gnu + fi + + tar_filename=nanolayer-"$(uname -m)"-unknown-linux-$clib_type.tgz + + # clean download will minimize leftover in case a downloaderlike wget or curl need to be installed + clean_download https://github.com/devcontainers-contrib/cli/releases/download/$required_version/$tar_filename $tmp_dir/$tar_filename + + tar xfzv $tmp_dir/$tar_filename -C "$tmp_dir" + chmod a+x $tmp_dir/nanolayer + nanolayer_location=$tmp_dir/nanolayer + + + else + echo "No binaries compiled for non-x86-linux architectures yet: $(uname -m)" + exit 1 + fi + fi + + # Expose outside the resolved location + declare -g ${variable_name}=$nanolayer_location + +} + + diff --git a/test/vscode-cli/scenarios.json b/test/vscode-cli/scenarios.json new file mode 100644 index 000000000..4e6a7aff3 --- /dev/null +++ b/test/vscode-cli/scenarios.json @@ -0,0 +1,8 @@ +{ + "test": { + "image": "mcr.microsoft.com/devcontainers/base:debian", + "features": { + "vscode-cli": {} + } + } +} \ No newline at end of file diff --git a/test/vscode-cli/test.sh b/test/vscode-cli/test.sh new file mode 100644 index 000000000..cb235d72e --- /dev/null +++ b/test/vscode-cli/test.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +set -e + +source dev-container-features-test-lib + +check "vscode-cli" code --version + +reportResults