external/bsd/kyua-testers/dist/kyua-tester-result.5

   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 December 26, 2012
  29 .Dt KYUA-TESTER-RESULT 1
  30 .Os
  31 .Sh NAME
  32 .Nm kyua-tester-result
  33 .Nd Result files created by the Kyua testers
  34 .Sh SYNOPSIS
  35 .Bd -literal
  36 result_type[: result_reason]
  37 .Ed
  38 .Sh DESCRIPTION
  39 The
  40 .Sq test
  41 subcommand of the various Kyua testers creates a file describing the result of
  42 the execution of a single test case.
  43 .Pp
  44 The result file contains the type of the result and, optionally, a textual
  45 description explaining what caused the given result.  The description is
  46 separated from the type by a colon-space character pair.
  47 .Pp
  48 The result type may be any of the following:
  49 .Bl -tag -width expectedXfailureXX
  50 .It broken
  51 The test case did not follow the conventions of the test interface correctly and
  52 therefore it is considered to be broken.  This includes a test case timing out.
  53 .It expected_failure
  54 The test case raised an error but such error was expected.  The tester will
  55 repor the test as passed.
  56 .It failed
  57 The test case raised an error.
  58 .It passed
  59 The test case passed successfully.
  60 .It skipped
  61 The test case was not executed because some preconditions were not met.  This is
  62 considered as a successful result.
  63 .El
  64 .Sh SEE ALSO
  65 .Xr kyua-atf-tester 1 ,
  66 .Xr kyua-plain-tester 1