Add info on injected environment variables (#16)

* info on new env variable

* checkpoint for expanding with remoteUser

* Update install.sh

* Update my_favorite_color_is_green.sh

* execute in correct shell

* best test string

Author: joshspicer

src/color/devcontainer-feature.json

@@ -14,5 +14,8 @@
             "default": "red",
             "description": "Choose your favorite color."
         }
-    }
+    },
+    "installsAfter": [
+        "ghcr.io/devcontainers/features/common-utils"
+    ]
 }

src/color/install.sh

@@ -4,10 +4,23 @@ set -e
 echo "Activating feature 'color'"
 echo "The provided favorite color is: ${FAVORITE}"
 
+
+# The 'install.sh' entrypoint script is always executed as the root user.
+#
+# These following environment variables are passed in by the dev container CLI.
+# These may be useful in instances where the context of the final 
+# remoteUser or containerUser is useful.
+# For more details, see https://containers.dev/implementors/features#user-env-var
+echo "The effective dev container remoteUser is '$_REMOTE_USER'"
+echo "The effective dev container remoteUser's home directory is '$_REMOTE_USER_HOME'"
+
+echo "The effective dev container containerUser is '$_CONTAINER_USER'"
+echo "The effective dev container containerUser's home directory is '$_CONTAINER_USER_HOME'"
+
 cat > /usr/local/bin/color \
 << EOF
 #!/bin/sh
 echo "my favorite color is ${FAVORITE}"
 EOF
 
-chmod +x /usr/local/bin/color
+chmod +x /usr/local/bin/color

src/hello/devcontainer-feature.json

@@ -15,5 +15,8 @@
             "default": "hey",
             "description": "Select a pre-made greeting, or enter your own"
         }
-    }
+    },
+    "installsAfter": [
+        "ghcr.io/devcontainers/features/common-utils"
+    ]
 }

src/hello/install.sh

@@ -6,6 +6,18 @@ echo "Activating feature 'hello'"
 GREETING=${GREETING:-undefined}
 echo "The provided greeting is: $GREETING"
 
+# The 'install.sh' entrypoint script is always executed as the root user.
+#
+# These following environment variables are passed in by the dev container CLI.
+# These may be useful in instances where the context of the final 
+# remoteUser or containerUser is useful.
+# For more details, see https://containers.dev/implementors/features#user-env-var
+echo "The effective dev container remoteUser is '$_REMOTE_USER'"
+echo "The effective dev container remoteUser's home directory is '$_REMOTE_USER_HOME'"
+
+echo "The effective dev container containerUser is '$_CONTAINER_USER'"
+echo "The effective dev container containerUser's home directory is '$_CONTAINER_USER_HOME'"
+
 cat > /usr/local/bin/hello \
 << EOF
 #!/bin/sh

test/color/gold.sh

@@ -10,7 +10,7 @@ source dev-container-features-test-lib
 
 # Feature-specific tests
 # The 'check' command comes from the dev-container-features-test-lib.
-check "version" bash -c "color | grep 'my favorite color is gold'"
+check "execute command" bash -c "color | grep 'my favorite color is gold'"
 
 # Report result
 # If any of the checks above exited with a non-zero exit code, the test will fail.

test/color/green.sh

@@ -10,7 +10,7 @@ source dev-container-features-test-lib
 
 # Feature-specific tests
 # The 'check' command comes from the dev-container-features-test-lib.
-check "version" bash -c "color | grep 'my favorite color is green'"
+check "execute command" bash -c "color | grep 'my favorite color is green'"
 
 # Report result
 # If any of the checks above exited with a non-zero exit code, the test will fail.

test/color/my_favorite_color_is_green.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# This test file will be executed against after building a container with the
+# 'my_favorite_color_is_green' scenario in 'test/test/color/scenarios.json'.
+#
+# For more information, see: https://github.com/devcontainers/cli/blob/main/docs/features/test.md
+#
+# This scenario first uses the 'common-utils' Features to add a new user 'octocat'. 
+# It then installs the 'color' Feature with the FAVORITE option set to 'green' (the default FAVORITE value if none provided is 'red').
+#
+# 
+# This test (as well as any of the other scenarios in 'scenarios.json') can be run with the following command:
+#
+#    devcontainer features test \ 
+#               --features color \
+#               --skip-autogenerated \
+#               /path/to/this/repo
+
+set -e
+
+# Optional: Import test library bundled with the devcontainer CLI
+# Provides the 'check' and 'reportResults' commands.
+source dev-container-features-test-lib
+
+# Feature-specific tests
+# The 'check' command comes from the dev-container-features-test-lib.
+check "validate favorite color" color | grep 'my favorite color is green'
+
+# Report result
+# If any of the checks above exited with a non-zero exit code, the test will fail.
+reportResults

test/color/scenarios.json

@@ -1,4 +1,19 @@
 {
+    "my_favorite_color_is_green": {
+        "image": "mcr.microsoft.com/devcontainers/base:focal",
+        "features": {
+            "ghcr.io/devcontainers/features/common-utils:1": {
+                "installZsh": false,
+                "installOhMyZsh": false,
+                "upgradePackages": false,
+                "username": "octocat"
+            },
+            "color": {
+                "favorite": "green"
+            }
+        },
+        "remoteUser": "octocat"
+    },
     "gold": {
         "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
         "features": {

test/color/test.sh

@@ -1,33 +1,45 @@
 #!/bin/bash
 
 # This test file will be executed against an auto-generated devcontainer.json that
-# includes the 'color' feature with no options.
+# includes the 'color' Feature with no options.
+#
+# For more information, see: https://github.com/devcontainers/cli/blob/main/docs/features/test.md
 #
 # Eg:
 # {
 #    "image": "<..some-base-image...>",
 #    "features": {
 #      "color": {}
-#    }
+#    },
+#    "remoteUser": "root"
 # }
 #
-# Thus, the value of all options, 
-# will fall back to the default value in the feature's 'devcontainer-feature.json'
+# Thus, the value of all options will fall back to the default value in the
+# Feature's 'devcontainer-feature.json'.
 # For the 'color' feature, that means the default favorite color is 'red'.
+#
+# These scripts are run as 'root' by default. Although that can be changed
+# with the '--remote-user' flag.
 # 
-# This test can be run with the following command (from the root of this repo)
-#    devcontainer features test \ 
-#               --features color \
-#               --base-image mcr.microsoft.com/devcontainers/base:ubuntu .
+# This test can be run with the following command:
+#
+#    devcontainer features test    \ 
+#               --features color   \
+#               --remote-user root \
+#               --skip-scenarios   \
+#               --base-image mcr.microsoft.com/devcontainers/base:ubuntu \
+#               /path/to/this/repo
 
 set -e
 
 # Optional: Import test library bundled with the devcontainer CLI
+# Provides the 'check' and 'reportResults' commands.
 source dev-container-features-test-lib
 
 # Feature-specific tests
 # The 'check' command comes from the dev-container-features-test-lib.
-check "version" bash -c "color | grep 'my favorite color is red'"
+
+check "validate favorite color" color | grep 'my favorite color is red'
 
 # Report result
 # If any of the checks above exited with a non-zero exit code, the test will fail.

test/hello/hello.sh

@@ -10,7 +10,7 @@ source dev-container-features-test-lib
 
 # Feature-specific tests
 # The 'check' command comes from the dev-container-features-test-lib.
-check "version" bash -c "hello | grep 'hello, $(whoami)!'"
+check "execute command" bash -c "hello | grep 'hello, $(whoami)!'"
 
 # Report results
 # If any of the checks above exited with a non-zero exit code, the test will fail.