Merge branch 'main' into samruddhikhandale/common-utils-zsh-bug

.github/workflows/docker-in-docker-stress-test.yaml

@@ -0,0 +1,37 @@
+name: "Stress test - Docker in Docker"
+on:
+  pull_request:
+    paths:
+      - 'src/docker-in-docker/**'
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        test-pass: [ 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50 ]
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Install latest devcontainer CLI"
+        run: npm install -g @devcontainers/cli
+
+      - name: "Generating tests for 'docker-in-docker' which validates if docker daemon is running"
+        run: devcontainer features test --skip-scenarios -f docker-in-docker -i mcr.microsoft.com/devcontainers/base:ubuntu .
+
+  test-onCreate:
+    strategy:
+      matrix:
+        test-pass: [ 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50 ]
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Install latest devcontainer CLI"
+        run: npm install -g @devcontainers/cli
+
+      - name: "Generating tests for 'docker-in-docker' which validates if docker daemon is available within 'onCreateCommand'"
+        run: devcontainer features test -f docker-in-docker --skip-autogenerated --filter "docker_with_on_create_command"

src/azure-cli/README.md

@@ -18,7 +18,7 @@ Installs the Azure CLI along with needed dependencies. Useful for base Dockerfil
 | version | Select or enter an Azure CLI version. (Available versions may vary by Linux distribution.) | string | latest |
 | extensions | Optional comma separated list of Azure CLI extensions to install in profile. | string | - |
 | installBicep | Optionally install Azure Bicep | boolean | false |
-| installUsingPython | Install Azure CLI using Python instead of pipx | boolean | true |
+| installUsingPython | Install Azure CLI using Python instead of pipx | boolean | false |
 
 ## Customizations
 

src/azure-cli/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
   "id": "azure-cli",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "name": "Azure CLI",
   "documentationURL": "https://github.com/devcontainers/features/tree/main/src/azure-cli",
   "description": "Installs the Azure CLI along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like gpg.",
