From 405fb16f624492b193d2e8107ba0542a1fecec2d Mon Sep 17 00:00:00 2001 From: Christoph Grothaus Date: Wed, 13 Sep 2023 15:58:12 +0000 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20add=20new=20devcontainer=20feature?= =?UTF-8?q?=20`node-asdf`=20to=20install=20Node.js=20via=20asdf?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/node-asdf/README.md | 18 +++ src/node-asdf/devcontainer-feature.json | 20 +++ src/node-asdf/install.sh | 23 +++ src/node-asdf/library_scripts.sh | 179 ++++++++++++++++++++++++ test/node-asdf/scenarios.json | 8 ++ test/node-asdf/test.sh | 9 ++ 6 files changed, 257 insertions(+) create mode 100644 src/node-asdf/README.md create mode 100644 src/node-asdf/devcontainer-feature.json create mode 100755 src/node-asdf/install.sh create mode 100644 src/node-asdf/library_scripts.sh create mode 100644 test/node-asdf/scenarios.json create mode 100755 test/node-asdf/test.sh diff --git a/src/node-asdf/README.md b/src/node-asdf/README.md new file mode 100644 index 000000000..d2ec74f8d --- /dev/null +++ b/src/node-asdf/README.md @@ -0,0 +1,18 @@ + +# Node.js (via asdf) (node-asdf) + +Installs Node.js via asdf. + +## Example DevContainer Usage + +```json +"features": { + "ghcr.io/devcontainers-contrib/features/node-asdf:0": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | Select the version to install. | string | latest | diff --git a/src/node-asdf/devcontainer-feature.json b/src/node-asdf/devcontainer-feature.json new file mode 100644 index 000000000..3c9ac7e3b --- /dev/null +++ b/src/node-asdf/devcontainer-feature.json @@ -0,0 +1,20 @@ +{ + "id": "node-asdf", + "version": "0.0.1", + "name": "Node.js (via asdf)", + "documentationURL": "http://github.com/devcontainers-contrib/features/tree/main/src/node-asdf", + "description": "Installs Node.js via asdf", + "options": { + "version": { + "default": "latest", + "description": "Select the version to install.", + "proposals": [ + "latest" + ], + "type": "string" + } + }, + "installsAfter": [ + "ghcr.io/devcontainers-contrib/features/asdf-package" + ] +} diff --git a/src/node-asdf/install.sh b/src/node-asdf/install.sh new file mode 100755 index 000000000..36310a40b --- /dev/null +++ b/src/node-asdf/install.sh @@ -0,0 +1,23 @@ +#!/bin/bash -i + +set -e + +source ./library_scripts.sh + +# nanolayer is a cli utility which keeps container layers as small as possible +# source code: https://github.com/devcontainers-contrib/nanolayer +# `ensure_nanolayer` is a bash function that will find any existing nanolayer installations, +# and if missing - will download a temporary copy that automatically get deleted at the end +# of the script +ensure_nanolayer nanolayer_location "v0.4.45" + + +$nanolayer_location \ + install \ + devcontainer-feature \ + "ghcr.io/devcontainers-contrib/features/asdf-package:1.0.8" \ + --option plugin='nodejs' --option version="$VERSION" + + + +echo 'Done!' diff --git a/src/node-asdf/library_scripts.sh b/src/node-asdf/library_scripts.sh new file mode 100644 index 000000000..8f9bd9a0e --- /dev/null +++ b/src/node-asdf/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/node-asdf/scenarios.json b/test/node-asdf/scenarios.json new file mode 100644 index 000000000..5bef3fcbf --- /dev/null +++ b/test/node-asdf/scenarios.json @@ -0,0 +1,8 @@ +{ + "test": { + "image": "mcr.microsoft.com/devcontainers/base:debian", + "features": { + "node-asdf": {} + } + } +} diff --git a/test/node-asdf/test.sh b/test/node-asdf/test.sh new file mode 100755 index 000000000..b65caa2e7 --- /dev/null +++ b/test/node-asdf/test.sh @@ -0,0 +1,9 @@ +#!/bin/bash -i + +set -e + +source dev-container-features-test-lib + +check "node --version" node --version + +reportResults