autoconf.info: Writing testsuite.at
Go forward to testsuite Invocation
Go backward to Using an Autotest Test Suite
Go up to Using Autotest
Go to the top op autoconf
The `testsuite.at' is a Bourne shell script making use of special
Autotest M4 macros. It often contains a call to `AT_INIT' nears its
beginning followed by one call to `m4_include' per source file for
tests. Each such included file, or the remainder of `testsuite.at' if
include files are not used, contain a sequence of test groups. Each
test group begins with one call to `AT_SETUP', it contains an arbitrary
number of shell commands or calls to `AT_CHECK', and it completes with
one call to `AT_CLEANUP'.
- Macro: AT_INIT ([NAME])
Initialize Autotest. Giving a NAME to the test suite is
encouraged if your package includes several test suites. In any
case, the test suite always displays the package name and version.
It also inherits the package bug report address.
- Macro: AT_TESTED (EXECUTABLES)
Log the path and answer to `--version' of each program in
space-separated list EXECUTABLES. Several invocations register
new executables, in other words, don't fear registering one program
Autotest test suites rely on the `PATH' to find the tested program.
This saves from generating the absolute paths to the various tools, and
makes it possible to test installed programs. Therefore, knowing what
programs are being exercised is crucial to understand some problems in
the test suite itself, or its occasional misuses. It is a good idea to
also subscribe foreign programs you depend upon, to ease incompatibility
- Macro: AT_SETUP (TEST-GROUP-NAME)
This macro starts a group of related tests, all to be executed in
the same subshell. It accepts a single argument, which holds a
few words (no more than about 30 or 40 characters) quickly
describing the purpose of the test group being started.
- Macro: AT_KEYWORDS (KEYWORDS)
Associate the space-separated list of KEYWORDS to the enclosing
test group. This makes it possible to run "slices" of the test
suite. For instance if some of your test groups exercise some
`foo' feature, then using `AT_KEYWORDS(foo)' lets you run
`./testsuite -k foo' to run exclusively these test groups. The
TITLE of the test group is automatically recorded to `AT_KEYWORDS'.
Several invocations within a test group accumulate new keywords.
In other words, don't fear registering several times the same
keyword in a test group.
- Macro: AT_XFAIL_IF (SHELL-CONDITION)
Determine whether the test is expected to fail because it is a
known bug (for unsupported features, you should skip the test).
SHELL-CONDITION is a shell expression such as a `test' command;
you can instantiate this macro many times from within the same
test group, and one of the conditions will be enough to turn the
test into an expected failure.
- Macro: AT_CLEANUP
End the current test group.
- Macro: AT_DATA (FILE, CONTENTS)
Initialize an input data FILE with given CONTENTS. Of course, the
CONTENTS have to be properly quoted between square brackets to
protect against included commas or spurious M4 expansion. The
contents ought to end with an end of line.
- Macro: AT_CHECK (COMMANDS, [STATUS = ``0''], [STDOUT = ``''],
[STDERR = ``''], [RUN-IF-FAIL], [RUN-IF-PASS])
Execute a test by performing given shell COMMANDS. These commands
should normally exit with STATUS, while producing expected STDOUT
and STDERR contents. If COMMANDS exit with status 77, then the
whole test group is skipped. Otherwise, if this test fails, run
shell commands RUN-IF-FAIL or, if this test passes, run shell
The COMMANDS _must not_ redirect the standard output, nor the
If STATUS, or STDOUT, or STDERR is `ignore', then the
corresponding value is not checked.
The special value `expout' for STDOUT means the expected output of
the COMMANDS is the content of the file `expout'. If STDOUT is
`stdout', then the standard output of the COMMANDS is available
for further tests in the file `stdout'. Similarly for STDERR with
`expout' and `stderr'.
Created Mon Nov 8 17:42:00 2004 on tillpc with info_to_html version 0.9.6.