kyua-report man page

report — Generates reports with the results of a test suite run


report [--output path] [--results-file file] [--results-filter types] [--show-context]


The report command generates a user-friendly, plain-text report designed to be consumed by the user from the terminal. This report is not intended to be machine-parseable. To do so, the command processes a results file and then creates a textual summary of the test case results recorded in that results file.

The following subcommand options are recognized:

--output path

Specifies the path to which the report should be written to. The special values /dev/stdout and /dev/stderr can be used to specify the standard output and the standard error respectively.

--results-file path, -s path

Specifies the results file to operate on. Defaults to ‘LATEST’, which causes report to automatically load the latest results file for the current test suite. See kyua-results-files(7) for more information.

--results-filter types

Comma-separated list of the test result types to include in the report. The ordering of the values is respected so that you can determine how you want the list of tests to be shown.

The valid values are: ‘broken’, ‘failed’, ‘passed’, ‘skipped’ and ‘xfail’. If the parameter supplied to the option is empty, filtering is suppressed and all result types are shown in the report.

The default value for this flag includes all the test results except the passed tests. Showing the passed tests by default clutters the report with too much information, so only abnormal conditions are included.


Prints the runtime context of the test suite run.

Exit Status

The report command always returns 0.

Additional exit codes may be returned as described in kyua(1).

See Also

kyua(1), kyua-report-html(1), kyua-report-junit(1)

Referenced By

kyua(1), kyua-report-html(1), kyua-report-junit(1), kyua-results-files(7), kyua-test(1).

July 28, 2014