82 lines
3.1 KiB
Groff
82 lines
3.1 KiB
Groff
|
.\" 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-HTML 1
|
||
|
.Os
|
||
|
.Sh NAME
|
||
|
.Nm report-html
|
||
|
.Nd Generates an HTML report with the results of a test action
|
||
|
.Sh SYNOPSIS
|
||
|
.Nm
|
||
|
.Op Fl -action Ar id
|
||
|
.Op Fl -force
|
||
|
.Op Fl -output Ar path
|
||
|
.Op Fl -store Ar file
|
||
|
.Sh DESCRIPTION
|
||
|
The
|
||
|
.Nm
|
||
|
command provides a simple mechanism to generate HTML reports of the
|
||
|
execution of a test suite. The command processes an action stored in the
|
||
|
database and then populates a directory with multiple HTML and supporting
|
||
|
files to describe the results recorded in that action.
|
||
|
.Pp
|
||
|
The HTML output is static and self-contained, so it can easily be served by
|
||
|
any simple web server. The command expects the target directory to not
|
||
|
exist, because it would overwrite any contents if not careful.
|
||
|
.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 -force
|
||
|
Forces the deletion of the output directory if it exists. Use care, as
|
||
|
this effectively means a
|
||
|
.Sq rm -rf .
|
||
|
.It Fl -output Ar directory
|
||
|
Specifies the target directory into which to generate the HTML files. The
|
||
|
directory must not exist unless the
|
||
|
.Fl -force
|
||
|
option is provided. The default is
|
||
|
.Pa ./html .
|
||
|
.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 1
|