contrib/atf/doc/atf-test-case.4

   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 March 2, 2014
  30 .Dt ATF-TEST-CASE 4
  31 .Os
  32 .Sh NAME
  33 .Nm atf-test-case
  34 .Nd generic description of test cases
  35 .Sh DESCRIPTION
  36 A
  37 .Em test case
  38 is a piece of code that stress-tests a specific feature of the software.
  39 This feature is typically self-contained enough, either in the amount of
  40 code that implements it or in the general idea that describes it, to
  41 warrant its independent testing.
  42 Given this, test cases are very fine-grained, but they attempt to group
  43 similar smaller tests which are semantically related.
  44 .Pp
  45 A test case is defined by three components regardless of the language it is
  46 implemented in: a header, a body and a cleanup routine.
  47 The
  48 .Em header
  49 is, basically, a declarative piece of code that defines several
  50 properties to describe what the test case does and how it behaves.
  51 In other words: it defines the test case's
  52 .Em meta-data ,
  53 further described in the
  54 .Sx Meta-data
  55 section.
  56 The
  57 .Em body
  58 is the test case itself.
  59 It executes all actions needed to reproduce the test, and checks for
  60 failures.
  61 This body is only executed if the abstract conditions specified by the
  62 header are met.
  63 The
  64 .Em cleanup
  65 routine is a piece of code always executed after the body, regardless of
  66 the exit status of the test case.
  67 It can be used to undo side-effects of the test case.
  68 Note that almost all side-effects of a test case are automatically cleaned
  69 up by the library; this is explained in more detail in the rest of this
  70 document.
  71 .Pp
  72 It is extremely important to keep the separation between a test case's
  73 header and body well-defined, because the header is
  74 .Em always
  75 parsed, whereas the body is only executed when the conditions defined in
  76 the header are met and when the user specifies that test case.
  77 .Pp
  78 At last, test cases are always contained into test programs.
  79 The test programs act as a front-end to them, providing a consistent
  80 interface to the user and several APIs to ease their implementation.
  81 .Ss Results
  82 Upon termination, a test case reports a status and, optionally, a textual
  83 reason describing why the test reported such status.
  84 The caller must ensure that the test case really performed the task that its
  85 status describes, as the test program may be bogus and therefore providing a
  86 misleading result (e.g. providing a result that indicates success but the
  87 error code of the program says otherwise).
  88 .Pp
  89 The possible exit status of a test case are one of the following:
  90 .Bl -tag -width expectedXfailureXX
  91 .It expected_death
  92 The test case expects to terminate abruptly.
  93 .It expected_exit
  94 The test case expects to exit cleanly.
  95 .It expected_failure
  96 The test case expects to exit with a controller fatal/non-fatal failure.
  97 If this happens, the test program exits with a success error code.
  98 .It expected_signal
  99 The test case expects to receive a signal that makes it terminate.
 100 .It expected_timeout
 101 The test case expects to execute for longer than its timeout.
 102 .It passed
 103 The test case was executed successfully.
 104 The test program exits with a success error code.
 105 .It skipped
 106 The test case could not be executed because some preconditions were not
 107 met.
 108 This is not a failure because it can typically be resolved by adjusting
 109 the system to meet the necessary conditions.
 110 This is always accompanied by a
 111 .Em reason ,
 112 a message describing why the test was skipped.
 113 The test program exits with a success error code.
 114 .It failed
 115 An error appeared during the execution of the test case.
 116 This is always accompanied by a
 117 .Em reason ,
 118 a message describing why the test failed.
 119 The test program exits with a failure error code.
 120 .El
 121 .Pp
 122 The usefulness of the
 123 .Sq expected_*
 124 results comes when writing test cases that verify known failures caused,
 125 in general, due to programming errors (aka bugs).
 126 Whenever the faulty condition that the
 127 .Sq expected_*
 128 result is trying to cover is fixed, then the test case will be reported as
 129 .Sq failed
 130 and the developer will have to adjust it to match its new condition.
 131 .Pp
 132 It is important to note that all
 133 .Sq expected_*
 134 results are only provided as a
 135 .Em hint
 136 to the caller; the caller must verify that the test case did actually terminate
 137 as the expected condition says.
 138 .Ss Input/output
 139 Test cases are free to print whatever they want to their
 140 .Xr stdout 4
 141 and
 142 .Xr stderr 4
 143 file descriptors.
 144 They are, in fact, encouraged to print status information as they execute
 145 to keep the user informed of their actions.
 146 This is specially important for long test cases.
 147 .Pp
 148 Test cases will log their results to an auxiliary file, which is then
 149 collected by the test program they are contained in.
 150 The developer need not care about this as long as he uses the correct
 151 APIs to implement the test cases.
 152 .Pp
 153 The standard input of the test cases is unconditionally connected to
 154 .Sq /dev/zero .
 155 .Ss Meta-data
 156 The following list describes all meta-data properties interpreted
 157 internally by ATF.
 158 You are free to define new properties in your test cases and use them as
 159 you wish, but non-standard properties must be prefixed by
 160 .Sq X- .
 161 .Bl -tag -width requireXmachineXX
 162 .It descr
 163 Type: textual.
 164 Required.
 165 .Pp
 166 A brief textual description of the test case's purpose.
 167 Will be shown to the user in reports.
 168 Also good for documentation purposes.
 169 .It has.cleanup
 170 Type: boolean.
 171 Optional.
 172 .Pp
 173 If set to true, specifies that the test case has a cleanup routine that has
 174 to be executed by the runtime engine during the cleanup phase of the execution.
 175 This property is automatically set by the framework when defining a test case
 176 with a cleanup routine, so it should never be set by hand.
 177 .It ident
 178 Type: textual.
 179 Required.
 180 .Pp
 181 The test case's identifier.
 182 Must be unique inside the test program and should be short but descriptive.
 183 .It require.arch
 184 Type: textual.
 185 Optional.
 186 .Pp
 187 A whitespace separated list of architectures that the test case can be run
 188 under without causing errors due to an architecture mismatch.
 189 .It require.config
 190 Type: textual.
 191 Optional.
 192 .Pp
 193 A whitespace separated list of configuration variables that must be defined
 194 to execute the test case.
 195 If any of the required variables is not defined, the test case is
 196 .Em skipped .
 197 .It require.files
 198 Type: textual.
 199 Optional.
 200 .Pp
 201 A whitespace separated list of files that must be present to execute the
 202 test case.
 203 The names of these files must be absolute paths.
 204 If any of the required files is not found, the test case is
 205 .Em skipped .
 206 .It require.machine
 207 Type: textual.
 208 Optional.
 209 .Pp
 210 A whitespace separated list of machine types that the test case can be run
 211 under without causing errors due to a machine type mismatch.
 212 .It require.memory
 213 Type: integer.
 214 Optional.
 215 Specifies the minimum amount of physical memory needed by the test.
 216 The value can have a size suffix such as
 217 .Sq K ,
 218 .Sq M ,
 219 .Sq G
 220 or
 221 .Sq T
 222 to make the amount of bytes easier to type and read.
 223 .It require.progs
 224 Type: textual.
 225 Optional.
 226 .Pp
 227 A whitespace separated list of programs that must be present to execute
 228 the test case.
 229 These can be given as plain names, in which case they are looked in the
 230 user's
 231 .Ev PATH ,
 232 or as absolute paths.
 233 If any of the required programs is not found, the test case is
 234 .Em skipped .
 235 .It require.user
 236 Type: textual.
 237 Optional.
 238 .Pp
 239 The required privileges to execute the test case.
 240 Can be one of
 241 .Sq root
 242 or
 243 .Sq unprivileged .
 244 .Pp
 245 If the test case is running as a regular user and this property is
 246 .Sq root ,
 247 the test case is
 248 .Em skipped .
 249 .Pp
 250 If the test case is running as root and this property is
 251 .Sq unprivileged ,
 252 the runtime engine will automatically drop the privileges if the
 253 .Sq unprivileged-user
 254 configuration property is set; otherwise the test case is
 255 .Em skipped .
 256 .It timeout
 257 Type: integral.
 258 Optional; defaults to
 259 .Sq 300 .
 260 .Pp
 261 Specifies the maximum amount of time the test case can run.
 262 This is particularly useful because some tests can stall either because they
 263 are incorrectly coded or because they trigger an anomalous behavior of the
 264 program.
 265 It is not acceptable for these tests to stall the whole execution of the
 266 test program.
 267 .Pp
 268 Can optionally be set to zero, in which case the test case has no run-time
 269 limit.
 270 This is discouraged.
 271 .El
 272 .Ss Environment
 273 Every time a test case is executed, several environment variables are
 274 cleared or reseted to sane values to ensure they do not make the test fail
 275 due to unexpected conditions.
 276 These variables are:
 277 .Bl -tag -width LCXMESSAGESXX
 278 .It Ev HOME
 279 Set to the work directory's path.
 280 .It Ev LANG
 281 Undefined.
 282 .It Ev LC_ALL
 283 Undefined.
 284 .It Ev LC_COLLATE
 285 Undefined.
 286 .It Ev LC_CTYPE
 287 Undefined.
 288 .It Ev LC_MESSAGES
 289 Undefined.
 290 .It Ev LC_MONETARY
 291 Undefined.
 292 .It Ev LC_NUMERIC
 293 Undefined.
 294 .It Ev LC_TIME
 295 Undefined.
 296 .It Ev TZ
 297 Hardcoded to
 298 .Sq UTC .
 299 .El
 300 .Ss Work directories
 301 The test program always creates a temporary directory
 302 and switches to it before running the test case's body.
 303 This way the test case is free to modify its current directory as it
 304 wishes, and the runtime engine will be able to clean it up later on in a
 305 safe way, removing any traces of its execution from the system.
 306 To do so, the runtime engine will perform a recursive removal of the work
 307 directory without crossing mount points; if a mount point is found, the
 308 file system will be unmounted (if possible).
 309 .Ss File creation mode mask (umask)
 310 Test cases are always executed with a file creation mode mask (umask) of
 311 .Sq 0022 .
 312 The test case's code is free to change this during execution.
 313 .Sh SEE ALSO
 314 .Xr atf-test-program 1