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

src/common-utils/devcontainer-feature.json

@@ -64,6 +64,18 @@
             "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": "${devcontainerId}-shellhistory",
+            "target": "/dc/shellhistory",
+            "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,55 @@ if [ "${INSTALL_ZSH}" = "true" ]; then
     fi
 fi
 
+# *********************************
+# ** Enable shell history **
+# *********************************
+#
+# Generally, the installation favours configuring a shell to use the mounted volume
+# for storing history rather than symlinking as any operation to recreate files 
+# could delete the symlink. 
+# On shells where this isn't possible, we symlink as a fallback.
+#
+
+if [ "${ALLOW_SHELL_HISTORY}" = "true" ]; then
+# Set HISTFILE for bash
+cat << EOF >> "${user_home}/.bashrc"
+if [[ -z "\$HISTFILE_OLD" ]]; then
+    export HISTFILE_OLD=\$HISTFILE
+fi
+export HISTFILE=/dc/shellhistory/.bash_history
+export PROMPT_COMMAND='history -a'
+sudo chown -R $USERNAME /dc/shellhistory
+EOF
+chown -R $USERNAME ${user_home}/.bashrc
+
+if [ "${INSTALL_ZSH}" = "true" ]; then
+# Set HISTFILE for zsh
+cat << EOF >> "${user_home}/.zshrc"
+export HISTFILE=/dc/shellhistory/.zsh_history
+export PROMPT_COMMAND='history -a'
+sudo chown -R $USERNAME /dc/shellhistory
+EOF
+chown -R $USERNAME ${user_home}/.zshrc
+fi
+
+# Create symlink for fish
+mkdir -p ${user_home}/.config/fish
+cat << EOF >> "${user_home}/.config/fish/config.fish"
+if test -z "\$XDG_DATA_HOME"
+    set history_location ~/.local/share/fish/fish_history
+else
+    set history_location \$XDG_DATA_HOME/fish/fish_history
+end
+if test -f \$history_location
+    mv \$history_location "\$history_location-old"
+end
+ln -s /dc/shellhistory/fish_history \$history_location
+sudo chown -R $USERNAME \$history_location
+EOF
+chown -R $USERNAME ${user_home}/.config/
+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,
+                "configureZshAsDefaultShell": true,
+                "allowShellHistory": true
+            }
+        }
     }
 }