@@ -26,7 +26,7 @@
     "installUsingPython": {
       "type": "boolean",
       "description": "Install Azure CLI using Python instead of pipx",
-      "default": true
+      "default": false
     }
   },
   "customizations": {

src/azure-cli/install.sh

@@ -141,7 +141,6 @@ install_using_pip_strategy() {
         ver="==${AZ_VERSION}"
     fi
 
-    # Temprary quick fix for https://github.com/devcontainers/features/issues/624
     if [ "${INSTALL_USING_PYTHON}" = "true" ]; then
         install_with_complete_python_installation "${ver}" || install_with_pipx "${ver}" || return 1
     else

src/docker-in-docker/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
     "id": "docker-in-docker",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "name": "Docker (Docker-in-Docker)",
     "documentationURL": "https://github.com/devcontainers/features/tree/main/src/docker-in-docker",
     "description": "Create child containers *inside* a container, independent from the host's docker instance. Installs Docker extension in the container along with needed CLIs.",

src/docker-in-docker/install.sh

@@ -367,7 +367,7 @@ dockerd_start="AZURE_DNS_AUTO_DETECTION=${AZURE_DNS_AUTO_DETECTION} DOCKER_DEFAU
     find /run /var/run -iname 'docker*.pid' -delete || :
     find /run /var/run -iname 'container*.pid' -delete || :
 
-    ## Dind wrapper script from docker team, adapted to a function
+    # -- Start: dind wrapper script --
     # Maintained: https://github.com/moby/moby/blob/master/hack/dind
 
     export container=docker
@@ -384,31 +384,52 @@ dockerd_start="AZURE_DNS_AUTO_DETECTION=${AZURE_DNS_AUTO_DETECTION} DOCKER_DEFAU
         mount -t tmpfs none /tmp
     fi
 
-    # cgroup v2: enable nesting
-    if [ -f /sys/fs/cgroup/cgroup.controllers ]; then
-        # move the processes from the root group to the /init group,
-        # otherwise writing subtree_control fails with EBUSY.
-        # An error during moving non-existent process (i.e., "cat") is ignored.
-        mkdir -p /sys/fs/cgroup/init
-        xargs -rn1 < /sys/fs/cgroup/cgroup.procs > /sys/fs/cgroup/init/cgroup.procs || :
-        # enable controllers
-        sed -e 's/ / +/g' -e 's/^/+/' < /sys/fs/cgroup/cgroup.controllers \
-            > /sys/fs/cgroup/cgroup.subtree_control
-    fi
-    ## Dind wrapper over.
+    set_cgroup_nesting()
+    {
+        # cgroup v2: enable nesting
+        if [ -f /sys/fs/cgroup/cgroup.controllers ]; then
+            # move the processes from the root group to the /init group,
+            # otherwise writing subtree_control fails with EBUSY.
+            # An error during moving non-existent process (i.e., "cat") is ignored.
+            mkdir -p /sys/fs/cgroup/init
+            xargs -rn1 < /sys/fs/cgroup/cgroup.procs > /sys/fs/cgroup/init/cgroup.procs || :
+            # enable controllers
+            sed -e 's/ / +/g' -e 's/^/+/' < /sys/fs/cgroup/cgroup.controllers \
+                > /sys/fs/cgroup/cgroup.subtree_control
+        fi
+    }
+
+    # Set cgroup nesting, retrying if necessary
+    retry_cgroup_nesting=0
+
+    until [ "${retry_cgroup_nesting}" -eq "5" ];
+    do
+        set +e
+            set_cgroup_nesting
+
+            if [ $? -ne 0 ]; then
+                echo "(*) cgroup v2: Failed to enable nesting, retrying..."
+            else
+                break
+            fi
+
+            retry_cgroup_nesting=`expr $retry_cgroup_nesting + 1`
+        set -e
+    done 
+
+    # -- End: dind wrapper script --
 
     # Handle DNS
     set +e
-    cat /etc/resolv.conf | grep -i 'internal.cloudapp.net'
-    if [ $? -eq 0 ] && [ "${AZURE_DNS_AUTO_DETECTION}" = "true" ]
-    then
-        echo "Setting dockerd Azure DNS."
-        CUSTOMDNS="--dns 168.63.129.16"
-    else
-        echo "Not setting dockerd DNS manually."
-        CUSTOMDNS=""
-    fi
-
+        cat /etc/resolv.conf | grep -i 'internal.cloudapp.net' > /dev/null 2>&1
+        if [ $? -eq 0 ] && [ "${AZURE_DNS_AUTO_DETECTION}" = "true" ]
+        then
+            echo "Setting dockerd Azure DNS."
+            CUSTOMDNS="--dns 168.63.129.16"
+        else
+            echo "Not setting dockerd DNS manually."
+            CUSTOMDNS=""
+        fi
     set -e
 
     if [ -z "$DOCKER_DEFAULT_ADDRESS_POOL" ]
@@ -423,10 +444,10 @@ dockerd_start="AZURE_DNS_AUTO_DETECTION=${AZURE_DNS_AUTO_DETECTION} DOCKER_DEFAU
 INNEREOF
 )"
 
-retry_count=0
+retry_docker_start_count=0
 docker_ok="false"
 
-until [ "${docker_ok}" = "true"  ] || [ "${retry_count}" -eq "5" ];
+until [ "${docker_ok}" = "true"  ] || [ "${retry_docker_start_count}" -eq "5" ];
 do 
     # Start using sudo if not invoked as root
     if [ "$(id -u)" -ne 0 ]; then
@@ -435,19 +456,24 @@ do
         eval "${dockerd_start}"
     fi
 
-    set +e
-        docker info > /dev/null 2>&1 && docker_ok="true"
+    retry_count=0
+    until [ "${docker_ok}" = "true"  ] || [ "${retry_count}" -eq "5" ];
+    do
+        sleep 1s
+        set +e
+            docker info > /dev/null 2>&1 && docker_ok="true"
+        set -e
 
-        if [ "${docker_ok}" != "true" ]; then
-            echo "(*) Failed to start docker, retrying in 5s..."
-            retry_count=`expr $retry_count + 1`
-            sleep 5s
-        fi
-    set -e
+        retry_count=`expr $retry_count + 1`
+    done
+    
+    if [ "${docker_ok}" != "true" ]; then
+        echo "(*) Failed to start docker, retrying..."
+    fi
+    
+    retry_docker_start_count=`expr $retry_docker_start_count + 1`
 done
 
-set +e
-
 # Execute whatever commands were passed in (if any). This allows us
 # to set this script to ENTRYPOINT while still executing the default CMD.
 exec "$@"

src/ruby/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
     "id": "ruby",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "name": "Ruby (via rvm)",
     "documentationURL": "https://github.com/devcontainers/features/tree/main/src/ruby",
     "description": "Installs Ruby, rvm, rbenv, common Ruby utilities, and needed dependencies.",

src/ruby/install.sh

@@ -177,9 +177,11 @@ fi
 find_version_from_git_tags RUBY_VERSION "https://github.com/ruby/ruby" "tags/v" "_"
 
 # Just install Ruby if RVM already installed
-if [ $(rvm --version) != "" ]; then
+if rvm --version > /dev/null; then
     echo "Ruby Version Manager already exists."
-    if [ "${RUBY_VERSION}" != "none" ]; then
+    if [[ "$(ruby -v)" = *"${RUBY_VERSION}"* ]]; then
+        echo "(!) Ruby is already installed with version ${RUBY_VERSION}. Skipping..."
+    elif [ "${RUBY_VERSION}" != "none" ]; then
         echo "Installing specified Ruby version."
         su ${USERNAME} -c "rvm install ruby ${RUBY_VERSION}"
     fi
@@ -191,6 +193,9 @@ else
     # Determine appropriate settings for rvm installer
     if [ "${RUBY_VERSION}" = "none" ]; then
         RVM_INSTALL_ARGS=""
+    elif [[ "$(ruby -v)" = *"${RUBY_VERSION}"* ]]; then
+        echo "(!) Ruby is already installed with version ${RUBY_VERSION}. Skipping..."
+        RVM_INSTALL_ARGS=""
     else
         if [ "${RUBY_VERSION}" = "latest" ] || [ "${RUBY_VERSION}" = "current" ] || [ "${RUBY_VERSION}" = "lts" ]; then
             RVM_INSTALL_ARGS="--ruby"
@@ -273,8 +278,11 @@ if [ "${SKIP_RBENV_RBUILD}" != "true" ]; then
             ln -s /usr/local/share/ruby-build /home/${USERNAME}/.rbenv/plugins/ruby-build
         fi
 
-        ln -s /usr/local/rvm/rubies/default/bin/ruby /usr/local/rvm/gems/default/bin 
-
+        # Oryx expects ruby to be installed in this specific path, else it breaks the oryx magic for ruby projects.
+        if [ ! -f /usr/local/rvm/gems/default/bin/ruby ]; then
+            ln -s /usr/local/rvm/rubies/default/bin/ruby /usr/local/rvm/gems/default/bin
+        fi
+
         chown -R "${USERNAME}:rvm" "/home/${USERNAME}/.rbenv/"
         chmod -R g+r+w "/home/${USERNAME}/.rbenv"
         find "/home/${USERNAME}/.rbenv" -type d | xargs -n 1 chmod g+s

src/rust/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
     "id": "rust",
-    "version": "1.0.12",
+    "version": "1.1.0",
     "name": "Rust",
     "documentationURL": "https://github.com/devcontainers/features/tree/main/src/rust",
     "description": "Installs Rust, common Rust utilities, and their required dependencies",
@@ -39,7 +39,6 @@
         "vscode": {
             "extensions": [
                 "vadimcn.vscode-lldb",
-                "mutantdino.resourcemonitor",
                 "rust-lang.rust-analyzer",
                 "tamasfe.even-better-toml",
                 "serayuzgur.crates"

src/terraform/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
     "id": "terraform",
-    "version": "1.3.3",
+    "version": "1.3.4",
     "name": "Terraform, tflint, and TFGrunt",
     "documentationURL": "https://github.com/devcontainers/features/tree/main/src/terraform",
     "description": "Installs the Terraform CLI and optionally TFLint and Terragrunt. Auto-detects latest version and installs needed dependencies.",

src/terraform/install.sh

@@ -165,7 +165,8 @@ ensure_cosign() {
 
     if ! type cosign > /dev/null 2>&1; then
         echo "Installing cosign..."
-        local LATEST_COSIGN_VERSION=$(curl https://api.github.com/repos/sigstore/cosign/releases/latest | grep tag_name | cut -d : -f2 | tr -d "v\", ")
+        LATEST_COSIGN_VERSION="latest"
+        find_version_from_git_tags LATEST_COSIGN_VERSION 'https://github.com/sigstore/cosign'
         curl -L "https://github.com/sigstore/cosign/releases/latest/download/cosign_${LATEST_COSIGN_VERSION}_${architecture}.deb" -o /tmp/cosign_${LATEST_COSIGN_VERSION}_${architecture}.deb
 
         dpkg -i /tmp/cosign_${LATEST_COSIGN_VERSION}_${architecture}.deb

test/azure-cli/install_with_python.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -e
+
+# Import test library for `check` command
+source dev-container-features-test-lib
+
+# Check to make sure the user is vscode
+check "user is vscode" whoami | grep vscode
+check "version" az  --version
+
+
+# Report result
+reportResults

test/azure-cli/scenarios.json

@@ -28,5 +28,15 @@
         "installBicep": true
       }
     }
+  },
+  "install_with_python": {
+    "image": "mcr.microsoft.com/devcontainers/base:jammy",
+    "user": "vscode",
+    "features": {
+      "azure-cli": {
+        "version": "latest",
+        "installUsingPython": true
+      }
+    }
   }
 }

test/docker-in-docker/docker_with_on_create_command.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Feature specific tests
+check "version" docker  --version
+check "docker-ps" bash -c "docker ps"
+
+check "docker-init-exists" bash -c "ls /usr/local/share/docker-init.sh"
+check "log-exists" bash -c "ls /tmp/dockerd.log"
+check "log-for-completion" bash -c "cat /tmp/dockerd.log | grep 'Daemon has completed initialization'"
+check "log-contents" bash -c "cat /tmp/dockerd.log | grep 'API listen on /var/run/docker.sock'"
+
+# Report result
+reportResults

test/docker-in-docker/scenarios.json

@@ -68,10 +68,13 @@
         },
         "remoteUser": "node"
     },
-    "docker_retry": {
-        "image": "ubuntu:focal",
+    // DO NOT REMOVE: This scenario is used by the docker-in-docker-stress-test workflow
+    "docker_with_on_create_command": {
+        "image": "mcr.microsoft.com/devcontainers/base:debian",
         "features": {
             "docker-in-docker": {}
-        }
+        },
+        "remoteUser": "vscode",
+        "onCreateCommand": "docker ps && sleep 5s && docker ps"
     }
 }