add persistence feature

Author: lugoues

.github/workflows/test.yaml

@@ -53,6 +53,7 @@ jobs:
           - google-cloud-cli
           - krew
           - luarocks
+          - persistence
     steps:
       - uses: actions/checkout@v3
 

src/persistence/devcontainer-feature.json

@@ -0,0 +1,25 @@
+{
+  "id": "persistence",
+  "version": "1.0.7",
+  "name": "Persistance",
+  "documentationURL": "http://github.com/lugoues/devcontainers-features/tree/main/src/persistence",
+  "description": "Store data you with to persist between cntainer rebuilds.",
+  "options": {
+    "paths": {
+      "default": "",
+      "description": "Colon separated list of directory paths to persist.",
+      "type": "string"
+    }
+  },
+  "mounts": [
+    {
+      "source": "persistence-${devcontainerId}",
+      "target": "/mnt/persistence_data",
+      "type": "volume"
+    }
+  ],
+  "postCreateCommand": "bash /usr/local/share/persistence_post_create",
+  "installsAfter": [
+    "ghcr.io/devcontainers/features/common-utils"
+  ]
+}

src/persistence/install.sh

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+sudo_if() {
+    COMMAND="$*"
+
+    if [ "$(id -u)" -ne 0 ]; then
+        sudo $COMMAND
+    else
+        $COMMAND
+    fi
+}
+
+PERSIST_DIR="/mnt/persistence_data"
+PERSIST_POST_CREATE="/usr/local/share/persistence_post_create"
+
+tee "$PERSIST_POST_CREATE" > /dev/null \
+<< EOF
+#!/bin/sh
+set -e
+
+SUDO_CMD=""
+[ "\${USER}" != "root" ] && SUDO_CMD="sudo"
+
+echo "Setting owner for ${PERSIST_DIR} to \${USER}"
+\${SUDO_CMD} chown -R \$USER "${PERSIST_DIR}"
+
+EOF
+
+chmod +x "${PERSIST_POST_CREATE}"
+
+IFS=':' read -ra PATH_ARRAY <<< "${PATHS}"
+for path in "${PATH_ARRAY[@]}"; do
+    [[ -z "${path}" ]] && continue
+
+    # Replace ~ or $HOME with $_REMOTE_USER_HOME
+    path="${path/#\~/${_REMOTE_USER_HOME}}"
+    path="${path/#\$HOME/${_REMOTE_USER_HOME}}"
+
+    # Build safe persist_path
+    original_path=$(realpath -m "${path}")
+    safe_name="${original_path//\//_}"
+    persist_path="${PERSIST_DIR}/${safe_name#_}"
+
+    # Create target directory
+    sudo_if sudo mkdir -p "${persist_path}"
+
+    # Create parent directory if needed
+    parent_dir="$(dirname "${original_path}")"
+    mkdir -p "${parent_dir}"
+
+
+    # Backup and remove existing directory if it exists
+    if [[ -d "${original_path}" ]]; then
+        mv "${original_path}" "${original_path}.backup"
+    fi
+
+    ln -s "${persist_path}" "${original_path}"
+w
+    echo "\${SUDO_CMD} chown -R \$USER \"${parent_dir}\"" >> "${PERSIST_POST_CREATE}"
+done
+

src/persistence/post-install.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+echo "(*) Executing post-installation steps..."
+
+sudo chown ${USER} /mnt/persistence_data

test/persistence/persitence_single_link.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+
+source dev-container-features-test-lib
+
+# from scenario
+source="/mnt/persistence_data"
+home="/home/vscode"
+
+
+check "source exists" test -d "${source}"
+check "target symlink" test -L "${home}/.config/tests/nested/deep"
+check "write test file to new linked dir" touch "${home}/.config/tests/nested/deep/test_file"
+check "ensure it exists in target" test -f "${source}/home_vscode_.config_tests_nested_deep/test_file"
+check "ensure user owns target" bash -xc "[[ \$(stat -c '%U' ${source}/home_vscode_.config_tests_nested_deep/test_file) == vscode ]]"
+
+reportResults

test/persistence/scenarios.json

@@ -0,0 +1,12 @@
+{
+  "persitence_single_link": {
+    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+    "features": {
+      "persistence": {
+        "paths": "~/.config/tests/nested/deep"
+      }
+    },
+    "containerUser": "vscode",
+    "onCreateCommand": "mkdir -p /mnt/persistence_data"
+  }
+}

test/persistence/test.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+source dev-container-features-test-lib
+
+
+reportResults

test/uv/test.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+
+set -e
+
+source dev-container-features-test-lib
+
+check "uv version" uv --version
+
+reportResults