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 April 15, 2013 29.Dt KYUA-REPORT-HTML 1 30.Os 31.Sh NAME 32.Nm report-html 33.Nd Generates an HTML report with the results of a test action 34.Sh SYNOPSIS 35.Nm 36.Op Fl -action Ar id 37.Op Fl -force 38.Op Fl -output Ar path 39.Op Fl -results-filter Ar types 40.Op Fl -store Ar file 41.Sh DESCRIPTION 42The 43.Nm 44command provides a simple mechanism to generate HTML reports of the 45execution of a test suite. The command processes an action stored in the 46database and then populates a directory with multiple HTML and supporting 47files to describe the results recorded in that action. 48.Pp 49The HTML output is static and self-contained, so it can easily be served by 50any simple web server. The command expects the target directory to not 51exist, because it would overwrite any contents if not careful. 52.Pp 53The following subcommand options are recognized: 54.Bl -tag -width XX 55.It Fl -action Ar id 56Specifies the action for which to generate a report. If not provided, 57defaults to the latest action stored in the database. 58.It Fl -force 59Forces the deletion of the output directory if it exists. Use care, as 60this effectively means a 61.Sq rm -rf . 62.It Fl -output Ar directory 63Specifies the target directory into which to generate the HTML files. The 64directory must not exist unless the 65.Fl -force 66option is provided. The default is 67.Pa ./html . 68.It Fl -results-filter Ar types 69Comma-separated list of the test result types to include in the report. 70The ordering of the values is respected so that you can determine how you 71want the list of tests to be shown. 72.Pp 73The valid values are: 74.Sq broken , 75.Sq failed , 76.Sq passed , 77.Sq skipped 78and 79.Sq xfail . 80If the parameter supplied to the option is empty, filtering is suppressed 81and all result types are shown in the report. 82.Pp 83The default value for this flag includes all the test results except the 84passed tests. Showing the passed tests by default clutters the report with 85too much information, so only abnormal conditions are included. 86.It Fl -store Ar path , Fl s Ar path 87Specifies the database to use. Defaults to 88.Pa ~/.kyua/store.db . 89The database is created if it does not exist. 90.El 91.Sh EXIT STATUS 92The 93.Nm 94command always returns 0. 95.Pp 96Additional exit codes may be returned as described in 97.Xr kyua 1 . 98.Sh SEE ALSO 99.Xr kyua 1 , 100.Xr kyua-report 1 101