[common-utils] fix bug when user home is custom by base docker

Author: prulloac

src/common-utils/main.sh

@@ -408,10 +408,15 @@ fi
 if [ "${USERNAME}" = "root" ]; then
     user_home="/root"
 else
-    user_home="/home/${USERNAME}"
-    if [ ! -d "${user_home}" ]; then
-        mkdir -p "${user_home}"
-        chown ${USERNAME}:${group_name} "${user_home}"
+    # Check if user already has a home directory other than /home/${USERNAME}
+    if [ "/home/${USERNAME}" != $( getent passwd $USERNAME | cut -d: -f6 ) ]; then
+        user_home=$( getent passwd $USERNAME | cut -d: -f6 )
+    else
+        user_home="/home/${USERNAME}"
+        if [ ! -d "${user_home}" ]; then
+            mkdir -p "${user_home}"
+            chown ${USERNAME}:${group_name} "${user_home}"
+        fi
     fi
 fi
 

test/common-utils/devcontainer-custom-home.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+check "user is customUser" grep customUser <(whoami)
+check "home is /customHome" grep "/customHome" <(getent passwd customUser | cut -d: -f6) 
+
+# Report result
+reportResults

test/common-utils/devcontainer-custom-home/Dockerfile

@@ -0,0 +1,4 @@
+FROM ubuntu:focal
+
+RUN groupadd customUser -g 30000 && \
+    useradd customUser -u 30000 -g 30000 --create-home --home-dir /customHome

test/common-utils/scenarios.json

@@ -183,5 +183,14 @@
                 "configureZshAsDefaultShell": true
             }
         }
+    },
+    "devcontainer-custom-home": {
+        "build": {
+            "dockerfile": "Dockerfile"
+        },
+        "remoteUser": "customUser",
+        "features": {
+            "common-utils": {}
+        }
     }
 }