fix(shell-history): fix broken fish config script (#22)

* fix(shell-history): fix fish sytax and ensure creating the sym link

* ci: test fish config

* ci: ensure run tests on PRs

* test(shell-history): use the latest fish feature

* ci: use test.yaml from the latest feature-starter template

* test: fix test for fish

* test: fix test name

* chore(shell-history): bump version

* refactor(shell-history): use single quote

* test(shell-history): more tests for fish

* ci: remove failing test for now

Author: eitsupi

.github/workflows/test.yaml

@@ -3,36 +3,52 @@ on:
   push:
     branches:
       - main
+  pull_request:
   workflow_dispatch:
 
 jobs:
-  test:
+  test-autogenerated:
     runs-on: ubuntu-latest
-    # continue-on-error: true
+    continue-on-error: true
     strategy:
       matrix:
-        include:
-          - features: "dev-tunnel"
-            baseImage: "mcr.microsoft.com/vscode/devcontainers/javascript-node:0-18"
-            remoteUser: node
-          - features: "dev-tunnel"
-            baseImage: "mcr.microsoft.com/devcontainers/base:ubuntu"
-            remoteUser: root
+        features:
+          - shell-history
+        baseImage:
+          - debian:latest
+          - ubuntu:latest
+          - mcr.microsoft.com/devcontainers/base:ubuntu
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: "Install latest devcontainer CLI"
         run: npm install -g @devcontainers/cli
 
-      - name: "Generating tests for '${{ matrix.feature }}' against '${{ matrix.baseImage }}'"
-        run: devcontainer features test --features ${{ matrix.feature }} --base-image ${{ matrix.baseImage }} --remote-user ${{ matrix.remoteUser }} .
+      - name: "Generating tests for '${{ matrix.features }}' against '${{ matrix.baseImage }}'"
+        run: devcontainer features test --skip-scenarios -f ${{ matrix.features }} -i ${{ matrix.baseImage }} .
 
+  test-scenarios:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      matrix:
+        features:
+          - dev-tunnels
+          - shell-history
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Install latest devcontainer CLI"
+        run: npm install -g @devcontainers/cli
+
+      - name: "Generating tests for '${{ matrix.features }}' scenarios"
+        run: devcontainer features test -f ${{ matrix.features }} --skip-autogenerated --skip-duplicated .
 
   # test-global:
   #   runs-on: ubuntu-latest
   #   continue-on-error: true
   #   steps:
-  #     - uses: actions/checkout@v2
+  #     - uses: actions/checkout@v4
 
   #     - name: "Install latest devcontainer CLI"
   #       run: npm install -g @devcontainers/cli

src/shell-history/devcontainer-feature.json

@@ -1,7 +1,7 @@
 {
     "name": "Shell History",
     "id": "shell-history",
-    "version": "0.0.5",
+    "version": "0.0.6",
     "description": "Preserve shell history across dev container instances. Currently supports bash, zsh, and fish",
     "options": {},
     "mounts": [
@@ -18,4 +18,4 @@
     "onCreateCommand": {
         "shell-history": "/usr/local/share/stuartleeks-devcontainer-features/shell-history/scripts/oncreate.sh"
     }
-}
+}

src/shell-history/oncreate.sh

@@ -42,19 +42,18 @@ EOF
 
 # Create symlink for fish
 mkdir -p $HOME/.config/fish
-cat << EOF >> "$HOME/.config/fish/config.fish"
-if [ -z "\$XDG_DATA_HOME" ];
-then
+cat << 'EOF' >> "$HOME/.config/fish/config.fish"
+if [ -z "$XDG_DATA_HOME" ];
     set history_location ~/.local/share/fish/fish_history
 else
-    set history_location \$XDG_DATA_HOME/fish/fish_history
-fi
+    set history_location $XDG_DATA_HOME/fish/fish_history
+end
 
-if [ -f \$history_location ]; then
-    mv \$history_location "\$history_location-old"
-fi
+if [ -f $history_location ];
+    mv $history_location "$history_location-old"
+end
 
-ln -s /dc/shellhistory/fish_history \$history_location
+ln -fs /dc/shellhistory/fish_history $history_location
 EOF
 
 fix_permissions /dc/shellhistory

test/shell-history/fish_shell.sh

@@ -2,4 +2,10 @@
 
 set -e
 
-./_default.sh
+# Optional: Import test library bundled with the devcontainer CLI
+source dev-container-features-test-lib
+
+# Feature-specific tests
+check "check fish config script validity" fish -c "source $HOME/.config/fish/config.fish"
+check "check fish config script content" bash -c "cat $HOME/.config/fish/config.fish | grep -q 'XDG_DATA_HOME'"
+check "cache dir permission" bash -c "test -w /dc/shellhistory"

test/shell-history/scenarios.json

@@ -17,7 +17,7 @@
     "fish_shell": {
         "image": "mcr.microsoft.com/devcontainers/base:debian",
         "features": {
-            "ghcr.io/meaningful-ooo/devcontainer-features/fish:1": {},
+            "ghcr.io/meaningful-ooo/devcontainer-features/fish:latest": {},
             "shell-history": {}
         }
     },
@@ -28,4 +28,4 @@
         },
         "remoteUser": "root"
     }
-}
+}