external/bsd/atf/dist/tools/atf-check.1

   1 .\"
   2 .\" Automated Testing Framework (atf)
   3 .\"
   4 .\" Copyright (c) 2008 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 May 9, 2008
  30 .Dt ATF-CHECK 1
  31 .Os
  32 .Sh NAME
  33 .Nm atf-check
  34 .Nd executes a command and analyzes its results
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl s Ar qual:value
  38 .Op Fl o Ar action:arg
  39 .Op Fl e Ar action:arg
  40 .Ar command
  41 .Nm
  42 .Fl h
  43 .Sh DESCRIPTION
  44 .Nm
  45 executes a given command and analyzes its results, including
  46 exit code, stdout and stderr.
  47 .Pp
  48 In the first synopsis form,
  49 .Nm
  50 will execute the provided command and apply checks specified
  51 by arguments.
  52 By default it will act as if it was run with
  53 .Fl s
  54 .Ar eq:0
  55 .Fl o
  56 .Ar empty
  57 .Fl e
  58 .Ar empty
  59 .Pp
  60 In the second synopsis form,
  61 .Nm
  62 will print information about all supported options and their purpose.
  63 .Pp
  64 The following options are available:
  65 .Bl -tag  -width XqualXvalueXX
  66 .It Fl h
  67 Shows a short summary of all available options and their purpose.
  68 .It Fl s Ar qual:value
  69 Analyzes exit code.
  70 Must be one of:
  71 .Bl -tag -width eq:XvalueX -compact
  72 .It Ar ignore
  73 ignores exit status
  74 .It Ar eq: Ns Aq value
  75 checks that exit status is equal to value
  76 .It Ar ne: Ns Aq value
  77 checks that exit status is other than value
  78 .El
  79 .It Fl o Ar action:arg
  80 Analyzes standard output.
  81 Must be one of:
  82 .Bl -tag -width inline:XvalueX -compact
  83 .It Ar empty
  84 checks that stdout is empty
  85 .It Ar ignore
  86 ignores stdout
  87 .It Ar file: Ns Aq path
  88 compares stdout with given file
  89 .It Ar inline: Ns Aq value
  90 compares stdout with inline value
  91 .It Ar save: Ns Aq path
  92 saves stdout to given file
  93 .El
  94 .It Fl e Ar action:arg
  95 Analyzes standard error (syntax identical to above)
  96 .El
  97 .Sh EXIT STATUS
  98 .Nm
  99 exits 0 on success, and other (unspecified) value on failure.
 100 .Sh EXAMPLES
 101 .Bd -literal -offset indent
 102 # Exit code 0, nothing on stdout/stderr
 103 atf-check 'true' || atf_fail
 104
 105 # Typical usage if failure is expected
 106 atf-check -s ne:0 'false' || atf_fail
 107
 108 # Checking stdout/stderr
 109 echo foobar \*[Gt]expout
 110 atf-check -o file:expout -e inline:"xx\\tyy\\n" \\
 111     'echo foobar ; printf "xx\\tyy\\n" \*[Gt]\*[Aq]2' || atf_fail
 112 .Ed
 113 .Sh SEE ALSO
 114 .Xr atf 7