tasty-silver
A fancy test runner, including support for golden tests.
https://github.com/phile314/tasty-silver
| LTS Haskell 23.1: | 3.3.2 |
| Stackage Nightly 2024-12-22: | 3.3.2 |
| Latest on Hackage: | 3.3.2 |
tasty-silver-3.3.2@sha256:61ea27fac5cb0fd2aa3d3015a09e479e6984d9228c056bf86010f07f5cefbf63,3266Module documentation for 3.3.2
Tasty Silver
This package provides support for «golden testing».
A golden test is an IO action that writes its result to a file. To pass the test, this output file should be identical to the corresponding «golden» file, which contains the correct result for the test.
Interactive Mode
If the test runner is called with the -i option, the diff of any failing golden test is shown
to the user. Based upon this diff, the user can choose to update the golden standard or to
fix the test case as necessary. Interactive mode requires that at least git diff and less is
available, or preferrably wdiff and colordiff for character-based diffs.
Portability
tasty-silver aims to work under Linux, macOS, and Windows. In
particular, it should work in the GitHub CI virtual
environments.
Known limitations:
-
On
macOS, GHC ≥ 7.10 is required, as GHC ≤ 7.8 produces code that is not compatible with the System Integrity Protection mechanism of Mac OS X. In particular, you could see errors like:/usr/bin/less: getPermissions:fileAccess: permission denied (Operation not permitted) -
On Windows, the colored diff may not be available as it depends on the availability of
colordiff,less,sh, andwdiff.
Examples
For a non-trivial example see the Agda tests, which is used for testing the Agda compiler.
Maintainers
Philipp Hausmann is the primary maintainer. Andreas Abel is co-maintainer.