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