[common-utils] - append shell history functionality - #1026

src/common-utils/devcontainer-feature.json

@@ -64,6 +64,16 @@
             "type": "boolean",
             "default": false,
             "description": "Add packages from non-free Debian repository? (Debian only)"
+        },
+        "allowShellHistory": {
+            "type": "boolean",
+            "default": false,
+            "description": "Preserve shell history across dev container instances? (Currently supports bash, zsh, and fish)"
         }
-    }
-}
+    },
+    "mounts": [{
+        "source": "devcontainers",
+        "target": "/devcontainers",
+        "type": "volume"
+    }]
+}   

src/common-utils/main.sh

@@ -18,6 +18,7 @@ USERNAME="${USERNAME:-"automatic"}"
 USER_UID="${USERUID:-"automatic"}"
 USER_GID="${USERGID:-"automatic"}"
 ADD_NON_FREE_PACKAGES="${NONFREEPACKAGES:-"false"}"
+ALLOW_SHELL_HISTORY="${ALLOWSHELLHISTORY:-"false"}"
 
 MARKER_FILE="/usr/local/etc/vscode-dev-containers/common"
 
@@ -567,6 +568,53 @@ if [ "${INSTALL_ZSH}" = "true" ]; then
     fi
 fi
 
+# *********************************
+# ** Enable shell history **
+# *********************************
+
+if [ "${ALLOW_SHELL_HISTORY}" = "true" ]; then
+    echo "Activating feature 'shell-history'"
+    echo "User: ${USERNAME}     User home: ${user_home}"
+
+    if ! command -v uuidgen &> /dev/null; then
+        sudo apt-get update
+        sudo apt-get install -y uuid-runtime
+    fi
+    # Create the shell history directory in the mounted volume
+    DEVCONTAINER_ID=$(uuidgen)
+    HISTORY_DIR="/devcontainers/${DEVCONTAINER_ID}/shellHistory"
+    USER_HISTORY_FILE="${user_home}/.bash_history"
+    VOLUME_HISTORY_FILE="${HISTORY_DIR}/.bash_history"
+
+    # Create the history directory in the volume, if it doesn’t already exist
+    sudo mkdir -p "${HISTORY_DIR}"
+    sudo chown -R "${USERNAME}" "${HISTORY_DIR}"
+    sudo chmod -R u+rwx "${HISTORY_DIR}"
+
+    # Ensure the volume's history file exists and set permissions
+    if [[ ! -f "${VOLUME_HISTORY_FILE}" ]]; then
+        # Create an empty history file if it doesn’t already exist
+        sudo touch "${VOLUME_HISTORY_FILE}"
+        sudo chown -R "${USERNAME}" "${VOLUME_HISTORY_FILE}"
+        sudo chmod -R u+rwx "${VOLUME_HISTORY_FILE}"
+    fi
+
+    # Create or update the user’s .bash_history to append to the volume’s history
+    if [[ ! -f "${USER_HISTORY_FILE}" ]]; then
+        sudo touch "${USER_HISTORY_FILE}"
+        sudo chown -R "${USERNAME}" "${USER_HISTORY_FILE}"
+        sudo chmod -R u+rwx "${USER_HISTORY_FILE}"
+    fi
+
+    # Symlink for Bash history
+    sudo ln -sf ${USER_HISTORY_FILE} ${VOLUME_HISTORY_FILE}
+
+    # Configure immediate history saving to the volume
+    echo 'PROMPT_COMMAND="history -a; history -c; history -r"' >> "${user_home}/.bashrc"
+
+    echo "Shell history setup for persistent appending is complete."
+fi
+
 # *********************************
 # ** Ensure config directory **
 # *********************************

test/common-utils/allow_shell_history.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+check "default-shell-is-zsh" bash -c "getent passwd $(whoami) | awk -F: '{ print $7 }' | grep '/bin/zsh'"
+# check it overrides the ~/.zshrc with default dev containers template
+check "default-zshrc-is-dev-container-template" bash -c "cat ~/.zshrc | grep ZSH_THEME | grep devcontainers"
+check "zsh-path-contains-local-bin" zsh -l -c "echo $PATH | grep '/home/devcontainer/.local/bin'"
+
+check "Ensure .zprofile is owned by remoteUser" bash -c "stat -c '%U' /home/devcontainer/.zprofile | grep devcontainer"
+
+# Report result
+reportResults

test/common-utils/scenarios.json

@@ -292,5 +292,15 @@
         "features": {
             "common-utils": {}
         }
+    },
+    "allow_shell_history": {
+        "image": "debian:bookworm",
+        "features": {
+            "common-utils": {
+                "installZsh": true,
+                "allowShellHistory": true
+            }
+        },
+        "remoteUser": "vscode"
     }
 }