contrib/atf/doc/atf-test-program.1

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2007 The NetBSD Foundation, Inc.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd February 6, 2011
  30 .Dt ATF-TEST-PROGRAM 1
  31 .Os
  32 .Sh NAME
  33 .Nm atf-test-program
  34 .Nd common interface to ATF test programs
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl r Ar resfile
  38 .Op Fl s Ar srcdir
  39 .Op Fl v Ar var1=value1 Op .. Fl v Ar varN=valueN
  40 .Ar test_case
  41 .Nm
  42 .Fl l
  43 .Sh DESCRIPTION
  44 Test programs written using the ATF libraries all share a common user
  45 interface, which is what this manual page describes.
  46 .Em NOTE: There is no binary known as
  47 .Nm ;
  48 .Em what is described in this manual page is the command-line interface
  49 .Em exposed by the atf-c, atf-c++ and atf-sh bindings .
  50 .Pp
  51 In the first synopsis form, the test program will execute the provided
  52 test case and print its results to the standard output, unless otherwise
  53 stated by the
  54 .Fl r
  55 flag.
  56 Optionally, the test case name can be suffixed by
  57 .Sq :cleanup ,
  58 in which case the cleanup routine of the test case will be executed
  59 instead of the test case body; see
  60 .Xr atf-test-case 4 .
  61 Note that the test case is
  62 .Em executed without isolation ,
  63 so it can and probably will create and modify files in the current directory.
  64 To execute test cases in a controller manner, refer to
  65 .Xr atf-run 1 ,
  66 which is the preferred way to run test cases.
  67 You should only execute test cases by hand for debugging purposes.
  68 .Pp
  69 In the second synopsis form, the test program will list all available
  70 test cases alongside their meta-data properties in a format that is
  71 machine parseable.
  72 This list is processed by
  73 .Xr atf-run 1
  74 to know how to execute the test cases of a given test program.
  75 .Pp
  76 The following options are available:
  77 .Bl -tag -width XvXvarXvalueXX
  78 .It Fl l
  79 Lists available test cases alongside a brief description for each of them.
  80 .It Fl r Ar resfile
  81 Specifies the file that will receive the test case result.
  82 If not specified, the test case prints its results to stdout.
  83 If the result of a test case needs to be parsed by another program, you must
  84 use this option to redirect the result to a file and then read the resulting
  85 file from the other program.
  86 Note:
  87 .Em do not try to process the stdout of the test case
  88 because your program may break in the future.
  89 .It Fl s Ar srcdir
  90 The path to the directory where the test program is located.
  91 This is needed in all cases, except when the test program is being executed
  92 from the current directory.
  93 The test program will use this path to locate any helper data files or
  94 utilities.
  95 .It Fl v Ar var=value
  96 Sets the configuration variable
  97 .Ar var
  98 to the value
  99 .Ar value .
 100 .El
 101 .Sh SEE ALSO
 102 .Xr atf-run 1 ,
 103 .Xr atf 7