external/bsd/kyua-testers/dist/kyua-plain-interface.7

   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 September 9, 2012
  29 .Dt KYUA-PLAIN-INTERFACE 1
  30 .Os
  31 .Sh NAME
  32 .Nm plain-interface
  33 .Nd Description of the plain test program interface
  34 .Sh DESCRIPTION
  35 The
  36 .Em plain test interface
  37 is the interface of test programs that return their pass/fail status as an
  38 exit code.  While simple, this interface is what legacy test programs use
  39 and what test programs written with many other testing libraries use too.
  40 .Pp
  41 Kyua supports this interface for two main reasons: first, to simplify the
  42 incorporation of legacy test programs into a Kyua test suite; and, second,
  43 to ensure that the Kyua run-time engine does not become tied to a
  44 particular test interface.
  45 .Pp
  46 The results of a plain test are one of the following:
  47 .Bl -tag -width passedXX
  48 .It passed
  49 If the test program exits with a success exit code; i.e. 0.
  50 .It failed
  51 If the test program exits with a failure exit code; i.e. not 0.
  52 .It broken
  53 If the test program exits due to any other reason (e.g. it crashes) or
  54 if it fails to be executed.
  55 .El
  56 .Pp
  57 Plain test programs are executed with the same isolation features as
  58 ATF test programs; see
  59 .Xr kyua-atf-interface 7 .
  60 .Sh SEE ALSO
  61 .Xr kyua-test 1 ,
  62 .Xr kyuafile 5 ,
  63 .Xr kyua-atf-interface 7