.\" Copyright 2012 Google Inc.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions are
.\" met:
.\"
.\" * Redistributions of source code must retain the above copyright
.\"   notice, this list of conditions and the following disclaimer.
.\" * Redistributions in binary form must reproduce the above copyright
.\"   notice, this list of conditions and the following disclaimer in the
.\"   documentation and/or other materials provided with the distribution.
.\" * Neither the name of Google Inc. nor the names of its contributors
.\"   may be used to endorse or promote products derived from this software
.\"   without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.Dd September 9, 2012
.Dt KYUA-REPORT 1
.Os
.Sh NAME
.Nm report
.Nd Generates a plain-text report with the results of a test action
.Sh SYNOPSIS
.Nm
.Op Fl -action Ar id
.Op Fl -output Ar path
.Op Fl -results-filter Ar types
.Op Fl -show-context
.Op Fl -store Ar file
.Sh DESCRIPTION
The
.Nm
command provides the mechanism to generate user-friendly, plain-text
reports of the execution of a test suite.  The command processes an action
stored in the database and then creates a textual summary of the test case
results recorded in that action.  These reports are not intended to be
machine-parseable.
.Pp
The following subcommand options are recognized:
.Bl -tag -width XX
.It Fl -action Ar id
Specifies the action for which to generate a report.  If not provided,
defaults to the latest action stored in the database.
.It Fl -output Ar path
Specifies the path to which the report should be written to.  The special
values
.Pa /dev/stdout
and
.Pa /dev/stderr
can be used to specify the standard output and the standard error
respectively.
.It Fl -results-filter Ar 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.
.Pp
The valid values are:
.Sq broken ,
.Sq failed ,
.Sq passed ,
.Sq skipped
and
.Sq xfail .
If the parameter supplied to the option is empty, filtering is suppressed
and all result types are shown in the report.
.Pp
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.
.It Fl -show-context
Prints the runtime context of the action.
.It Fl -store Ar path , Fl s Ar path
Specifies the database to use.  Defaults to
.Pa ~/.kyua/store.db .
The database is created if it does not exist.
.El
.Sh EXIT STATUS
The
.Nm
command always returns 0.
.Pp
Additional exit codes may be returned as described in
.Xr kyua 1 .
.Sh SEE ALSO
.Xr kyua 1 ,
.Xr kyua-report-html 1