text / tests-and-benchmarks.markdown

The default branch has multiple heads

Tests and benchmarks


To run the tests and benchmarks, you will need the test data, which you can clone from one of the following locations:

You should clone that repository into the tests subdirectory (your clone must be named text-test-data locally), then run make -C tests/text-test-data to uncompress the test files. Many tests and benchmarks will fail if the test files are missing.

Functional tests

The functional tests are located in the tests subdirectory. An overview of what's in that directory:

Makefile          Has targets for common tasks
Tests             Source files of the testing code
scripts           Various utility scripts
text-tests.cabal  Cabal file that compiles all benchmarks

The text-tests.cabal builds:

  • A copy of the text library, sharing the source code, but exposing all internal modules, for testing purposes
  • The different test suites

To compile, run all tests, and generate a coverage report, simply use make.


The benchmarks are located in the benchmarks subdirectory. An overview of what's in that directory:

Makefile               Has targets for common tasks
haskell                Source files of the haskell benchmarks
python                 Python implementations of some benchmarks
ruby                   Ruby implementations of some benchmarks
text-benchmarks.cabal  Cabal file which compiles all benchmarks

To compile the benchmarks, navigate to the benchmarks subdirectory and run cabal configure && cabal build. Then, you can run the benchmarks using:


However, since there's quite a lot of benchmarks, you usually don't want to run them all. Instead, use the -l flag to get a list of benchmarks:


And run the ones you want to inspect. If you want to configure the benchmarks further, the exact parameters can be changed in Benchmarks.hs.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.