shelltestrunner: A tool for testing command-line programs.

[ program, testing ] [ Propose Tags ]

Run a given program through "shell" tests specifed by one or more test files, each of which can specify: command-line arguments, input, expected output, expected stderr output, and expected exit code. This was extracted from the hledger project, inspired by the tests in John Wiegley's ledger project, and uses test-framework's test runner.


shelltestrunner [opts] executable testfile1 [testfile2 ...] [-- <test-framework runner opts>]

You can pass options through to test-framework's runner; they must go after -- at the end. You may be able to get a big speedup by running tests in parallel: try -- -j8.

Test file format:

# 0 or more comment lines beginning with #
-opt1 -opt2 arg1 arg2 # command line args, executable will be prepended
0 or more lines of input
>>> [/regexp/]
[..or 0 or more lines of expected output]
>>>2 [/regexp/]
[..or 0 or more lines of expected error output]
>>>= [/regexp/]
[..or expected numeric exit code]

Each expected field can have either a regular expression match expression, in which case the test passes if the output is matched, or 0 or more data lines, in which case the output must match these exactly. A ! preceding a regexp negates the match. The regular expression syntax is that supported by the regexpr library.

Apart from the command line, all fields are optional. Only fields specified in the test will be tested, unless you use the -i/--implicit-tests flag, which will test for empty stdout, empty stderr, or 0 exit code where fields are omitted.



Versions 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.1, 1.2, 1.2.1, 1.3, 1.3.1, 1.3.2, 1.3.3, 1.3.4, 1.3.5, 1.9
Dependencies base (>=3 && <5), HUnit, parseargs (==0.1.*), parsec, process, regexpr (>=0.5.1), test-framework, test-framework-hunit (==0.2.*) [details]
License LicenseRef-GPL
Author Simon Michael <>
Maintainer Simon Michael <>
Category Testing
Home page
Uploaded by SimonMichael at Wed Jul 15 05:24:23 UTC 2009
Distributions Debian:1.3.5, LTSHaskell:1.9, NixOS:1.9, Stackage:1.9, openSUSE:1.9
Executables shelltestrunner
Downloads 9990 total (26 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2016-12-31 [all 7 reports]
Hackage Matrix CI


Maintainer's Corner

For package maintainers and hackage trustees