1.\" Copyright 2012 Google Inc. 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions are 6.\" met: 7.\" 8.\" * Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" * Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" * Neither the name of Google Inc. nor the names of its contributors 14.\" may be used to endorse or promote products derived from this software 15.\" without specific prior written permission. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28.Dd September 9, 2012 29.Dt KYUA-REPORT 1 30.Os 31.Sh NAME 32.Nm report 33.Nd Generates a plain-text report with the results of a test action 34.Sh SYNOPSIS 35.Nm 36.Op Fl -action Ar id 37.Op Fl -output Ar path 38.Op Fl -results-filter Ar types 39.Op Fl -show-context 40.Op Fl -store Ar file 41.Sh DESCRIPTION 42The 43.Nm 44command provides the mechanism to generate user-friendly, plain-text 45reports of the execution of a test suite. The command processes an action 46stored in the database and then creates a textual summary of the test case 47results recorded in that action. These reports are not intended to be 48machine-parseable. 49.Pp 50The following subcommand options are recognized: 51.Bl -tag -width XX 52.It Fl -action Ar id 53Specifies the action for which to generate a report. If not provided, 54defaults to the latest action stored in the database. 55.It Fl -output Ar path 56Specifies the path to which the report should be written to. The special 57values 58.Pa /dev/stdout 59and 60.Pa /dev/stderr 61can be used to specify the standard output and the standard error 62respectively. 63.It Fl -results-filter Ar types 64Comma-separated list of the test result types to include in the report. 65The ordering of the values is respected so that you can determine how you 66want the list of tests to be shown. 67.Pp 68The valid values are: 69.Sq broken , 70.Sq failed , 71.Sq passed , 72.Sq skipped 73and 74.Sq xfail . 75If the parameter supplied to the option is empty, filtering is suppressed 76and all result types are shown in the report. 77.Pp 78The default value for this flag includes all the test results except the 79passed tests. Showing the passed tests by default clutters the report with 80too much information, so only abnormal conditions are included. 81.It Fl -show-context 82Prints the runtime context of the action. 83.It Fl -store Ar path , Fl s Ar path 84Specifies the database to use. Defaults to 85.Pa ~/.kyua/store.db . 86The database is created if it does not exist. 87.El 88.Sh EXIT STATUS 89The 90.Nm 91command always returns 0. 92.Pp 93Additional exit codes may be returned as described in 94.Xr kyua 1 . 95.Sh SEE ALSO 96.Xr kyua 1 , 97.Xr kyua-report-html 1 98