zsh-syntax-highlighting/tests
Daniel Shahaf c015339202 tests: Provide an independent, auto-cleaned working directory to each test.
Fixes zsh-users/zsh-syntax-highlighting#182.
Prerequisite for testing issue #228.

* tests/test-highlighting.zsh
  (run_test): Move functionality to run_test_internal; make run_test be a wrapper
    that handles creating and cleaning up the tempdir.

* tests/README.md: Document the new feature.

* "highlighters/main/test-data/path-space- .zsh"
* highlighters/main/test-data/path-tilde-named.zsh
* highlighters/main/test-data/path.zsh
    Change test data to not depend on being run from the source directory.
2015-11-16 22:54:52 +00:00
..
README.md tests: Provide an independent, auto-cleaned working directory to each test. 2015-11-16 22:54:52 +00:00
tap-colorizer.zsh 'make test': Fix breakage introduced by 4d3da30f8b: 2015-10-27 11:59:20 +02:00
test-highlighting.zsh tests: Provide an independent, auto-cleaned working directory to each test. 2015-11-16 22:54:52 +00:00
test-perfs.zsh Big refactoring. 2011-06-12 22:57:14 +02:00

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 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.

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.

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>

All tests may be run with

make perf