2.9 KiB
zsh-syntax-highlighting / tests
Utility scripts for testing zsh-syntax-highlighting highlighters.
The tests harness expects the highlighter directory to contain a test-data
directory with test data files.
See the main highlighter for examples.
Each test should define the string $BUFFER
that is to be highlighted and the
array parameter $expected_region_highlight
.
The value of that parameter is a list of strings of the form "$i $j $style"
.
or "$i $j $style $todo"
.
Each string specifies the highlighting that $BUFFER[$i,$j]
should have;
that is, $i
and $j
specify a range, 1-indexed, inclusive of both endpoints.
$style
is either a key of $ZSH_HIGHLIGHT_STYLES
or NONE
to specify no
highlighting should be observed.
If $todo
exists, the test point is marked as TODO (the failure of that test
point will not fail the test), and $todo
is used as the explanation.
Note: $region_highlight
uses the same "$i $j $style"
syntax but
interprets the indexes differently.
Isolation: Each test is run in a separate subshell, so any variables,
aliases, functions, etc., it defines will be visible to the tested code (that
computes $region_highlight
), but will not affect subsequent tests. The
current working directory of tests is set to a newly-created empty directory,
which is automatically cleaned up after the test exits. For example:
setopt PATH_DIRS
mkdir -p foo/bar
touch foo/bar/testing-issue-228
chmod +x foo/bar/testing-issue-228
path+=( "$PWD"/foo )
BUFFER='bar/testing-issue-228'
expected_region_highlight=(
"1 21 command" # bar/testing-issue-228
)
Writing new tests
An experimental tool is available to generate test files:
zsh -f tests/generate.zsh 'ls -x' \
| sed s/YYYY/$(date +%Y)/ \
> highlighters/main/test-data/foo.zsh
git add -N $_
This generates a test file based on the current highlighting of the given $BUFFER
(in this case, ls -x
).
This tool is experimental. Its interface may change. In particular it may
grow ways to set $PREBUFFER
and/or $ZSH_HIGHLIGHT_HIGHLIGHTERS
or to
inject free-form code into the generated file.
Highlighting test
test-highlighting.zsh
tests the correctness of
the highlighting. Usage:
zsh test-highlighting.zsh <HIGHLIGHTER NAME>
All tests may be run with
make test
which will run all highlighting tests and report results in TAP format.
By default, the results of all tests will be printed; to show only "interesting"
results (tests that failed but were expected to succeed, or vice-versa), run
make quiet-test
(or make test QUIET=y
).
Performance test
test-perfs.zsh
measures the time spent doing the
highlighting. Usage:
zsh test-perfs.zsh <HIGHLIGHTER NAME>
All tests may be run with
make perf