contrib/atf/atf-sh/atf-check.1

   1 .\" Copyright (c) 2008 The NetBSD Foundation, 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
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  14 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  15 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  16 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  18 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  20 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  22 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  24 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .Dd March 6, 2017
  26 .Dt ATF-CHECK 1
  27 .Os
  28 .Sh NAME
  29 .Nm atf-check
  30 .Nd executes a command and analyzes its results
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl s Ar qual:value
  34 .Op Fl o Ar action:arg ...
  35 .Op Fl e Ar action:arg ...
  36 .Op Fl x
  37 .Ar command
  38 .Sh DESCRIPTION
  39 .Nm
  40 executes a given command and analyzes its results, including
  41 exit code, stdout and stderr.
  42 .Pp
  43 .Bf Em
  44 Test cases must use
  45 .Xr atf-sh 3 Ns ' Ns s
  46 .Nm atf_check
  47 builtin function instead of calling this utility directly.
  48 .Ef
  49 .Pp
  50 In the first synopsis form,
  51 .Nm
  52 will execute the provided command and apply checks specified
  53 by arguments.
  54 By default it will act as if it was run with
  55 .Fl s
  56 .Ar exit:0
  57 .Fl o
  58 .Ar empty
  59 .Fl e
  60 .Ar empty .
  61 Multiple checks for the same output channel are allowed and, if specified,
  62 their results will be combined as a logical and (meaning that the output must
  63 match all the provided checks).
  64 .Pp
  65 In the second synopsis form,
  66 .Nm
  67 will print information about all supported options and their purpose.
  68 .Pp
  69 The following options are available:
  70 .Bl -tag  -width XqualXvalueXX
  71 .It Fl s Ar qual:value
  72 Analyzes termination status.
  73 Must be one of:
  74 .Bl -tag -width signal:<value> -compact
  75 .It Ar exit:<value>
  76 checks that the program exited cleanly and that its exit status is equal to
  77 .Va value .
  78 The exit code can be omitted altogether, in which case any clean exit is
  79 accepted.
  80 .It Ar ignore
  81 ignores the exit check.
  82 .It Ar signal:<value>
  83 checks that the program exited due to a signal and that the signal that
  84 terminated it is
  85 .Va value .
  86 The signal can be specified both as a number or as a name, or it can also
  87 be omitted altogether, in which case any signal is accepted.
  88 .El
  89 .Pp
  90 Most of these checkers can be prefixed by the
  91 .Sq not-
  92 string, which effectively reverses the check.
  93 .It Fl o Ar action:arg
  94 Analyzes standard output.
  95 Must be one of:
  96 .Bl -tag -width inline:<value> -compact
  97 .It Ar empty
  98 checks that stdout is empty
  99 .It Ar ignore
 100 ignores stdout
 101 .It Ar file:<path>
 102 compares stdout with given file
 103 .It Ar inline:<value>
 104 compares stdout with inline value
 105 .It Ar match:<regexp>
 106 looks for a regular expression in stdout
 107 .It Ar save:<path>
 108 saves stdout to given file
 109 .El
 110 .Pp
 111 Most of these checkers can be prefixed by the
 112 .Sq not-
 113 string, which effectively reverses the check.
 114 .It Fl e Ar action:arg
 115 Analyzes standard error (syntax identical to above)
 116 .It Fl x
 117 Executes
 118 .Ar command
 119 as a shell command line, executing it with the system shell defined by
 120 .Va ATF_SHELL .
 121 You should avoid using this flag if at all possible to prevent shell quoting
 122 issues.
 123 .El
 124 .Sh ENVIRONMENT
 125 .Bl -tag -width ATFXSHELLXX -compact
 126 .It Va ATF_SHELL
 127 Path to the system shell to be used when the
 128 .Fl x
 129 is given to run commands.
 130 .El
 131 .Sh EXIT STATUS
 132 .Nm
 133 exits 0 on success, and other (unspecified) value on failure.
 134 .Sh EXAMPLES
 135 The following are sample invocations from within a test case.
 136 Note that we use the
 137 .Nm atf_check
 138 function provided by
 139 .Xr atf-sh 3
 140 instead of executing
 141 .Nm
 142 directly:
 143 .Bd -literal -offset indent
 144 # Exit code 0, nothing on stdout/stderr
 145 atf_check 'true'
 146
 147 # Typical usage if failure is expected
 148 atf_check -s not-exit:0 'false'
 149
 150 # Checking stdout/stderr
 151 echo foobar >expout
 152 atf_check -o file:expout -e inline:"xx\etyy\en" \e
 153     'echo foobar ; printf "xx\etyy\en" >&2'
 154
 155 # Checking for a crash
 156 atf_check -s signal:sigsegv my_program
 157
 158 # Combined checks
 159 atf_check -o match:foo -o not-match:bar echo foo baz
 160 .Ed
 161 .Sh SEE ALSO
 162 .Xr atf-sh 1