[common-utils] Fix group creation if it exists

Signed-off-by: Wolfgang Hölzl <[email protected]>
devcontainers · Oct 25, 2024 · 4d92497 · 4d92497
1 parent 2951f04
commit 4d92497
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 5 deletions.
diff --git a/src/common-utils/devcontainer-feature.json b/src/common-utils/devcontainer-feature.json
@@ -1,6 +1,6 @@
 {
     "id": "common-utils",
-    "version": "2.5.2",
+    "version": "2.5.3",
     "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.",

diff --git a/src/common-utils/main.sh b/src/common-utils/main.sh
@@ -406,7 +406,11 @@ elif [ "${USERNAME}" = "none" ]; then
     USER_GID=0
 fi
 # Create or update a non-root user to match UID/GID.
-group_name="${USERNAME}"
+if [ "${USER_GID}" != "automatic" ] && getent group "${USER_GID}" > /dev/null 2>&1; then
+    group_name=$(getent group "${USER_GID}" | cut -d: -f1)
+else
+    group_name="${USERNAME}"
+fi
 if id -u ${USERNAME} > /dev/null 2>&1; then
     # User exists, update if needed
     if [ "${USER_GID}" != "automatic" ] && [ "$USER_GID" != "$(id -g $USERNAME)" ]; then
@@ -421,13 +425,13 @@ else
     # Create user
     if [ "${USER_GID}" = "automatic" ]; then
         groupadd $USERNAME
-    else
+    elif ! getent group "${USER_GID}" > /dev/null 2>&1; then
         groupadd --gid $USER_GID $USERNAME
     fi
     if [ "${USER_UID}" = "automatic" ]; then
-        useradd -s /bin/bash --gid $USERNAME -m $USERNAME
+        useradd -s /bin/bash --gid "${group_name}" -m "${USERNAME}"
     else
-        useradd -s /bin/bash --uid $USER_UID --gid $USERNAME -m $USERNAME
+        useradd -s /bin/bash --uid "${USER_UID}" --gid "${group_name}" -m "${USERNAME}"
     fi
 fi
 

diff --git a/test/common-utils/group-already-exists.sh b/test/common-utils/group-already-exists.sh
@@ -0,0 +1,14 @@
+#!/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 "group name is adm" test "$(id -gn)" = "adm"
+
+# Report result
+reportResults
diff --git a/test/common-utils/scenarios.json b/test/common-utils/scenarios.json
@@ -152,6 +152,16 @@
             "common-utils": {}
         }
     },
+    "group-already-exists": {
+        "image": "alpine",
+        "remoteUser": "devcontainer",
+        "features": {
+            "common-utils": {
+                "userUid": "1000",
+                "userGid": "4"
+            }
+        }
+    },
     "already-run": {
         "image": "mcr.microsoft.com/devcontainers/base:jammy",
         "features": {