test(ci): add fish config test suite and gate docs build on it
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.
This commit is contained in:
@@ -0,0 +1,75 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
#
|
||||
# Functional checks for foundational config behavior. Sourced inside a
|
||||
# fully-loaded, sandboxed interactive fish session by tests/run-tests.fish
|
||||
# -- see that file for the sandbox setup. Each test_* function returns 0
|
||||
# on pass, non-zero on fail; functional_test_main collects and runs them.
|
||||
|
||||
function test_xdg_defaults
|
||||
test -n "$XDG_CONFIG_HOME" -a -n "$XDG_CACHE_HOME" \
|
||||
-a -n "$XDG_DATA_HOME" -a -n "$XDG_STATE_HOME"
|
||||
end
|
||||
|
||||
function test_path_additions
|
||||
contains -- "$HOME/.local/bin" $PATH
|
||||
end
|
||||
|
||||
function test_cdpath
|
||||
contains -- "$HOME/projects" $CDPATH
|
||||
end
|
||||
|
||||
function test_vi_key_bindings
|
||||
test "$fish_key_bindings" = fish_vi_key_bindings
|
||||
end
|
||||
|
||||
function test_abbreviations_loaded
|
||||
abbr -q n
|
||||
end
|
||||
|
||||
function test_core_functions_defined
|
||||
for f in cat logs config-help fish-deps check_fish_deps config-settings
|
||||
if not functions -q $f
|
||||
echo " missing function: $f"
|
||||
return 1
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
function test_exit_rewired
|
||||
functions -q exit
|
||||
and functions exit | string match -q '*smart_exit*'
|
||||
end
|
||||
|
||||
function test_op_registry_lookup
|
||||
functions -q __fish_config_op_registry_lookup
|
||||
or return 1
|
||||
set -l tags (__fish_config_op_registry_lookup config cdpath)
|
||||
test $status -eq 0 -a (count $tags) -gt 0
|
||||
end
|
||||
|
||||
function test_op_enabled_fail_open
|
||||
# An identity/site pair with no registry entry must resolve to
|
||||
# enabled -- the documented fail-open default.
|
||||
__fish_config_op_enabled __fish_config_test_never_registered somesite
|
||||
end
|
||||
|
||||
function test_greeting_function_defined
|
||||
functions -q fish_greeting
|
||||
end
|
||||
|
||||
function functional_test_main
|
||||
set -l names (functions -a | string match 'test_*' | sort)
|
||||
set -l failed 0
|
||||
for name in $names
|
||||
if $name
|
||||
echo " PASS $name"
|
||||
else
|
||||
echo " FAIL $name"
|
||||
set failed (math $failed + 1)
|
||||
end
|
||||
end
|
||||
echo ""
|
||||
echo (math (count $names) - $failed)"/"(count $names)" passed"
|
||||
return $failed
|
||||
end
|
||||
Executable
+89
@@ -0,0 +1,89 @@
|
||||
#!/usr/bin/env fish
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
#
|
||||
# CI test runner for this fish configuration.
|
||||
# 1. Syntax-lints every tracked .fish file (fish -n).
|
||||
# 2. Copies the config-relevant files into a throwaway sandbox (never
|
||||
# the live checkout -- this repo doubles as a real ~/.config/fish,
|
||||
# so a symlinked sandbox would let universal-variable writes like
|
||||
# first-run's escape into the real, gitignored fish_variables file)
|
||||
# and loads it as an isolated interactive session.
|
||||
# 3. Runs the functional checks in tests/functional.fish inside that
|
||||
# loaded session.
|
||||
#
|
||||
# Usage: fish tests/run-tests.fish
|
||||
|
||||
set -l script_dir (realpath (dirname (status filename)))
|
||||
set -l repo_root (realpath $script_dir/..)
|
||||
set -l overall_failed 0
|
||||
|
||||
# ---- Phase 1: syntax lint ------------------------------------------------
|
||||
echo "== Syntax lint =="
|
||||
set -l lint_files $repo_root/config.fish
|
||||
for dir in functions conf.d completions integrations
|
||||
set -a lint_files (find $repo_root/$dir -name '*.fish' | sort)
|
||||
end
|
||||
|
||||
set -l lint_failed 0
|
||||
for f in $lint_files
|
||||
set -l out (fish -n $f 2>&1)
|
||||
if test $status -ne 0
|
||||
echo " FAIL "(string replace $repo_root/ '' $f)
|
||||
printf '%s\n' $out
|
||||
set lint_failed (math $lint_failed + 1)
|
||||
end
|
||||
end
|
||||
set -l lint_total (count $lint_files)
|
||||
echo (math $lint_total - $lint_failed)"/$lint_total files passed lint"
|
||||
if test $lint_failed -ne 0
|
||||
set overall_failed 1
|
||||
end
|
||||
|
||||
# ---- Phase 2: isolated load + functional checks --------------------------
|
||||
echo ""
|
||||
echo "== Sandboxed load + functional checks =="
|
||||
|
||||
set -l sandbox (mktemp -d)
|
||||
set -l sandbox_cfg $sandbox/xdgcfg/fish
|
||||
mkdir -p $sandbox_cfg
|
||||
# path-setup only adds directories that already exist (fish_add_path is a
|
||||
# no-op on missing paths), so give it $HOME/.local/bin to find.
|
||||
mkdir -p $sandbox/home/.local/bin
|
||||
|
||||
cp $repo_root/config.fish $sandbox_cfg/
|
||||
test -f $repo_root/fish_plugins
|
||||
and cp $repo_root/fish_plugins $sandbox_cfg/
|
||||
for d in functions conf.d completions integrations themes data
|
||||
test -d $repo_root/$d
|
||||
and cp -r $repo_root/$d $sandbox_cfg/
|
||||
end
|
||||
|
||||
set -l err_file (mktemp)
|
||||
env -i \
|
||||
HOME=$sandbox/home \
|
||||
XDG_CONFIG_HOME=$sandbox/xdgcfg \
|
||||
PATH="$PATH" \
|
||||
TERM=xterm \
|
||||
__fish_config_op_autoexec=off \
|
||||
fish -i -c "source $repo_root/tests/functional.fish; functional_test_main" \
|
||||
2>$err_file
|
||||
set -l functional_status $status
|
||||
|
||||
set -l stderr_out (cat $err_file)
|
||||
rm -rf $sandbox $err_file
|
||||
|
||||
if test -n "$stderr_out"
|
||||
# Diagnostic only, not a gate: on machines with vendor fish configs
|
||||
# (e.g. CachyOS's cachyos-fish-config, which this repo's config.fish
|
||||
# sources when present) unrelated vendor warnings can land here. Real
|
||||
# breakage in this repo's own code is caught by the assertions below.
|
||||
echo " Session stderr output (informational):"
|
||||
printf '%s\n' $stderr_out
|
||||
end
|
||||
|
||||
if test $functional_status -ne 0
|
||||
set overall_failed 1
|
||||
end
|
||||
|
||||
exit $overall_failed
|
||||
Reference in New Issue
Block a user