summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2011-08-15 20:25:54 +0100
committerLars Wirzenius <liw@liw.fi>2011-08-15 20:25:54 +0100
commitda6cba614a433a39e83d704fcf5ca7d108c8ffb8 (patch)
tree0efdfadc144ebbfb7c7d9cd73db02eb2cc07f207 /README
parent8dcb783e5bcd9b5df28fafc2e9b29ec4b03735d2 (diff)
downloadcmdtest-da6cba614a433a39e83d704fcf5ca7d108c8ffb8.tar.gz
Remove outdated text from README.
Diffstat (limited to 'README')
-rw-r--r--README76
1 files changed, 0 insertions, 76 deletions
diff --git a/README b/README
index e206d21..6411733 100644
--- a/README
+++ b/README
@@ -1,82 +1,6 @@
README for cmdtest
==================
-Sometimes it would be nice to test Unix command line tools as black
-boxes. This is the start of a tool for doing that. Not written yet.
-
-Each test consists a directory with several fuiles,
-some of which are optional:
-
-* `setup`: shell commands to run before the test, one per line
-* `teardown`: shell commands to run after the test, one per line
-* `args`: arguments to the command, i.e., everything beyond `argv[0]`,
- one argument per line (`argv[0]` is given with `--command=CMD` option)
-* `stdin`: the contents is fed to the command via the standard input;
- if not given, `/dev/null` is used instead
-* `stdout`: the expected output from stdout (default is no output)
-* `stderr`: the expected output from stderr (default is no output)
-* `exit`: one line giving the expected exit code of the command (zero, if
- not given)
-* `verify`: shell commands to verify the output, one per line; if this
- exists, then `stdout`, `stderr`, and `exit` are not checked automatically
-
-In addition to a single `setup` file, you can provide many shell scripts
-name `setup-*`, and these will be executed one by one. Ditto for `teardown`.
-
-Instead of a single `args` file, you can provide `args-*` files, and
-corresponding `stdout-*`, `stderr-*`, and `exit-*` files, or
-`verify-*` files. This allows you to share the setup and teardown
-scaffolding for several tests, without having to duplicate them between
-test directories.
-
-You may use the following environment variables:
-
-* `TESTDIR`: a temporary directory (created and removed automatically),
- where you can create files indiscriminately
-
-A simple test:
-
- sorts-correctly/
- stdin # "xyz\nabc\ndef\n"
- stdout # "abc\ndef\nxyz\n"
-
-Invocation:
-
- cmdtest --command=./mysort sorts-correctly
-
-A more complicated test:
-
- sorts-correctly/
- stdin-empty # ""
- stdout-empty # ""
- stdin-one-line # "abc\n"
- stdout-one-line # "abc\n"
- stdin-two-lines-sorted # "abc\ndef\n"
- stdout-two-lines-sorted # "abc\ndef\n"
- stdin-two-lines-unsorted # "def\nabc\n"
- stdout-two-lines-unsorted # "abc\ndef\n"
-
-This will make cmdtest run four tests: it will run the command to
-be tested with the standard input coming from `stdin-empty` and comparing
-the output with `stdout-empty`, and repeating that with the other pairs
-of files.
-
-If cmdtest finds a problem, it shows the "diff -u" output of the expected
-and actual outputs.
-
----
-
- sorts-empty-file.stdin # ""
- sorts-empty-file.stdout # ""
- sorts-one-line.stdin # "abc\n"
- sorts-one-line.stdout # "abc\n"
- sorts-two-sorted-lines.stdin # "abc\ndef\n"
- sorts-two-sorted-lines.stdout # "abc\ndef\n"
- sorts-two-unsorted-lines.stdin # "def\nabc\n"
- sorts-two-unsorted-lines.stdout # "abc\ndef\n"
-
----
-
`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.