.\" 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 December 26, 2012
.Dt KYUA-TESTER-RESULT 1
.Os
.Sh NAME
.Nm kyua-tester-result
.Nd Result files created by the Kyua testers
.Sh SYNOPSIS
.Bd -literal
result_type[: result_reason]
.Ed
.Sh DESCRIPTION
The
.Sq test
subcommand of the various Kyua testers creates a file describing the result of
the execution of a single test case.
.Pp
The result file contains the type of the result and, optionally, a textual
description explaining what caused the given result.  The description is
separated from the type by a colon-space character pair.
.Pp
The result type may be any of the following:
.Bl -tag -width expectedXfailureXX
.It broken
The test case did not follow the conventions of the test interface correctly and
therefore it is considered to be broken.  This includes a test case timing out.
.It expected_failure
The test case raised an error but such error was expected.  The tester will
repor the test as passed.
.It failed
The test case raised an error.
.It passed
The test case passed successfully.
.It skipped
The test case was not executed because some preconditions were not met.  This is
considered as a successful result.
.El
.Sh SEE ALSO
.Xr kyua-atf-tester 1 ,
.Xr kyua-plain-tester 1