Multi-distro support for common script, refactor, fixes (#326)

README.md

@@ -9,7 +9,7 @@
 </tr></table>
 
 'Features' are self-contained units of installation code and development container configuration. Features are designed
-to install atop a wide-range of base container images (**this repo focuses on `debian` based images**).
+to install atop a wide-range of base container images.
 
 Missing a CLI or language in your otherwise _perfect_ container image? Add the relevant Feature to the `features`
 property of a [`devcontainer.json`](https://containers.dev/implementors/json_reference/#general-properties). A

src/common-utils/NOTES.md

-## Speeding up the command prompt in large repositories
+## OS Support
 
-This script provides a custom command prompt that includes information about the git repository for the current folder. However, with certain large repositories, this can result in a slow command prompt since the required git status command can be slow. To resolve this, you can update a git setting to remove the git portion of the command prompt.
+This Feature should work on recent versions of Debian/Ubuntu, RedHat Enterprise Linux, Fedora, RockyLinux, and Alpine Linux.
 
-To disable the prompt for the current folder's repository, enter the following in a terminal or add it to your `postCreateCommand` or dotfiles:
+## Customizing the command prompt
+
+By default, this script provides a custom command prompt that includes information about the git repository for the current folder. However, with certain large repositories, this can result in a slow command prompt due to the performance of needed git operations.
+
+For performance reasons, a "dirty" indicator that tells you whether or not there are uncommitted changes is disabled by default. You can opt to turn this on for smaller repositories by entering the following in a terminal or adding it to your `postCreateCommand`:
 
 ```bash
-git config codespaces-theme.hide-status 1
+git config devcontainers-theme.show-dirty 1
 ```
 
-This setting will survive a rebuild since it is applied to the repository rather than the container.
+To completely disable the git portion of the prompt for the current folder's repository, you can use this configuration setting instead:
+
+```bash
+git config devcontainers-theme.hide-status 1
+```
 
+For `zsh`, the default theme is a [standard Oh My Zsh! theme](https://ohmyz.sh/). You may pick a different one by modifying the `ZSH_THEME` variable in `~/.zshrc`.
\ No newline at end of file

src/common-utils/bin/code

+#!/bin/sh
+
+get_in_path_except_current() {
+    which -a "$1" | grep -A1 "$0" | grep -v "$0"
+}
+
+code="$(get_in_path_except_current code)"
+
+if [ -n "$code" ]; then
+    exec "$code" "$@"
+elif [ "$(command -v code-insiders)" ]; then
+    exec code-insiders "$@"
+else
+    echo "code or code-insiders is not installed" >&2
+    exit 127
+fi

src/common-utils/bin/devcontainer-info

+#!/bin/sh
+. /usr/local/etc/vscode-dev-containers/meta.env
+
+# Minimal output
+if [ "$1" = "version" ] || [ "$1" = "image-version" ]; then
+    echo "${VERSION}"
+    exit 0
+elif [ "$1" = "release" ]; then
+    echo "${GIT_REPOSITORY_RELEASE}"
+    exit 0
+elif [ "$1" = "content" ] || [ "$1" = "content-url" ] || [ "$1" = "contents" ] || [ "$1" = "contents-url" ]; then
+    echo "${CONTENTS_URL}"
+    exit 0
+fi
+
+#Full output
+echo
+echo "Development container image information"
+echo
+if [ ! -z "${VERSION}" ]; then echo "- Image version: ${VERSION}"; fi
+if [ ! -z "${DEFINITION_ID}" ]; then echo "- Definition ID: ${DEFINITION_ID}"; fi
+if [ ! -z "${VARIANT}" ]; then echo "- Variant: ${VARIANT}"; fi
+if [ ! -z "${GIT_REPOSITORY}" ]; then echo "- Source code repository: ${GIT_REPOSITORY}"; fi
+if [ ! -z "${GIT_REPOSITORY_RELEASE}" ]; then echo "- Source code release/branch: ${GIT_REPOSITORY_RELEASE}"; fi
+if [ ! -z "${BUILD_TIMESTAMP}" ]; then echo "- Timestamp: ${BUILD_TIMESTAMP}"; fi
+if [ ! -z "${CONTENTS_URL}" ]; then echo && echo "More info: ${CONTENTS_URL}"; fi
+echo

src/common-utils/bin/systemctl

+#!/bin/sh
+set -e
+if [ -d "/run/systemd/system" ]; then
+    exec /bin/systemctl "$@"
+else
+    echo '\n"systemd" is not running in this container due to its overhead.\nUse the "service" command to start services instead. e.g.: \n\nservice --status-all'
+fi

src/common-utils/devcontainer-feature.json

 {
     "id": "common-utils",
-    "version": "1.2.0",
-    "name": "Common Debian Utilities",
+    "version": "2.0.0",
+    "name": "Common Utilities",
     "documentationURL": "https://github.com/devcontainers/features/tree/main/src/common-utils",
     "description": "Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-root user.",
     "options": {
@@ -28,36 +28,37 @@
         "username": {
             "type": "string",
             "proposals": [
+                "devcontainer",
                 "vscode",
                 "codespace",
                 "none",
                 "automatic"
             ],
             "default": "automatic",
-            "description": "Enter name of non-root user to configure or none to skip"
+            "description": "Enter name of a non-root user to configure or none to skip"
         },
-        "uid": {
+        "userUid": {
             "type": "string",
             "proposals": [
                 "1000",
                 "automatic"
             ],
             "default": "automatic",
-            "description": "Enter uid for non-root user"
+            "description": "Enter UID for non-root user"
         },
-        "gid": {
+        "userGid": {
             "type": "string",
             "proposals": [
                 "1000",
                 "automatic"
             ],
             "default": "automatic",
-            "description": "Enter gid for non-root user"
+            "description": "Enter GID for non-root user"
         },
         "nonFreePackages": {
             "type": "boolean",
             "default": false,
-            "description": "Add packages from non-free Debian repository?"
+            "description": "Add packages from non-free Debian repository? (Debian only)"
         }
     }
 }

src/common-utils/scripts/bash_theme_snippet.sh

+
+# bash theme - partly inspired by https://github.com/ohmyzsh/ohmyzsh/blob/master/themes/robbyrussell.zsh-theme
+__bash_prompt() {
+    local userpart='`export XIT=$? \
+        && [ ! -z "${GITHUB_USER}" ] && echo -n "\[\033[0;32m\]@${GITHUB_USER} " || echo -n "\[\033[0;32m\]\u " \
+        && [ "$XIT" -ne "0" ] && echo -n "\[\033[1;31m\]➜" || echo -n "\[\033[0m\]➜"`'
+    local gitbranch='`\
+        if [ "$(git config --get devcontainers-theme.hide-status 2>/dev/null)" != 1 ] && [ "$(git config --get codespaces-theme.hide-status 2>/dev/null)" != 1 ]; then \
+            export BRANCH=$(git --no-optional-locks symbolic-ref --short HEAD 2>/dev/null || git --no-optional-locks rev-parse --short HEAD 2>/dev/null); \
+            if [ "${BRANCH}" != "" ]; then \
+                echo -n "\[\033[0;36m\](\[\033[1;31m\]${BRANCH}" \
+                && if [ "$(git config --get devcontainers-theme.show-dirty 2>/dev/null)" = 1 ] && \
+                    git --no-optional-locks ls-files --error-unmatch -m --directory --no-empty-directory -o --exclude-standard ":/*" > /dev/null 2>&1; then \
+                        echo -n " \[\033[1;33m\]✗"; \
+                fi \
+                && echo -n "\[\033[0;36m\]) "; \
+            fi; \
+        fi`'
+    local lightblue='\[\033[1;34m\]'
+    local removecolor='\[\033[0m\]'
+    PS1="${userpart} ${lightblue}\w ${gitbranch}${removecolor}\$ "
+    unset -f __bash_prompt
+}
+__bash_prompt
+export PROMPT_DIRTRIM=4

src/common-utils/scripts/devcontainers.zsh-theme

+# Oh My Zsh! theme - partly inspired by https://github.com/ohmyzsh/ohmyzsh/blob/master/themes/robbyrussell.zsh-theme
+__zsh_prompt() {
+    local prompt_username
+    if [ ! -z "${GITHUB_USER}" ]; then 
+        prompt_username="@${GITHUB_USER}"
+    else
+        prompt_username="%n"
+    fi
+    PROMPT="%{$fg[green]%}${prompt_username} %(?:%{$reset_color%}➜ :%{$fg_bold[red]%}➜ )" # User/exit code arrow
+    PROMPT+='%{$fg_bold[blue]%}%(5~|%-1~/…/%3~|%4~)%{$reset_color%} ' # cwd
+    PROMPT+='`\
+        if [ "$(git config --get devcontainers-theme.hide-status 2>/dev/null)" != 1 ] && [ "$(git config --get codespaces-theme.hide-status 2>/dev/null)" != 1 ]; then \
+            export BRANCH=$(git --no-optional-locks symbolic-ref --short HEAD 2>/dev/null || git --no-optional-locks rev-parse --short HEAD 2>/dev/null); \
+            if [ "${BRANCH}" != "" ]; then \
+                echo -n "%{$fg_bold[cyan]%}(%{$fg_bold[red]%}${BRANCH}" \
+                && if [ "$(git config --get devcontainers-theme.show-dirty 2>/dev/null)" = 1 ] && \
+                    git --no-optional-locks ls-files --error-unmatch -m --directory --no-empty-directory -o --exclude-standard ":/*" > /dev/null 2>&1; then \
+                        echo -n " %{$fg_bold[yellow]%}✗"; \
+                fi \
+                && echo -n "%{$fg_bold[cyan]%})%{$reset_color%} "; \
+            fi; \
+        fi`'
+    PROMPT+='%{$fg[white]%}$ %{$reset_color%}'
+    unset -f __zsh_prompt
+}
+__zsh_prompt

src/common-utils/scripts/rc_snippet.sh

+
+if [ -z "${USER}" ]; then export USER=$(whoami); fi
+if [[ "${PATH}" != *"$HOME/.local/bin"* ]]; then export PATH="${PATH}:$HOME/.local/bin"; fi
+
+# Display optional first run image specific notice if configured and terminal is interactive
+if [ -t 1 ] && [[ "${TERM_PROGRAM}" = "vscode" || "${TERM_PROGRAM}" = "codespaces" ]] && [ ! -f "$HOME/.config/vscode-dev-containers/first-run-notice-already-displayed" ]; then
+    if [ -f "/usr/local/etc/vscode-dev-containers/first-run-notice.txt" ]; then
+        cat "/usr/local/etc/vscode-dev-containers/first-run-notice.txt"
+    elif [ -f "/workspaces/.codespaces/shared/first-run-notice.txt" ]; then
+        cat "/workspaces/.codespaces/shared/first-run-notice.txt"
+    fi
+    mkdir -p "$HOME/.config/vscode-dev-containers"
+    # Mark first run notice as displayed after 10s to avoid problems with fast terminal refreshes hiding it
+    ((sleep 10s; touch "$HOME/.config/vscode-dev-containers/first-run-notice-already-displayed") &)
+fi
+
+# Set the default git editor if not already set
+if [ -z "$(git config --get core.editor)" ] && [ -z "${GIT_EDITOR}" ]; then
+    if  [ "${TERM_PROGRAM}" = "vscode" ]; then
+        if [[ -n $(command -v code-insiders) &&  -z $(command -v code) ]]; then 
+            export GIT_EDITOR="code-insiders --wait"
+        else 
+            export GIT_EDITOR="code --wait"
+        fi
+    fi
+fi
\ No newline at end of file

test/common-utils/alpine.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${ID}" = "alpine"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/already-run.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+check "non-root user" test "$(whoami)" = "vscode"
+check "jq" jq  --version
+check "curl" curl  --version
+check "git" git  --version
+check "zsh" zsh --version
+check "ps" ps --version
+check "Oh My Zsh! theme" test -e $HOME/.oh-my-zsh/custom/themes
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/alternate-values.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+check "non-root user" id alternate
+check "running as root" test "$(whoami)" = "root"
+check "jq" jq  --version
+check "curl" curl  --version
+check "git" git  --version
+check "ps" ps --version
+check "no zsh" bash -c '! zsh --version'
+check "No Oh My Zsh!" test ! -e /home/alternate/.oh-my-zsh/custom/themes/devcontainers.zsh-theme
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/bionic.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${VERSION_CODENAME}" = "bionic"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/bullseye.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${VERSION_CODENAME}" = "bullseye"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/buster.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${VERSION_CODENAME}" = "buster"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/centos-7.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${VERSION_ID}" = "7"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/fedora.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${ID}" = "fedora"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/focal.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${VERSION_CODENAME}" = "focal"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/jammy.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${VERSION_CODENAME}" = "jammy"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/rocky-8.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${PLATFORM_ID}" = "platform:el8"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/rocky-9.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+check "non-root user" test "$(whoami)" = "devcontainer"
+check "distro" test "${PLATFORM_ID}" = "platform:el9"
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/scenarios.json

 {
-  "configure_zsh_as_default_shell": {
-    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
-    "features": {
-      "common-utils": {
-        "configureZshAsDefaultShell": true
-      }
+    "bionic": {
+        "image": "ubuntu:bionic",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "focal": {
+        "image": "ubuntu:focal",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "jammy": {
+        "image": "ubuntu:jammy",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "buster": {
+        "image": "debian:buster",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "bullseye": {
+        "image": "debian:bullseye",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "centos-7": {
+        "image": "centos:7",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "rocky-8": {
+        "image": "rockylinux:8",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "rocky-9": {
+        "image": "rockylinux:9",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "fedora": {
+        "image": "fedora",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "alpine": {
+        "image": "alpine",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "alternate-values": {
+        "image": "debian:bullseye",
+        "features": {
+            "common-utils": {
+                "username": "alternate",
+                "userUid": "1001",
+                "userGid": "1002",
+                "upgradePackages": false,
+                "installZsh": false,
+                "nonFreePackages": true
+            }
+        }
+    },
+    "username-default": {
+        "image": "debian:bullseye",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "username-detected": {
+        "image": "node",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "already-run": {
+        "image": "mcr.microsoft.com/devcontainers/base:jammy",
+        "features": {
+            "common-utils": {}
+        }
+    },
+    "configure_zsh_as_default_shell": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+        "features": {
+            "common-utils": {
+                "configureZshAsDefaultShell": true
+            }
+        }
     }
-  }
 }

test/common-utils/test.sh

@@ -8,6 +8,11 @@ source dev-container-features-test-lib
 # Definition specific tests
 check "jq" jq  --version
 check "curl" curl  --version
+check "git" git  --version
+check "zsh" zsh --version
+check "ps" ps --version
+check "Oh My Zsh! theme" test -e $HOME/.oh-my-zsh/custom/themes/devcontainers.zsh-theme
+check "zsh theme symlink" test -e $HOME/.oh-my-zsh/custom/themes/codespaces.zsh-theme
 
 # Report result
 reportResults
\ No newline at end of file

test/common-utils/username-default.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+# .oh-my-zsh folder would only exist if user defaulting worked
+check "non-root user" ls /home/vscode/.oh-my-zsh
+
+
+# Report result
+reportResults
\ No newline at end of file

test/common-utils/username-detected.sh

+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+. /etc/os-release
+# .oh-my-zsh folder would only exist if user detection worked
+check "non-root user" ls /home/node/.oh-my-zsh
+
+# Report result
+reportResults
\ No newline at end of file