common-utils zshrc issue fix (#1111)

* common-utils zshrc issue fix * bump feature patch version * test added to validate the changes of zshrc fix * user vscode added * User env added
devcontainers · Oct 17, 2024 · 88253ef · 88253ef
1 parent d231662
commit 88253ef
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 2 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.1",
+    "version": "2.5.2",
     "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
@@ -551,7 +551,9 @@ if [ "${INSTALL_ZSH}" = "true" ]; then
 
         # Add devcontainer .zshrc template
         if [ "$INSTALL_OH_MY_ZSH_CONFIG" = "true" ]; then
-            echo -e "$(cat "${template_path}")\nDISABLE_AUTO_UPDATE=true\nDISABLE_UPDATE_PROMPT=true" > ${user_rc_file}
+            if ! [ -f "${template_path}" ] || ! grep -qF "$(head -n 1 "${template_path}")" "${user_rc_file}"; then
+                echo -e "$(cat "${template_path}")\nDISABLE_AUTO_UPDATE=true\nDISABLE_UPDATE_PROMPT=true" > ${user_rc_file}
+            fi
             sed -i -e 's/ZSH_THEME=.*/ZSH_THEME="devcontainers"/g' ${user_rc_file}
         fi
 

diff --git a/test/common-utils/devcontainer-ruby-zshrc.sh b/test/common-utils/devcontainer-ruby-zshrc.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+check "configure-zshrc-without-overwrite" bash -c "grep 'rbenv init -' ~/.zshrc"
+
+# Report result
+reportResults
diff --git a/test/common-utils/devcontainer-ruby-zshrc/Dockerfile b/test/common-utils/devcontainer-ruby-zshrc/Dockerfile
@@ -0,0 +1,6 @@
+FROM mcr.microsoft.com/devcontainers/ruby:3.2
+
+USER vscode
+ENV USER=vscode
+RUN echo 'eval "$(rbenv init -)"' >> /home/$USER/.zshrc
+
diff --git a/test/common-utils/scenarios.json b/test/common-utils/scenarios.json
@@ -235,6 +235,24 @@
             }
         }
     },
+    "devcontainer-ruby-zshrc": {
+        "build": {
+            "dockerfile": "Dockerfile"
+        },
+        "remoteUser": "vscode",
+        "features": {
+            "common-utils": {
+                "installZsh": true,
+                "username": "vscode",
+                "userUid": "1000",
+                "userGid": "1000",
+                "upgradePackages": true,
+                "installOhMyZsh": true,
+                "installOhMyZshConfig": true,
+                "configureZshAsDefaultShell": true
+            }
+        }
+    },
     "alpine-base-zsh-default": {
         "image": "mcr.microsoft.com/devcontainers/base:alpine",
         "remoteUser": "vscode",