NAME
atf-report —
transforms the output of
atf-run to different formats
SYNOPSIS
atf-report |
[-o fmt1:path1
[.. -o
fmtN:pathN]] |
DESCRIPTION
atf-report reads the output of
atf-run and
transforms it to different formats. Some of these are user-friendly and others
are machine-parseable, which opens a wide range of possibilities to analyze
the results of a test suite's execution. See
Output formats below for more details
on which these formats are.
In the first synopsis form,
atf-report reads the output of
atf-run through its standard input and, if no
-o options are given, prints a user-friendly report on its
standard output using the ‘ticker’ format. If
-o
options are provided (more than one are allowed), they specify the complete
list of reports to generate. They are all generated simultaneously, and for
obvious reasons, two reports cannot be written to the same file. Note that the
default output is suppressed when
-o is provided.
In the second synopsis form,
atf-report will print information
about all supported options and their purpose.
The following options are available:
-
-
- -h
- Shows a short summary of all available options and their
purpose.
-
-
- -o
fmt:path
- Adds a new output format. fmt is one
of the formats described later on in
Output formats.
path specifies where the report will be written to.
Depending on the chosen format, this may refer to a single file or to a
directory. For those formats that write to a single file, specifying a
‘-’ as the path will redirect the report to the standard
output.
The following output formats are allowed:
-
-
- csv
- A machine-parseable Comma-Separated Values (CSV) file. This
file contains the results for all test cases and test programs. Test cases
are logged using the following syntax:
tc, duration, test-program, test-case, result[, reason]
The ‘result’ field for test cases is always one of
‘passed’, ‘skipped’ or ‘failed’. The
last two are always followed by a reason.
Test programs are logged with the following syntax:
tp, duration, test-program, result[, reason]
In this case, the ‘result’ can be one of: ‘passed’,
which denotes test programs that ran without any failure;
‘failed’, which refers to test programs in which one or more
test cases failed; or ‘bogus’, which mentions those test
programs that failed to execute by some reason. The reason field is only
available in the last case.
The time required to execute each test case and test program is also
provided. You should not rely on the order of the entries in the resulting
output.
-
-
- ticker
- A user-friendly report that shows the progress of the test
suite's execution as it operates. This type of report should always be
redirected to a virtual terminal, not a file, as it may use control
sequences that will make the output unreadable in regular files.
-
-
- xml
- A report contained in a single XML file. Ideal for later
processing with
xsltproc(1) to generate
nice HTML reports.
EXAMPLES
The most simple way of running a test suite is to pipe the output of
atf-run through
atf-report without any
additional flags. This will use the default output format, which is suitable
to most users:
In some situations, it may be interesting to get a machine-parseable file aside
from the standard report. This can be done as follows:
atf-run | atf-report -o csv:testsuite.csv -o ticker:-
Or if the standard report is not desired, thus achieving completely silent
operation: atf-run | atf-report -o csv:testsuite.csv
SEE ALSO
atf-run(1),
atf(7)