73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
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](../highlighters/main/test-data) 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
|
|
)
|
|
|
|
Highlighting test
|
|
-----------------
|
|
|
|
[`test-highlighting.zsh`](tests/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][TAP].
|
|
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`).
|
|
|
|
[TAP]: http://testanything.org/
|
|
|
|
|
|
Performance test
|
|
----------------
|
|
|
|
[`test-perfs.zsh`](tests/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
|