zsh-syntax-highlighting/tests/README.md
Matthew Martin d99aa58aaa test harness: Run each test as a single subshell.
That allows tests to be completely independent of each other, so tests that
change global state — such as modify environment variables, define functions or
aliases, or hash commands — will not affect other tests, without needing an
explicit cleanup step.

This enables testing path-tilde-home with and without $HOME set, which is part
of issue #216.

While at it, convert the test harness to TAP.  This fixes issue #180 by adding
support for "not ok 42 # TODO" output.

This commit assumes that 'grep' supports POSIX-compliant -q and -v flags.

Patch-by: Matthew Martin <phy1729@gmail.com>
2015-10-23 03:31:00 +00:00

1.3 KiB

zsh-syntax-highlighting / tests

Utility scripts for testing zsh-syntax-highlighting highlighters.

The tests expect the highlighter directory to contain a test-data directory with test data files. See the main highlighter for examples.

Each test should define the array parameter $expected_region_highlight.
The value of that parameter is a list of "$i $j $style [$todo]" strings.
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.
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.

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.

performance test

test-perfs.zsh measures the time spent doing the highlighting. Usage:

zsh test-perfs.zsh <HIGHLIGHTER NAME>