contrib/atf/atf-c/atf-c-api.3

   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 March 2, 2014
  30 .Dt ATF-C-API 3
  31 .Os
  32 .Sh NAME
  33 .Nm atf-c-api ,
  34 .Nm ATF_CHECK ,
  35 .Nm ATF_CHECK_MSG ,
  36 .Nm ATF_CHECK_EQ ,
  37 .Nm ATF_CHECK_EQ_MSG ,
  38 .Nm ATF_CHECK_MATCH ,
  39 .Nm ATF_CHECK_MATCH_MSG ,
  40 .Nm ATF_CHECK_STREQ ,
  41 .Nm ATF_CHECK_STREQ_MSG ,
  42 .Nm ATF_CHECK_ERRNO ,
  43 .Nm ATF_REQUIRE ,
  44 .Nm ATF_REQUIRE_MSG ,
  45 .Nm ATF_REQUIRE_EQ ,
  46 .Nm ATF_REQUIRE_EQ_MSG ,
  47 .Nm ATF_REQUIRE_MATCH ,
  48 .Nm ATF_REQUIRE_MATCH_MSG ,
  49 .Nm ATF_REQUIRE_STREQ ,
  50 .Nm ATF_REQUIRE_STREQ_MSG ,
  51 .Nm ATF_REQUIRE_ERRNO ,
  52 .Nm ATF_TC ,
  53 .Nm ATF_TC_BODY ,
  54 .Nm ATF_TC_BODY_NAME ,
  55 .Nm ATF_TC_CLEANUP ,
  56 .Nm ATF_TC_CLEANUP_NAME ,
  57 .Nm ATF_TC_HEAD ,
  58 .Nm ATF_TC_HEAD_NAME ,
  59 .Nm ATF_TC_NAME ,
  60 .Nm ATF_TC_WITH_CLEANUP ,
  61 .Nm ATF_TC_WITHOUT_HEAD ,
  62 .Nm ATF_TP_ADD_TC ,
  63 .Nm ATF_TP_ADD_TCS ,
  64 .Nm atf_tc_get_config_var ,
  65 .Nm atf_tc_get_config_var_wd ,
  66 .Nm atf_tc_get_config_var_as_bool ,
  67 .Nm atf_tc_get_config_var_as_bool_wd ,
  68 .Nm atf_tc_get_config_var_as_long ,
  69 .Nm atf_tc_get_config_var_as_long_wd ,
  70 .Nm atf_no_error ,
  71 .Nm atf_tc_expect_death ,
  72 .Nm atf_tc_expect_exit ,
  73 .Nm atf_tc_expect_fail ,
  74 .Nm atf_tc_expect_pass ,
  75 .Nm atf_tc_expect_signal ,
  76 .Nm atf_tc_expect_timeout ,
  77 .Nm atf_tc_fail ,
  78 .Nm atf_tc_fail_nonfatal ,
  79 .Nm atf_tc_pass ,
  80 .Nm atf_tc_skip ,
  81 .Nm atf_utils_cat_file ,
  82 .Nm atf_utils_compare_file ,
  83 .Nm atf_utils_copy_file ,
  84 .Nm atf_utils_create_file ,
  85 .Nm atf_utils_file_exists ,
  86 .Nm atf_utils_fork ,
  87 .Nm atf_utils_free_charpp ,
  88 .Nm atf_utils_grep_file ,
  89 .Nm atf_utils_grep_string ,
  90 .Nm atf_utils_readline ,
  91 .Nm atf_utils_redirect ,
  92 .Nm atf_utils_wait
  93 .Nd C API to write ATF-based test programs
  94 .Sh SYNOPSIS
  95 .In atf-c.h
  96 .Fn ATF_CHECK "expression"
  97 .Fn ATF_CHECK_MSG "expression" "fail_msg_fmt" ...
  98 .Fn ATF_CHECK_EQ "expression_1" "expression_2"
  99 .Fn ATF_CHECK_EQ_MSG "expression_1" "expression_2" "fail_msg_fmt" ...
 100 .Fn ATF_CHECK_MATCH "regexp" "string"
 101 .Fn ATF_CHECK_MATCH_MSG "regexp" "string" "fail_msg_fmt" ...
 102 .Fn ATF_CHECK_STREQ "string_1" "string_2"
 103 .Fn ATF_CHECK_STREQ_MSG "string_1" "string_2" "fail_msg_fmt" ...
 104 .Fn ATF_CHECK_ERRNO "exp_errno" "bool_expression"
 105 .Fn ATF_REQUIRE "expression"
 106 .Fn ATF_REQUIRE_MSG "expression" "fail_msg_fmt" ...
 107 .Fn ATF_REQUIRE_EQ "expression_1" "expression_2"
 108 .Fn ATF_REQUIRE_EQ_MSG "expression_1" "expression_2" "fail_msg_fmt" ...
 109 .Fn ATF_REQUIRE_MATCH "regexp" "string"
 110 .Fn ATF_REQUIRE_MATCH_MSG "regexp" "string" "fail_msg_fmt" ...
 111 .Fn ATF_REQUIRE_STREQ "string_1" "string_2"
 112 .Fn ATF_REQUIRE_STREQ_MSG "string_1" "string_2" "fail_msg_fmt" ...
 113 .Fn ATF_REQUIRE_ERRNO "exp_errno" "bool_expression"
 114 .Fn ATF_TC "name"
 115 .Fn ATF_TC_BODY "name" "tc"
 116 .Fn ATF_TC_BODY_NAME "name"
 117 .Fn ATF_TC_CLEANUP "name" "tc"
 118 .Fn ATF_TC_CLEANUP_NAME "name"
 119 .Fn ATF_TC_HEAD "name" "tc"
 120 .Fn ATF_TC_HEAD_NAME "name"
 121 .Fn ATF_TC_NAME "name"
 122 .Fn ATF_TC_WITH_CLEANUP "name"
 123 .Fn ATF_TC_WITHOUT_HEAD "name"
 124 .Fn ATF_TP_ADD_TC "tp_name" "tc_name"
 125 .Fn ATF_TP_ADD_TCS "tp_name"
 126 .Fn atf_tc_get_config_var "tc" "varname"
 127 .Fn atf_tc_get_config_var_wd "tc" "variable_name" "default_value"
 128 .Fn atf_tc_get_config_var_as_bool "tc" "variable_name"
 129 .Fn atf_tc_get_config_var_as_bool_wd "tc" "variable_name" "default_value"
 130 .Fn atf_tc_get_config_var_as_long "tc" "variable_name"
 131 .Fn atf_tc_get_config_var_as_long_wd "tc" "variable_name" "default_value"
 132 .Fn atf_no_error
 133 .Fn atf_tc_expect_death "reason" "..."
 134 .Fn atf_tc_expect_exit "exitcode" "reason" "..."
 135 .Fn atf_tc_expect_fail "reason" "..."
 136 .Fn atf_tc_expect_pass
 137 .Fn atf_tc_expect_signal "signo" "reason" "..."
 138 .Fn atf_tc_expect_timeout "reason" "..."
 139 .Fn atf_tc_fail "reason"
 140 .Fn atf_tc_fail_nonfatal "reason"
 141 .Fn atf_tc_pass
 142 .Fn atf_tc_skip "reason"
 143 .Ft void
 144 .Fo atf_utils_cat_file
 145 .Fa "const char *file"
 146 .Fa "const char *prefix"
 147 .Fc
 148 .Ft bool
 149 .Fo atf_utils_compare_file
 150 .Fa "const char *file"
 151 .Fa "const char *contents"
 152 .Fc
 153 .Ft void
 154 .Fo atf_utils_copy_file
 155 .Fa "const char *source"
 156 .Fa "const char *destination"
 157 .Fc
 158 .Ft void
 159 .Fo atf_utils_create_file
 160 .Fa "const char *file"
 161 .Fa "const char *contents"
 162 .Fa "..."
 163 .Fc
 164 .Ft void
 165 .Fo atf_utils_file_exists
 166 .Fa "const char *file"
 167 .Fc
 168 .Ft pid_t
 169 .Fo atf_utils_fork
 170 .Fa "void"
 171 .Fc
 172 .Ft void
 173 .Fo atf_utils_free_charpp
 174 .Fa "char **argv"
 175 .Fc
 176 .Ft bool
 177 .Fo atf_utils_grep_file
 178 .Fa "const char *regexp"
 179 .Fa "const char *file"
 180 .Fa "..."
 181 .Fc
 182 .Ft bool
 183 .Fo atf_utils_grep_string
 184 .Fa "const char *regexp"
 185 .Fa "const char *str"
 186 .Fa "..."
 187 .Fc
 188 .Ft char *
 189 .Fo atf_utils_readline
 190 .Fa "int fd"
 191 .Fc
 192 .Ft void
 193 .Fo atf_utils_redirect
 194 .Fa "const int fd"
 195 .Fa "const char *file"
 196 .Fc
 197 .Ft void
 198 .Fo atf_utils_wait
 199 .Fa "const pid_t pid"
 200 .Fa "const int expected_exit_status"
 201 .Fa "const char *expected_stdout"
 202 .Fa "const char *expected_stderr"
 203 .Fc
 204 .Sh DESCRIPTION
 205 ATF provides a C programming interface to implement test programs.
 206 C-based test programs follow this template:
 207 .Bd -literal -offset indent
 208 .Ns ... C-specific includes go here ...
 209
 210 #include <atf-c.h>
 211
 212 ATF_TC(tc1);
 213 ATF_TC_HEAD(tc1, tc)
 214 {
 215     ... first test case's header ...
 216 }
 217 ATF_TC_BODY(tc1, tc)
 218 {
 219     ... first test case's body ...
 220 }
 221
 222 ATF_TC_WITH_CLEANUP(tc2);
 223 ATF_TC_HEAD(tc2, tc)
 224 {
 225     ... second test case's header ...
 226 }
 227 ATF_TC_BODY(tc2, tc)
 228 {
 229     ... second test case's body ...
 230 }
 231 ATF_TC_CLEANUP(tc2, tc)
 232 {
 233     ... second test case's cleanup ...
 234 }
 235
 236 ATF_TC_WITHOUT_HEAD(tc3);
 237 ATF_TC_BODY(tc3, tc)
 238 {
 239     ... third test case's body ...
 240 }
 241
 242 .Ns ... additional test cases ...
 243
 244 ATF_TP_ADD_TCS(tp)
 245 {
 246     ATF_TP_ADD_TC(tcs, tc1);
 247     ATF_TP_ADD_TC(tcs, tc2);
 248     ATF_TP_ADD_TC(tcs, tc3);
 249     ... add additional test cases ...
 250
 251     return atf_no_error();
 252 }
 253 .Ed
 254 .Ss Definition of test cases
 255 Test cases have an identifier and are composed of three different parts:
 256 the header, the body and an optional cleanup routine, all of which are
 257 described in
 258 .Xr atf-test-case 4 .
 259 To define test cases, one can use the
 260 .Fn ATF_TC ,
 261 .Fn ATF_TC_WITH_CLEANUP
 262 or the
 263 .Fn ATF_TC_WITHOUT_HEAD
 264 macros, which take a single parameter specifiying the test case's name.
 265 .Fn ATF_TC ,
 266 requires to define a head and a body for the test case,
 267 .Fn ATF_TC_WITH_CLEANUP
 268 requires to define a head, a body and a cleanup for the test case and
 269 .Fn ATF_TC_WITHOUT_HEAD
 270 requires only a body for the test case.
 271 It is important to note that these
 272 .Em do not
 273 set the test case up for execution when the program is run.
 274 In order to do so, a later registration is needed with the
 275 .Fn ATF_TP_ADD_TC
 276 macro detailed in
 277 .Sx Program initialization .
 278 .Pp
 279 Later on, one must define the three parts of the body by means of three
 280 functions.
 281 Their headers are given by the
 282 .Fn ATF_TC_HEAD ,
 283 .Fn ATF_TC_BODY
 284 and
 285 .Fn ATF_TC_CLEANUP
 286 macros, all of which take the test case name provided to the
 287 .Fn ATF_TC
 288 .Fn ATF_TC_WITH_CLEANUP ,
 289 or
 290 .Fn ATF_TC_WITHOUT_HEAD
 291 macros and the name of the variable that will hold a pointer to the
 292 test case data.
 293 Following each of these, a block of code is expected, surrounded by the
 294 opening and closing brackets.
 295 .Ss Program initialization
 296 The library provides a way to easily define the test program's
 297 .Fn main
 298 function.
 299 You should never define one on your own, but rely on the
 300 library to do it for you.
 301 This is done by using the
 302 .Fn ATF_TP_ADD_TCS
 303 macro, which is passed the name of the object that will hold the test
 304 cases; i.e. the test program instance.
 305 This name can be whatever you want as long as it is a valid variable
 306 identifier.
 307 .Pp
 308 After the macro, you are supposed to provide the body of a function, which
 309 should only use the
 310 .Fn ATF_TP_ADD_TC
 311 macro to register the test cases the test program will execute and return
 312 a success error code.
 313 The first parameter of this macro matches the name you provided in the
 314 former call.
 315 The success status can be returned using the
 316 .Fn atf_no_error
 317 function.
 318 .Ss Header definitions
 319 The test case's header can define the meta-data by using the
 320 .Fn atf_tc_set_md_var
 321 method, which takes three parameters: the first one points to the test
 322 case data, the second one specifies the meta-data variable to be set
 323 and the third one specifies its value.
 324 Both of them are strings.
 325 .Ss Configuration variables
 326 The test case has read-only access to the current configuration variables
 327 by means of the
 328 .Ft bool
 329 .Fn atf_tc_has_config_var ,
 330 .Ft const char *
 331 .Fn atf_tc_get_config_var ,
 332 .Ft const char *
 333 .Fn atf_tc_get_config_var_wd ,
 334 .Ft bool
 335 .Fn atf_tc_get_config_var_as_bool ,
 336 .Ft bool
 337 .Fn atf_tc_get_config_var_as_bool_wd ,
 338 .Ft long
 339 .Fn atf_tc_get_config_var_as_long ,
 340 and the
 341 .Ft long
 342 .Fn atf_tc_get_config_var_as_long_wd
 343 functions, which can be called in any of the three parts of a test case.
 344 .Pp
 345 The
 346 .Sq _wd
 347 variants take a default value for the variable which is returned if the
 348 variable is not defined.
 349 The other functions without the
 350 .Sq _wd
 351 suffix
 352 .Em require
 353 the variable to be defined.
 354 .Ss Access to the source directory
 355 It is possible to get the path to the test case's source directory from any
 356 of its three components by querying the
 357 .Sq srcdir
 358 configuration variable.
 359 .Ss Requiring programs
 360 Aside from the
 361 .Va require.progs
 362 meta-data variable available in the header only, one can also check for
 363 additional programs in the test case's body by using the
 364 .Fn atf_tc_require_prog
 365 function, which takes the base name or full path of a single binary.
 366 Relative paths are forbidden.
 367 If it is not found, the test case will be automatically skipped.
 368 .Ss Test case finalization
 369 The test case finalizes either when the body reaches its end, at which
 370 point the test is assumed to have
 371 .Em passed ,
 372 unless any non-fatal errors were raised using
 373 .Fn atf_tc_fail_nonfatal ,
 374 or at any explicit call to
 375 .Fn atf_tc_pass ,
 376 .Fn atf_tc_fail
 377 or
 378 .Fn atf_tc_skip .
 379 These three functions terminate the execution of the test case immediately.
 380 The cleanup routine will be processed afterwards in a completely automated
 381 way, regardless of the test case's termination reason.
 382 .Pp
 383 .Fn atf_tc_pass
 384 does not take any parameters.
 385 .Fn atf_tc_fail ,
 386 .Fn atf_tc_fail_nonfatal
 387 and
 388 .Fn atf_tc_skip
 389 take a format string and a variable list of parameters, which describe, in
 390 a user-friendly manner, why the test case failed or was skipped,
 391 respectively.
 392 It is very important to provide a clear error message in both cases so that
 393 the user can quickly know why the test did not pass.
 394 .Ss Expectations
 395 Everything explained in the previous section changes when the test case
 396 expectations are redefined by the programmer.
 397 .Pp
 398 Each test case has an internal state called
 399 .Sq expect
 400 that describes what the test case expectations are at any point in time.
 401 The value of this property can change during execution by any of:
 402 .Bl -tag -width indent
 403 .It Fn atf_tc_expect_death "reason" "..."
 404 Expects the test case to exit prematurely regardless of the nature of the
 405 exit.
 406 .It Fn atf_tc_expect_exit "exitcode" "reason" "..."
 407 Expects the test case to exit cleanly.
 408 If
 409 .Va exitcode
 410 is not
 411 .Sq -1 ,
 412 the runtime engine will validate that the exit code of the test case
 413 matches the one provided in this call.
 414 Otherwise, the exact value will be ignored.
 415 .It Fn atf_tc_expect_fail "reason" "..."
 416 Any failure (be it fatal or non-fatal) raised in this mode is recorded.
 417 However, such failures do not report the test case as failed; instead, the
 418 test case finalizes cleanly and is reported as
 419 .Sq expected failure ;
 420 this report includes the provided
 421 .Fa reason
 422 as part of it.
 423 If no error is raised while running in this mode, then the test case is
 424 reported as
 425 .Sq failed .
 426 .Pp
 427 This mode is useful to reproduce actual known bugs in tests.
 428 Whenever the developer fixes the bug later on, the test case will start
 429 reporting a failure, signaling the developer that the test case must be
 430 adjusted to the new conditions.
 431 In this situation, it is useful, for example, to set
 432 .Fa reason
 433 as the bug number for tracking purposes.
 434 .It Fn atf_tc_expect_pass
 435 This is the normal mode of execution.
 436 In this mode, any failure is reported as such to the user and the test case
 437 is marked as
 438 .Sq failed .
 439 .It Fn atf_tc_expect_signal "signo" "reason" "..."
 440 Expects the test case to terminate due to the reception of a signal.
 441 If
 442 .Va signo
 443 is not
 444 .Sq -1 ,
 445 the runtime engine will validate that the signal that terminated the test
 446 case matches the one provided in this call.
 447 Otherwise, the exact value will be ignored.
 448 .It Fn atf_tc_expect_timeout "reason" "..."
 449 Expects the test case to execute for longer than its timeout.
 450 .El
 451 .Ss Helper macros for common checks
 452 The library provides several macros that are very handy in multiple
 453 situations.
 454 These basically check some condition after executing a given statement or
 455 processing a given expression and, if the condition is not met, they
 456 report the test case as failed.
 457 .Pp
 458 The
 459 .Sq REQUIRE
 460 variant of the macros immediately abort the test case as soon as an error
 461 condition is detected by calling the
 462 .Fn atf_tc_fail
 463 function.
 464 Use this variant whenever it makes no sense to continue the execution of a
 465 test case when the checked condition is not met.
 466 The
 467 .Sq CHECK
 468 variant, on the other hand, reports a failure as soon as it is encountered
 469 using the
 470 .Fn atf_tc_fail_nonfatal
 471 function, but the execution of the test case continues as if nothing had
 472 happened.
 473 Use this variant whenever the checked condition is important as a result of
 474 the test case, but there are other conditions that can be subsequently
 475 checked on the same run without aborting.
 476 .Pp
 477 Additionally, the
 478 .Sq MSG
 479 variants take an extra set of parameters to explicitly specify the failure
 480 message.
 481 This failure message is formatted according to the
 482 .Xr printf 3
 483 formatters.
 484 .Pp
 485 .Fn ATF_CHECK ,
 486 .Fn ATF_CHECK_MSG ,
 487 .Fn ATF_REQUIRE
 488 and
 489 .Fn ATF_REQUIRE_MSG
 490 take an expression and fail if the expression evaluates to false.
 491 .Pp
 492 .Fn ATF_CHECK_EQ ,
 493 .Fn ATF_CHECK_EQ_MSG ,
 494 .Fn ATF_REQUIRE_EQ
 495 and
 496 .Fn ATF_REQUIRE_EQ_MSG
 497 take two expressions and fail if the two evaluated values are not equal.
 498 .Pp
 499 .Fn ATF_CHECK_MATCH ,
 500 .Fn ATF_CHECK_MATCH_MSG ,
 501 .Fn ATF_REQUIRE_MATCH
 502 and
 503 .Fn ATF_REQUIRE_MATCH_MSG
 504 take a regular expression and a string and fail if the regular expression does
 505 not match the given string.
 506 Note that the regular expression is not anchored, so it will match anywhere in
 507 the string.
 508 .Pp
 509 .Fn ATF_CHECK_STREQ ,
 510 .Fn ATF_CHECK_STREQ_MSG ,
 511 .Fn ATF_REQUIRE_STREQ
 512 and
 513 .Fn ATF_REQUIRE_STREQ_MSG
 514 take two strings and fail if the two are not equal character by character.
 515 .Pp
 516 .Fn ATF_CHECK_ERRNO
 517 and
 518 .Fn ATF_REQUIRE_ERRNO
 519 take, first, the error code that the check is expecting to find in the
 520 .Va errno
 521 variable and, second, a boolean expression that, if evaluates to true,
 522 means that a call failed and
 523 .Va errno
 524 has to be checked against the first value.
 525 .Ss Utility functions
 526 The following functions are provided as part of the
 527 .Nm
 528 API to simplify the creation of a variety of tests.
 529 In particular, these are useful to write tests for command-line interfaces.
 530 .Pp
 531 .Ft void
 532 .Fo atf_utils_cat_file
 533 .Fa "const char *file"
 534 .Fa "const char *prefix"
 535 .Fc
 536 .Bd -ragged -offset indent
 537 Prints the contents of
 538 .Fa file
 539 to the standard output, prefixing every line with the string in
 540 .Fa prefix .
 541 .Ed
 542 .Pp
 543 .Ft bool
 544 .Fo atf_utils_compare_file
 545 .Fa "const char *file"
 546 .Fa "const char *contents"
 547 .Fc
 548 .Bd -ragged -offset indent
 549 Returns true if the given
 550 .Fa file
 551 matches exactly the expected inlined
 552 .Fa contents .
 553 .Ed
 554 .Pp
 555 .Ft void
 556 .Fo atf_utils_copy_file
 557 .Fa "const char *source"
 558 .Fa "const char *destination"
 559 .Fc
 560 .Bd -ragged -offset indent
 561 Copies the file
 562 .Fa source
 563 to
 564 .Fa destination .
 565 The permissions of the file are preserved during the code.
 566 .Ed
 567 .Pp
 568 .Ft void
 569 .Fo atf_utils_create_file
 570 .Fa "const char *file"
 571 .Fa "const char *contents"
 572 .Fa "..."
 573 .Fc
 574 .Bd -ragged -offset indent
 575 Creates
 576 .Fa file
 577 with the text given in
 578 .Fa contents ,
 579 which is a formatting string that uses the rest of the variable arguments.
 580 .Ed
 581 .Pp
 582 .Ft void
 583 .Fo atf_utils_file_exists
 584 .Fa "const char *file"
 585 .Fc
 586 .Bd -ragged -offset indent
 587 Checks if
 588 .Fa file
 589 exists.
 590 .Ed
 591 .Pp
 592 .Ft pid_t
 593 .Fo atf_utils_fork
 594 .Fa "void"
 595 .Fc
 596 .Bd -ragged -offset indent
 597 Forks a process and redirects the standard output and standard error of the
 598 child to files for later validation with
 599 .Fn atf_utils_wait .
 600 Fails the test case if the fork fails, so this does not return an error.
 601 .Ed
 602 .Pp
 603 .Ft void
 604 .Fo atf_utils_free_charpp
 605 .Fa "char **argv"
 606 .Fc
 607 .Bd -ragged -offset indent
 608 Frees a dynamically-allocated array of dynamically-allocated strings.
 609 .Ed
 610 .Pp
 611 .Ft bool
 612 .Fo atf_utils_grep_file
 613 .Fa "const char *regexp"
 614 .Fa "const char *file"
 615 .Fa "..."
 616 .Fc
 617 .Bd -ragged -offset indent
 618 Searches for the
 619 .Fa regexp ,
 620 which is a formatting string representing the regular expression,
 621 in the
 622 .Fa file .
 623 The variable arguments are used to construct the regular expression.
 624 .Ed
 625 .Pp
 626 .Ft bool
 627 .Fo atf_utils_grep_string
 628 .Fa "const char *regexp"
 629 .Fa "const char *str"
 630 .Fa "..."
 631 .Fc
 632 .Bd -ragged -offset indent
 633 Searches for the
 634 .Fa regexp ,
 635 which is a formatting string representing the regular expression,
 636 in the literal string
 637 .Fa str .
 638 The variable arguments are used to construct the regular expression.
 639 .Ed
 640 .Pp
 641 .Ft char *
 642 .Fo atf_utils_readline
 643 .Fa "int fd"
 644 .Fc
 645 .Bd -ragged -offset indent
 646 Reads a line from the file descriptor
 647 .Fa fd .
 648 The line, if any, is returned as a dynamically-allocated buffer that must be
 649 released with
 650 .Xr free 3 .
 651 If there was nothing to read, returns
 652 .Sq NULL .
 653 .Ed
 654 .Pp
 655 .Ft void
 656 .Fo atf_utils_redirect
 657 .Fa "const int fd"
 658 .Fa "const char *file"
 659 .Fc
 660 .Bd -ragged -offset indent
 661 Redirects the given file descriptor
 662 .Fa fd
 663 to
 664 .Fa file .
 665 This function exits the process in case of an error and does not properly mark
 666 the test case as failed.
 667 As a result, it should only be used in subprocesses of the test case; specially
 668 those spawned by
 669 .Fn atf_utils_fork .
 670 .Ed
 671 .Pp
 672 .Ft void
 673 .Fo atf_utils_wait
 674 .Fa "const pid_t pid"
 675 .Fa "const int expected_exit_status"
 676 .Fa "const char *expected_stdout"
 677 .Fa "const char *expected_stderr"
 678 .Fc
 679 .Bd -ragged -offset indent
 680 Waits and validates the result of a subprocess spawned with
 681 .Fn atf_utils_wait .
 682 The validation involves checking that the subprocess exited cleanly and returned
 683 the code specified in
 684 .Fa expected_exit_status
 685 and that its standard output and standard error match the strings given in
 686 .Fa expected_stdout
 687 and
 688 .Fa expected_stderr .
 689 .Pp
 690 If any of the
 691 .Fa expected_stdout
 692 or
 693 .Fa expected_stderr
 694 strings are prefixed with
 695 .Sq save: ,
 696 then they specify the name of the file into which to store the stdout or stderr
 697 of the subprocess, and no comparison is performed.
 698 .Ed
 699 .Sh EXAMPLES
 700 The following shows a complete test program with a single test case that
 701 validates the addition operator:
 702 .Bd -literal -offset indent
 703 #include <atf-c.h>
 704
 705 ATF_TC(addition);
 706 ATF_TC_HEAD(addition, tc)
 707 {
 708     atf_tc_set_md_var(tc, "descr",
 709                       "Sample tests for the addition operator");
 710 }
 711 ATF_TC_BODY(addition, tc)
 712 {
 713     ATF_CHECK_EQ(0 + 0, 0);
 714     ATF_CHECK_EQ(0 + 1, 1);
 715     ATF_CHECK_EQ(1 + 0, 1);
 716
 717     ATF_CHECK_EQ(1 + 1, 2);
 718
 719     ATF_CHECK_EQ(100 + 200, 300);
 720 }
 721
 722 ATF_TC(string_formatting);
 723 ATF_TC_HEAD(string_formatting, tc)
 724 {
 725     atf_tc_set_md_var(tc, "descr",
 726                       "Sample tests for the snprintf");
 727 }
 728 ATF_TC_BODY(string_formatting, tc)
 729 {
 730     char buf[1024];
 731     snprintf(buf, sizeof(buf), "a %s", "string");
 732     ATF_CHECK_STREQ_MSG("a string", buf, "%s is not working");
 733 }
 734
 735 ATF_TC(open_failure);
 736 ATF_TC_HEAD(open_failure, tc)
 737 {
 738     atf_tc_set_md_var(tc, "descr",
 739                       "Sample tests for the open function");
 740 }
 741 ATF_TC_BODY(open_failure, tc)
 742 {
 743     ATF_CHECK_ERRNO(ENOENT, open("non-existent", O_RDONLY) == -1);
 744 }
 745
 746 ATF_TC(known_bug);
 747 ATF_TC_HEAD(known_bug, tc)
 748 {
 749     atf_tc_set_md_var(tc, "descr",
 750                       "Reproduces a known bug");
 751 }
 752 ATF_TC_BODY(known_bug, tc)
 753 {
 754     atf_tc_expect_fail("See bug number foo/bar");
 755     ATF_CHECK_EQ(3, 1 + 1);
 756     atf_tc_expect_pass();
 757     ATF_CHECK_EQ(3, 1 + 2);
 758 }
 759
 760 ATF_TP_ADD_TCS(tp)
 761 {
 762     ATF_TP_ADD_TC(tp, addition);
 763     ATF_TP_ADD_TC(tp, string_formatting);
 764     ATF_TP_ADD_TC(tp, open_failure);
 765     ATF_TP_ADD_TC(tp, known_bug);
 766
 767     return atf_no_error();
 768 }
 769 .Ed
 770 .Sh SEE ALSO
 771 .Xr atf-test-program 1 ,
 772 .Xr atf-test-case 4