xref: /minix3/external/bsd/kyua-testers/dist/kyua-plain-interface.7 (revision 11be35a165022172ed3cea20f2b5df0307540b0e)
1*11be35a1SLionel Sambuc.\" Copyright 2012 Google Inc.
2*11be35a1SLionel Sambuc.\" All rights reserved.
3*11be35a1SLionel Sambuc.\"
4*11be35a1SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
5*11be35a1SLionel Sambuc.\" modification, are permitted provided that the following conditions are
6*11be35a1SLionel Sambuc.\" met:
7*11be35a1SLionel Sambuc.\"
8*11be35a1SLionel Sambuc.\" * Redistributions of source code must retain the above copyright
9*11be35a1SLionel Sambuc.\"   notice, this list of conditions and the following disclaimer.
10*11be35a1SLionel Sambuc.\" * Redistributions in binary form must reproduce the above copyright
11*11be35a1SLionel Sambuc.\"   notice, this list of conditions and the following disclaimer in the
12*11be35a1SLionel Sambuc.\"   documentation and/or other materials provided with the distribution.
13*11be35a1SLionel Sambuc.\" * Neither the name of Google Inc. nor the names of its contributors
14*11be35a1SLionel Sambuc.\"   may be used to endorse or promote products derived from this software
15*11be35a1SLionel Sambuc.\"   without specific prior written permission.
16*11be35a1SLionel Sambuc.\"
17*11be35a1SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*11be35a1SLionel Sambuc.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*11be35a1SLionel Sambuc.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*11be35a1SLionel Sambuc.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*11be35a1SLionel Sambuc.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*11be35a1SLionel Sambuc.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*11be35a1SLionel Sambuc.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*11be35a1SLionel Sambuc.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*11be35a1SLionel Sambuc.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*11be35a1SLionel Sambuc.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*11be35a1SLionel Sambuc.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*11be35a1SLionel Sambuc.Dd September 9, 2012
29*11be35a1SLionel Sambuc.Dt KYUA-PLAIN-INTERFACE 1
30*11be35a1SLionel Sambuc.Os
31*11be35a1SLionel Sambuc.Sh NAME
32*11be35a1SLionel Sambuc.Nm plain-interface
33*11be35a1SLionel Sambuc.Nd Description of the plain test program interface
34*11be35a1SLionel Sambuc.Sh DESCRIPTION
35*11be35a1SLionel SambucThe
36*11be35a1SLionel Sambuc.Em plain test interface
37*11be35a1SLionel Sambucis the interface of test programs that return their pass/fail status as an
38*11be35a1SLionel Sambucexit code.  While simple, this interface is what legacy test programs use
39*11be35a1SLionel Sambucand what test programs written with many other testing libraries use too.
40*11be35a1SLionel Sambuc.Pp
41*11be35a1SLionel SambucKyua supports this interface for two main reasons: first, to simplify the
42*11be35a1SLionel Sambucincorporation of legacy test programs into a Kyua test suite; and, second,
43*11be35a1SLionel Sambucto ensure that the Kyua run-time engine does not become tied to a
44*11be35a1SLionel Sambucparticular test interface.
45*11be35a1SLionel Sambuc.Pp
46*11be35a1SLionel SambucThe results of a plain test are one of the following:
47*11be35a1SLionel Sambuc.Bl -tag -width passedXX
48*11be35a1SLionel Sambuc.It passed
49*11be35a1SLionel SambucIf the test program exits with a success exit code; i.e. 0.
50*11be35a1SLionel Sambuc.It failed
51*11be35a1SLionel SambucIf the test program exits with a failure exit code; i.e. not 0.
52*11be35a1SLionel Sambuc.It broken
53*11be35a1SLionel SambucIf the test program exits due to any other reason (e.g. it crashes) or
54*11be35a1SLionel Sambucif it fails to be executed.
55*11be35a1SLionel Sambuc.El
56*11be35a1SLionel Sambuc.Pp
57*11be35a1SLionel SambucPlain test programs are executed with the same isolation features as
58*11be35a1SLionel SambucATF test programs; see
59*11be35a1SLionel Sambuc.Xr kyua-atf-interface 7 .
60*11be35a1SLionel Sambuc.Sh SEE ALSO
61*11be35a1SLionel Sambuc.Xr kyua-test 1 ,
62*11be35a1SLionel Sambuc.Xr kyuafile 5 ,
63*11be35a1SLionel Sambuc.Xr kyua-atf-interface 7
64