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, where each test can specify: command-line arguments, input, expected output, expected stderr output, and/or 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:

A test file contains 0 or more shell tests, each of which looks like this:

# 0 or more comment lines beginning with #
-opt1 -opt2 arg1 arg2 # one line of 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]
>>>= [expected numeric exit code or /regexp/]

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 the fields you specify will be tested, unless you use the -i/--implicit-tests flag, which adds default tests (empty stdout, empty stderr, and 0 exit code) for omitted fields.



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 14:56:47 UTC 2009
Distributions Debian:1.9, LTSHaskell:1.9, NixOS:1.9, Stackage:1.9
Executables shelltestrunner
Downloads 10734 total (64 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2016-12-31 [all 7 reports]


Maintainer's Corner

For package maintainers and hackage trustees