test(ci): add fish config test suite and gate docs build on it #109

2026-08-20T05:03:57Z

rootiest commented

2026-08-20 05:03:57 +00:00

Summary

We had a well-covered test/verify pipeline for the docs SSoT (docs/verify-manual.py) but nothing exercising the actual shell config code in CI — only the manual pre-push check the maintainer ran by hand.
Adds tests/run-tests.fish: syntax-lints every tracked .fish file (fish -n), then loads the config in an isolated scratch HOME/XDG sandbox and runs the functional suite in tests/functional.fish — 10 checks covering XDG defaults, PATH/CDPATH setup, vi key bindings, abbreviations, core function autoloading, the exit/smart_exit rewire, and the opinionated-component registry (including its fail-open default).
The sandbox copies config-relevant files into a throwaway temp tree rather than symlinking the checkout — this repo doubles as a real ~/.config/fish, so a symlinked sandbox would let universal-variable writes (e.g. first-run's set -U) leak into the real, gitignored fish_variables file. Verified locally: fish_variables's mtime is unchanged across repeated test runs.
Wires the suite into .github/workflows/build-docs.yml as a new test job; build-docs now needs: test, so a broken config can no longer get built and published to the docs site.
Documents the workflow in a new README Testing section.

Manual Verification Checklist

fish tests/run-tests.fish exits 0 locally (216/216 lint, 10/10 functional checks)
Intentionally breaking a feature (e.g. commenting out an abbreviation) makes the corresponding test_* check fail and the script exit non-zero
Introducing a .fish syntax error makes the lint phase fail and the script exit non-zero
On push, the Gitea Actions test job runs and completes before build-docs starts
README's new Testing section renders correctly and its Table of Contents link works

## Summary - We had a well-covered test/verify pipeline for the docs SSoT (`docs/verify-manual.py`) but nothing exercising the actual shell config code in CI — only the manual pre-push check the maintainer ran by hand. - Adds `tests/run-tests.fish`: syntax-lints every tracked `.fish` file (`fish -n`), then loads the config in an isolated scratch `HOME`/XDG sandbox and runs the functional suite in `tests/functional.fish` — 10 checks covering XDG defaults, `PATH`/`CDPATH` setup, vi key bindings, abbreviations, core function autoloading, the `exit`/`smart_exit` rewire, and the opinionated-component registry (including its fail-open default). - The sandbox copies config-relevant files into a throwaway temp tree rather than symlinking the checkout — this repo doubles as a real `~/.config/fish`, so a symlinked sandbox would let universal-variable writes (e.g. first-run's `set -U`) leak into the real, gitignored `fish_variables` file. Verified locally: `fish_variables`'s mtime is unchanged across repeated test runs. - Wires the suite into `.github/workflows/build-docs.yml` as a new `test` job; `build-docs` now `needs: test`, so a broken config can no longer get built and published to the docs site. - Documents the workflow in a new README **Testing** section. ## Manual Verification Checklist - [x] `fish tests/run-tests.fish` exits 0 locally (216/216 lint, 10/10 functional checks) - [x] Intentionally breaking a feature (e.g. commenting out an abbreviation) makes the corresponding `test_*` check fail and the script exit non-zero - [x] Introducing a `.fish` syntax error makes the lint phase fail and the script exit non-zero - [x] On push, the Gitea Actions `test` job runs and completes before `build-docs` starts - [x] README's new Testing section renders correctly and its Table of Contents link works

rootiest added 1 commit 2026-08-20 05:03:58 +00:00

test(ci): add fish config test suite and gate docs build on it 642c981e4b

Adds tests/run-tests.fish (syntax lint over every .fish file, plus a
sandboxed interactive load) and tests/functional.fish (10 checks
covering XDG/PATH/CDPATH setup, key bindings, abbreviations, core
functions, exit rewiring, and the opinionated-component registry).

The sandbox copies config-relevant files into a scratch HOME/XDG tree
rather than symlinking the checkout, since this repo also serves as a
live ~/.config/fish and a symlink would let universal-variable writes
leak into the real fish_variables file.

Wires the suite into build-docs.yml as a `test` job that `build-docs`
now depends on, so a broken config can no longer get published to the
docs site. Documents the workflow in the README's new Testing section.

rootiest merged commit 2608a6cd72 into main

2026-08-20 05:04:21 +00:00

rootiest deleted branch ci-fish-config-tests

2026-08-20 05:04:21 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rootiest/fish-config#109