Skip to content
This repository was archived by the owner on Jan 12, 2025. It is now read-only.

Commit 835a65a

Browse files
authored
Add devcontainer CLI (#562)
1 parent cf4ea30 commit 835a65a

File tree

6 files changed

+259
-0
lines changed

6 files changed

+259
-0
lines changed

src/devcontainers-cli/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
# devcontainers CLI (devcontainers-cli)
3+
4+
The [devcontainers CLI](https://github.com/devcontainers/cli), which configures devcontainers from `devcontainer.json`. Requires the Docker client and access to a container engine daemon socket (e.g. by mounting the host's Docker socket into the container)
5+
6+
## Example devcontainers CLI Usage
7+
8+
```json
9+
"features": {
10+
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
11+
"ghcr.io/devcontainers-contrib/features/devcontainers-cli:1": {}
12+
}
13+
```
14+
15+
## Options
16+
17+
| Options Id | Description | Type | Default Value |
18+
|-----|-----|-----|-----|
19+
| version | Specify the version to install | string | latest |
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"id": "devcontainers-cli",
3+
"version": "1.0.0",
4+
"name": "devcontainers CLI",
5+
"documentationURL": "http://github.com/devcontainers-contrib/features/tree/main/src/devcontainers-cli",
6+
"description": "The devcontainers CLI, which configures devcontainers from devcontainer.json. Requires the Docker client and access to a Docker engine socket (e.g. by mounting the host's Docker socket into the container)",
7+
"options": {
8+
"version": {
9+
"default": "latest",
10+
"description": "Specify the version to install",
11+
"proposals": [
12+
"latest"
13+
],
14+
"type": "string"
15+
}
16+
},
17+
"installsAfter": [
18+
"ghcr.io/devcontainers-contrib/features/npm-package",
19+
"ghcr.io/devcontainers/features/docker-outside-of-docker"
20+
]
21+
}

src/devcontainers-cli/install.sh

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/bin/bash -i
2+
3+
set -e
4+
5+
source ./library_scripts.sh
6+
7+
# nanolayer is a cli utility which keeps container layers as small as possible
8+
# source code: https://github.com/devcontainers-contrib/nanolayer
9+
# `ensure_nanolayer` is a bash function that will find any existing nanolayer installations,
10+
# and if missing - will download a temporary copy that automatically get deleted at the end
11+
# of the script
12+
ensure_nanolayer nanolayer_location "v0.4.39"
13+
14+
$nanolayer_location \
15+
install \
16+
devcontainer-feature \
17+
"ghcr.io/devcontainers-contrib/features/npm-package:1.0.3" \
18+
--option package='@devcontainers/cli' --option version="$VERSION"
19+
20+
21+
22+
echo 'Done!'
23+
Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
#!/bin/bash -i
2+
3+
4+
clean_download() {
5+
# The purpose of this function is to download a file with minimal impact on container layer size
6+
# this means if no valid downloader is found (curl or wget) then we install a downloader (currently wget) in a
7+
# temporary manner, and making sure to
8+
# 1. uninstall the downloader at the return of the function
9+
# 2. revert back any changes to the package installer database/cache (for example apt-get lists)
10+
# The above steps will minimize the leftovers being created while installing the downloader
11+
# Supported distros:
12+
# debian/ubuntu/alpine
13+
14+
url=$1
15+
output_location=$2
16+
tempdir=$(mktemp -d)
17+
downloader_installed=""
18+
19+
function _apt_get_install() {
20+
tempdir=$1
21+
22+
# copy current state of apt list - in order to revert back later (minimize contianer layer size)
23+
cp -p -R /var/lib/apt/lists $tempdir
24+
apt-get update -y
25+
apt-get -y install --no-install-recommends wget ca-certificates
26+
}
27+
28+
function _apt_get_cleanup() {
29+
tempdir=$1
30+
31+
echo "removing wget"
32+
apt-get -y purge wget --auto-remove
33+
34+
echo "revert back apt lists"
35+
rm -rf /var/lib/apt/lists/*
36+
rm -r /var/lib/apt/lists && mv $tempdir/lists /var/lib/apt/lists
37+
}
38+
39+
function _apk_install() {
40+
tempdir=$1
41+
# copy current state of apk cache - in order to revert back later (minimize contianer layer size)
42+
cp -p -R /var/cache/apk $tempdir
43+
44+
apk add --no-cache wget
45+
}
46+
47+
function _apk_cleanup() {
48+
tempdir=$1
49+
50+
echo "removing wget"
51+
apk del wget
52+
}
53+
# try to use either wget or curl if one of them already installer
54+
if type curl >/dev/null 2>&1; then
55+
downloader=curl
56+
elif type wget >/dev/null 2>&1; then
57+
downloader=wget
58+
else
59+
downloader=""
60+
fi
61+
62+
# in case none of them is installed, install wget temporarly
63+
if [ -z $downloader ] ; then
64+
if [ -x "/usr/bin/apt-get" ] ; then
65+
_apt_get_install $tempdir
66+
elif [ -x "/sbin/apk" ] ; then
67+
_apk_install $tempdir
68+
else
69+
echo "distro not supported"
70+
exit 1
71+
fi
72+
downloader="wget"
73+
downloader_installed="true"
74+
fi
75+
76+
if [ $downloader = "wget" ] ; then
77+
wget -q $url -O $output_location
78+
else
79+
curl -sfL $url -o $output_location
80+
fi
81+
82+
# NOTE: the cleanup procedure was not implemented using `trap X RETURN` only because
83+
# alpine lack bash, and RETURN is not a valid signal under sh shell
84+
if ! [ -z $downloader_installed ] ; then
85+
if [ -x "/usr/bin/apt-get" ] ; then
86+
_apt_get_cleanup $tempdir
87+
elif [ -x "/sbin/apk" ] ; then
88+
_apk_cleanup $tempdir
89+
else
90+
echo "distro not supported"
91+
exit 1
92+
fi
93+
fi
94+
95+
}
96+
97+
98+
ensure_nanolayer() {
99+
# Ensure existance of the nanolayer cli program
100+
local variable_name=$1
101+
102+
local required_version=$2
103+
# normalize version
104+
if ! [[ $required_version == v* ]]; then
105+
required_version=v$required_version
106+
fi
107+
108+
local nanolayer_location=""
109+
110+
# If possible - try to use an already installed nanolayer
111+
if [[ -z "${NANOLAYER_FORCE_CLI_INSTALLATION}" ]]; then
112+
if [[ -z "${NANOLAYER_CLI_LOCATION}" ]]; then
113+
if type nanolayer >/dev/null 2>&1; then
114+
echo "Found a pre-existing nanolayer in PATH"
115+
nanolayer_location=nanolayer
116+
fi
117+
elif [ -f "${NANOLAYER_CLI_LOCATION}" ] && [ -x "${NANOLAYER_CLI_LOCATION}" ] ; then
118+
nanolayer_location=${NANOLAYER_CLI_LOCATION}
119+
echo "Found a pre-existing nanolayer which were given in env variable: $nanolayer_location"
120+
fi
121+
122+
# make sure its of the required version
123+
if ! [[ -z "${nanolayer_location}" ]]; then
124+
local current_version
125+
current_version=$($nanolayer_location --version)
126+
if ! [[ $current_version == v* ]]; then
127+
current_version=v$current_version
128+
fi
129+
130+
if ! [ $current_version == $required_version ]; then
131+
echo "skipping usage of pre-existing nanolayer. (required version $required_version does not match existing version $current_version)"
132+
nanolayer_location=""
133+
fi
134+
fi
135+
136+
fi
137+
138+
# If not previuse installation found, download it temporarly and delete at the end of the script
139+
if [[ -z "${nanolayer_location}" ]]; then
140+
141+
if [ "$(uname -sm)" == "Linux x86_64" ] || [ "$(uname -sm)" == "Linux aarch64" ]; then
142+
tmp_dir=$(mktemp -d -t nanolayer-XXXXXXXXXX)
143+
144+
clean_up () {
145+
ARG=$?
146+
rm -rf $tmp_dir
147+
exit $ARG
148+
}
149+
trap clean_up EXIT
150+
151+
152+
if [ -x "/sbin/apk" ] ; then
153+
clib_type=musl
154+
else
155+
clib_type=gnu
156+
fi
157+
158+
tar_filename=nanolayer-"$(uname -m)"-unknown-linux-$clib_type.tgz
159+
160+
# clean download will minimize leftover in case a downloaderlike wget or curl need to be installed
161+
clean_download https://github.com/devcontainers-contrib/cli/releases/download/$required_version/$tar_filename $tmp_dir/$tar_filename
162+
163+
tar xfzv $tmp_dir/$tar_filename -C "$tmp_dir"
164+
chmod a+x $tmp_dir/nanolayer
165+
nanolayer_location=$tmp_dir/nanolayer
166+
167+
168+
else
169+
echo "No binaries compiled for non-x86-linux architectures yet: $(uname -m)"
170+
exit 1
171+
fi
172+
fi
173+
174+
# Expose outside the resolved location
175+
declare -g ${variable_name}=$nanolayer_location
176+
177+
}
178+
179+

test/devcontainers-cli/scenarios.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"test": {
3+
"image": "mcr.microsoft.com/devcontainers/base:debian",
4+
"features": {
5+
"devcontainers-cli": {}
6+
}
7+
}
8+
}

test/devcontainers-cli/test.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/bin/bash -i
2+
3+
set -e
4+
5+
source dev-container-features-test-lib
6+
7+
check "devcontainer --version" devcontainer --version
8+
9+
reportResults

0 commit comments

Comments
 (0)