Skip to content

Commit

Permalink
small doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Jul 15, 2009
1 parent f81b928 commit 9079f55
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions shelltestrunner.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ synopsis: A tool for testing command-line programs.
description:
.
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
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.
.
Expand All @@ -23,7 +23,7 @@ description:
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 # command line args, executable will be prepended
> -opt1 -opt2 arg1 arg2 # one line of command line args, executable will be prepended
> <<<
> 0 or more lines of input
> >>> [/regexp/]
Expand All @@ -35,20 +35,20 @@ description:
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
! 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.
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.
.
Issues:
.
- can't put / in a regexp
.
- can't test input/output which does not end with newline
.
- can't use / in regexps
.
- option processing is weak
.
Wishlist:
Expand Down

0 comments on commit 9079f55

Please sign in to comment.