diff options
| author | Lars Wirzenius <liw@liw.fi> | 2011-12-24 15:27:48 +0000 |
|---|---|---|
| committer | Lars Wirzenius <liw@liw.fi> | 2011-12-24 15:27:48 +0000 |
| commit | 518f71dd14414557fd76a1109876ece974bd30ff (patch) | |
| tree | 5fc8b1667c4556f53c65b181d8e9c394d346f756 /README | |
| parent | 160b5aaf6643481a5fd19dfeca04253ed5eba796 (diff) | |
| download | cmdtest-518f71dd14414557fd76a1109876ece974bd30ff.tar.gz | |
update README
Diffstat (limited to 'README')
| -rw-r--r-- | README | 21 |
1 files changed, 9 insertions, 12 deletions
@@ -2,13 +2,9 @@ README for cmdtest ================== `cmdtest` black box tests Unix command line tools. -Roughly, it is given a command line and input files, and the expected output, -and it verifies that the command line produces the expected output. -If not, it reports a problem, and shows the differences. - -The command line arguments, inputs, and outputs are given in files -that follow a naming convention. The test report is written to the -standard output. +Given some test scripts, their inputs, and expected outputs, +it verifies that the command line produces the expected output. +If not, it reports problems, and shows the differences. Each test case consists of: @@ -20,7 +16,7 @@ Each test case consists of: * a shell script to run before the test (`foo.setup`) * a shell script to run after the test (`foo.teardown`) -Usually, a single test is not enough. All tests can be put into the +Usually, a single test is not enough. All tests are put into the same directory, and they may share some setup and teardown code: * a shell script to run once, before all tests (`setup-once`) @@ -44,10 +40,11 @@ or several such directories, and it does the following: output match `foo.stdout`, and standard error match `foo.stderr`? * execute `teardown-once` -All of these files are optional. If a setup/teardown script is missing, -it is simply not executed. If one of the standard input, output, or -error files is missing, it is treated as if it were empty. If the -exit code file is missing, it is treated as if it specified an exit +Except for the `.script`, all of these files are optional. +If a setup/teardown script is missing, it is simply not executed. +If one of the standard input, output, or error files is missing, +it is treated as if it were empty. +If the exit code file is missing, it is treated as if it specified an exit code of zero. The shell scripts may use the following environment variables: |