summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorngie <ngie@FreeBSD.org>2017-03-13 01:17:33 +0000
committerngie <ngie@FreeBSD.org>2017-03-13 01:17:33 +0000
commit2e72817b487aa09d1e2bb0ab341ffe3a4ca7ab7f (patch)
tree4fdffaf589d978a1179c4d2043f0cc6c8290470e
parentfad9bc33a21dea59b9141f4c4a818b8da7940f02 (diff)
downloadFreeBSD-src-2e72817b487aa09d1e2bb0ab341ffe3a4ca7ab7f.zip
FreeBSD-src-2e72817b487aa09d1e2bb0ab341ffe3a4ca7ab7f.tar.gz
MFC r314793,r314796,r314797,r314798,r314799,r314800,r314801,r314802,r314803,r314804,r314805:
r314793: Fix ATF_TP_ADD_TCS example in atf-c-api(3) ATF_TP_ADD_TC should use `tp` as the second argument, not `tcs`, as ATF_TP_ADD_TCS uses `tp` as its first argument. Bump .Dd for the change. r314796: Fix atf-sh(3) manpage issues - Fix spelling errors (specifiying -> specifying) [1] - Escape '.' at start of lines using & to tell the roff processor that the line isn't meant to be treated as a command [2]. Bump .Dd for the change r314797: Fix grammar warning noted by igor Remove surrounding ellipses in e.g. section and add a comma before and after the e.g. reference. r314798: Fix out-of-order sections in atf-sh(1) - `.Op` must be used in the SYNOPSIS section, not the NAME section. - Move ATF_SHELL environment variable description up to first ENVIRONMENT section. Garbage collect the duplicate ENVIRONMENT section. Bump .Dd for the change r314799: Fix manlint issues with atf-check(1) - Use `.Bf Em`/`.Ef` instead of prefixing lines with `.Em`. The forms are equivalent with traditional roff, but unnecessarily verbose. The former form applies the .Em macro to the enclosed block. - Move EXIT_STATUS section down so the section complies with section ordering specified by mdoc(7) and enforced by manlint(1). Bump .Dd for the change r314800: Fix issues with atf-check(1) found by igor and refer to atf-check(1) - Fix typo (specifiying -> specifying) - Add atf-check(1) to SEE ALSO section for completeness. It's mentioned above, but by convention the SEE ALSO section should list all relevant references to other tools and APIs. Bump .Dd for the change r314801: Fix igor/manlint issues with atf-c(3) - Remove surrounding ellipses in i.e. section and add a comma before and after the i.e. reference [1]. - Fix typo (specifiying -> specifying) [1]. - Escape '.' at start of lines using & to tell the roff processor that the line isn't meant to be treated as a command [2]. Bump .Dd for the change r314802: Fix atf-c-api(3) manpage issues - Fix typo (specifiying -> specifying). - Remove surrounding ellipses in i.e. section and add a comma before and after the i.e. reference. Bump .Dd for the change r314803: Fix typos - specifiying -> specifying - manged -> managed Bump .Dd for the change r314804: Fix issues noted by igor/manlint - Fix typos [1]: -- manged -> managed -- specifiying -> specifying - Escape '.' at start of lines using & to tell the roff processor that the line isn't meant to be treated as a command [2]. Bump .Dd for the change r314805: Remove *-api(3) manpages removed in ATF 0.21 I overlooked the fact that these manpages had been removed upstream and replaced with their non *-api(3) equivalents. Follow upstream's lead and remove the unused manpages.
-rw-r--r--contrib/atf/atf-c++/atf-c++-api.3632
-rw-r--r--contrib/atf/atf-c++/atf-c++.312
-rw-r--r--contrib/atf/atf-c/atf-c-api.3772
-rw-r--r--contrib/atf/atf-c/atf-c.310
-rw-r--r--contrib/atf/atf-sh/atf-check.118
-rw-r--r--contrib/atf/atf-sh/atf-sh-api.3340
-rw-r--r--contrib/atf/atf-sh/atf-sh.111
-rw-r--r--contrib/atf/atf-sh/atf-sh.38
-rw-r--r--contrib/atf/doc/atf-test-case.46
9 files changed, 32 insertions, 1777 deletions
diff --git a/contrib/atf/atf-c++/atf-c++-api.3 b/contrib/atf/atf-c++/atf-c++-api.3
deleted file mode 100644
index da1441e..0000000
--- a/contrib/atf/atf-c++/atf-c++-api.3
+++ /dev/null
@@ -1,632 +0,0 @@
-.\"
-.\" Automated Testing Framework (atf)
-.\"
-.\" Copyright (c) 2008 The NetBSD Foundation, Inc.
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
-.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
-.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
-.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.\"
-.Dd March 2, 2014
-.Dt ATF-C++-API 3
-.Os
-.Sh NAME
-.Nm atf-c++-api ,
-.Nm ATF_ADD_TEST_CASE ,
-.Nm ATF_CHECK_ERRNO ,
-.Nm ATF_FAIL ,
-.Nm ATF_INIT_TEST_CASES ,
-.Nm ATF_PASS ,
-.Nm ATF_REQUIRE ,
-.Nm ATF_REQUIRE_EQ ,
-.Nm ATF_REQUIRE_ERRNO ,
-.Nm ATF_REQUIRE_IN ,
-.Nm ATF_REQUIRE_MATCH ,
-.Nm ATF_REQUIRE_NOT_IN ,
-.Nm ATF_REQUIRE_THROW ,
-.Nm ATF_REQUIRE_THROW_RE ,
-.Nm ATF_SKIP ,
-.Nm ATF_TEST_CASE ,
-.Nm ATF_TEST_CASE_BODY ,
-.Nm ATF_TEST_CASE_CLEANUP ,
-.Nm ATF_TEST_CASE_HEAD ,
-.Nm ATF_TEST_CASE_NAME ,
-.Nm ATF_TEST_CASE_USE ,
-.Nm ATF_TEST_CASE_WITH_CLEANUP ,
-.Nm ATF_TEST_CASE_WITHOUT_HEAD ,
-.Nm atf::utils::cat_file ,
-.Nm atf::utils::compare_file ,
-.Nm atf::utils::copy_file ,
-.Nm atf::utils::create_file ,
-.Nm atf::utils::file_exists ,
-.Nm atf::utils::fork ,
-.Nm atf::utils::grep_collection ,
-.Nm atf::utils::grep_file ,
-.Nm atf::utils::grep_string ,
-.Nm atf::utils::redirect ,
-.Nm atf::utils::wait
-.Nd C++ API to write ATF-based test programs
-.Sh SYNOPSIS
-.In atf-c++.hpp
-.Fn ATF_ADD_TEST_CASE "tcs" "name"
-.Fn ATF_CHECK_ERRNO "exp_errno" "bool_expression"
-.Fn ATF_FAIL "reason"
-.Fn ATF_INIT_TEST_CASES "tcs"
-.Fn ATF_PASS
-.Fn ATF_REQUIRE "expression"
-.Fn ATF_REQUIRE_EQ "expression_1" "expression_2"
-.Fn ATF_REQUIRE_ERRNO "exp_errno" "bool_expression"
-.Fn ATF_REQUIRE_IN "element" "collection"
-.Fn ATF_REQUIRE_MATCH "regexp" "string_expression"
-.Fn ATF_REQUIRE_NOT_IN "element" "collection"
-.Fn ATF_REQUIRE_THROW "expected_exception" "statement"
-.Fn ATF_REQUIRE_THROW_RE "expected_exception" "regexp" "statement"
-.Fn ATF_SKIP "reason"
-.Fn ATF_TEST_CASE "name"
-.Fn ATF_TEST_CASE_BODY "name"
-.Fn ATF_TEST_CASE_CLEANUP "name"
-.Fn ATF_TEST_CASE_HEAD "name"
-.Fn ATF_TEST_CASE_NAME "name"
-.Fn ATF_TEST_CASE_USE "name"
-.Fn ATF_TEST_CASE_WITH_CLEANUP "name"
-.Fn ATF_TEST_CASE_WITHOUT_HEAD "name"
-.Ft void
-.Fo atf::utils::cat_file
-.Fa "const std::string& path"
-.Fa "const std::string& prefix"
-.Fc
-.Ft bool
-.Fo atf::utils::compare_file
-.Fa "const std::string& path"
-.Fa "const std::string& contents"
-.Fc
-.Ft void
-.Fo atf::utils::copy_file
-.Fa "const std::string& source"
-.Fa "const std::string& destination"
-.Fc
-.Ft void
-.Fo atf::utils::create_file
-.Fa "const std::string& path"
-.Fa "const std::string& contents"
-.Fc
-.Ft void
-.Fo atf::utils::file_exists
-.Fa "const std::string& path"
-.Fc
-.Ft pid_t
-.Fo atf::utils::fork
-.Fa "void"
-.Fc
-.Ft bool
-.Fo atf::utils::grep_collection
-.Fa "const std::string& regexp"
-.Fa "const Collection& collection"
-.Fc
-.Ft bool
-.Fo atf::utils::grep_file
-.Fa "const std::string& regexp"
-.Fa "const std::string& path"
-.Fc
-.Ft bool
-.Fo atf::utils::grep_string
-.Fa "const std::string& regexp"
-.Fa "const std::string& path"
-.Fc
-.Ft void
-.Fo atf::utils::redirect
-.Fa "const int fd"
-.Fa "const std::string& path"
-.Fc
-.Ft void
-.Fo atf::utils::wait
-.Fa "const pid_t pid"
-.Fa "const int expected_exit_status"
-.Fa "const std::string& expected_stdout"
-.Fa "const std::string& expected_stderr"
-.Fc
-.Sh DESCRIPTION
-ATF provides a C++ programming interface to implement test programs.
-C++-based test programs follow this template:
-.Bd -literal -offset indent
-extern "C" {
-.Ns ... C-specific includes go here ...
-}
-
-.Ns ... C++-specific includes go here ...
-
-#include <atf-c++.hpp>
-
-ATF_TEST_CASE(tc1);
-ATF_TEST_CASE_HEAD(tc1)
-{
- ... first test case's header ...
-}
-ATF_TEST_CASE_BODY(tc1)
-{
- ... first test case's body ...
-}
-
-ATF_TEST_CASE_WITH_CLEANUP(tc2);
-ATF_TEST_CASE_HEAD(tc2)
-{
- ... second test case's header ...
-}
-ATF_TEST_CASE_BODY(tc2)
-{
- ... second test case's body ...
-}
-ATF_TEST_CASE_CLEANUP(tc2)
-{
- ... second test case's cleanup ...
-}
-
-ATF_TEST_CASE(tc3);
-ATF_TEST_CASE_BODY(tc3)
-{
- ... third test case's body ...
-}
-
-.Ns ... additional test cases ...
-
-ATF_INIT_TEST_CASES(tcs)
-{
- ATF_ADD_TEST_CASE(tcs, tc1);
- ATF_ADD_TEST_CASE(tcs, tc2);
- ATF_ADD_TEST_CASE(tcs, tc3);
- ... add additional test cases ...
-}
-.Ed
-.Ss Definition of test cases
-Test cases have an identifier and are composed of three different parts:
-the header, the body and an optional cleanup routine, all of which are
-described in
-.Xr atf-test-case 4 .
-To define test cases, one can use the
-.Fn ATF_TEST_CASE ,
-.Fn ATF_TEST_CASE_WITH_CLEANUP
-or the
-.Fn ATF_TEST_CASE_WITHOUT_HEAD
-macros, which take a single parameter specifiying the test case's
-name.
-.Fn ATF_TEST_CASE ,
-requires to define a head and a body for the test case,
-.Fn ATF_TEST_CASE_WITH_CLEANUP
-requires to define a head, a body and a cleanup for the test case and
-.Fn ATF_TEST_CASE_WITHOUT_HEAD
-requires only a body for the test case.
-It is important to note that these
-.Em do not
-set the test case up for execution when the program is run.
-In order to do so, a later registration is needed through the
-.Fn ATF_ADD_TEST_CASE
-macro detailed in
-.Sx Program initialization .
-.Pp
-Later on, one must define the three parts of the body by means of three
-functions.
-Their headers are given by the
-.Fn ATF_TEST_CASE_HEAD ,
-.Fn ATF_TEST_CASE_BODY
-and
-.Fn ATF_TEST_CASE_CLEANUP
-macros, all of which take the test case's name.
-Following each of these, a block of code is expected, surrounded by the
-opening and closing brackets.
-.Pp
-Additionally, the
-.Fn ATF_TEST_CASE_NAME
-macro can be used to obtain the name of the class corresponding to a
-particular test case, as the name is internally manged by the library to
-prevent clashes with other user identifiers.
-Similarly, the
-.Fn ATF_TEST_CASE_USE
-macro can be executed on a particular test case to mark it as "used" and
-thus prevent compiler warnings regarding unused symbols.
-Note that
-.Em you should never have to use these macros during regular operation.
-.Ss Program initialization
-The library provides a way to easily define the test program's
-.Fn main
-function.
-You should never define one on your own, but rely on the
-library to do it for you.
-This is done by using the
-.Fn ATF_INIT_TEST_CASES
-macro, which is passed the name of the list that will hold the test cases.
-This name can be whatever you want as long as it is a valid variable value.
-.Pp
-After the macro, you are supposed to provide the body of a function, which
-should only use the
-.Fn ATF_ADD_TEST_CASE
-macro to register the test cases the test program will execute.
-The first parameter of this macro matches the name you provided in the
-former call.
-.Ss Header definitions
-The test case's header can define the meta-data by using the
-.Fn set_md_var
-method, which takes two parameters: the first one specifies the
-meta-data variable to be set and the second one specifies its value.
-Both of them are strings.
-.Ss Configuration variables
-The test case has read-only access to the current configuration variables
-by means of the
-.Ft bool
-.Fn has_config_var
-and the
-.Ft std::string
-.Fn get_config_var
-methods, which can be called in any of the three parts of a test case.
-.Ss Access to the source directory
-It is possible to get the path to the test case's source directory from any
-of its three components by querying the
-.Sq srcdir
-configuration variable.
-.Ss Requiring programs
-Aside from the
-.Va require.progs
-meta-data variable available in the header only, one can also check for
-additional programs in the test case's body by using the
-.Fn require_prog
-function, which takes the base name or full path of a single binary.
-Relative paths are forbidden.
-If it is not found, the test case will be automatically skipped.
-.Ss Test case finalization
-The test case finalizes either when the body reaches its end, at which
-point the test is assumed to have
-.Em passed ,
-or at any explicit call to
-.Fn ATF_PASS ,
-.Fn ATF_FAIL
-or
-.Fn ATF_SKIP .
-These three macros terminate the execution of the test case immediately.
-The cleanup routine will be processed afterwards in a completely automated
-way, regardless of the test case's termination reason.
-.Pp
-.Fn ATF_PASS
-does not take any parameters.
-.Fn ATF_FAIL
-and
-.Fn ATF_SKIP
-take a single string that describes why the test case failed or
-was skipped, respectively.
-It is very important to provide a clear error message in both cases so that
-the user can quickly know why the test did not pass.
-.Ss Expectations
-Everything explained in the previous section changes when the test case
-expectations are redefined by the programmer.
-.Pp
-Each test case has an internal state called
-.Sq expect
-that describes what the test case expectations are at any point in time.
-The value of this property can change during execution by any of:
-.Bl -tag -width indent
-.It Fn expect_death "reason"
-Expects the test case to exit prematurely regardless of the nature of the
-exit.
-.It Fn expect_exit "exitcode" "reason"
-Expects the test case to exit cleanly.
-If
-.Va exitcode
-is not
-.Sq -1 ,
-the runtime engine will validate that the exit code of the test case
-matches the one provided in this call.
-Otherwise, the exact value will be ignored.
-.It Fn expect_fail "reason"
-Any failure (be it fatal or non-fatal) raised in this mode is recorded.
-However, such failures do not report the test case as failed; instead, the
-test case finalizes cleanly and is reported as
-.Sq expected failure ;
-this report includes the provided
-.Fa reason
-as part of it.
-If no error is raised while running in this mode, then the test case is
-reported as
-.Sq failed .
-.Pp
-This mode is useful to reproduce actual known bugs in tests.
-Whenever the developer fixes the bug later on, the test case will start
-reporting a failure, signaling the developer that the test case must be
-adjusted to the new conditions.
-In this situation, it is useful, for example, to set
-.Fa reason
-as the bug number for tracking purposes.
-.It Fn expect_pass
-This is the normal mode of execution.
-In this mode, any failure is reported as such to the user and the test case
-is marked as
-.Sq failed .
-.It Fn expect_race "reason"
-Any failure or timeout during the execution of the test case will be
-considered as if a race condition has been triggered and reported as such.
-If no problems arise, the test will continue execution as usual.
-.It Fn expect_signal "signo" "reason"
-Expects the test case to terminate due to the reception of a signal.
-If
-.Va signo
-is not
-.Sq -1 ,
-the runtime engine will validate that the signal that terminated the test
-case matches the one provided in this call.
-Otherwise, the exact value will be ignored.
-.It Fn expect_timeout "reason"
-Expects the test case to execute for longer than its timeout.
-.El
-.Ss Helper macros for common checks
-The library provides several macros that are very handy in multiple
-situations.
-These basically check some condition after executing a given statement or
-processing a given expression and, if the condition is not met, they
-automatically call
-.Fn ATF_FAIL
-with an appropriate error message.
-.Pp
-.Fn ATF_REQUIRE
-takes an expression and raises a failure if it evaluates to false.
-.Pp
-.Fn ATF_REQUIRE_EQ
-takes two expressions and raises a failure if the two do not evaluate to
-the same exact value.
-.Pp
-.Fn ATF_REQUIRE_IN
-takes an element and a collection and validates that the element is present in
-the collection.
-.Pp
-.Fn ATF_REQUIRE_MATCH
-takes a regular expression and a string and raises a failure if the regular
-expression does not match the string.
-.Pp
-.Fn ATF_REQUIRE_NOT_IN
-takes an element and a collection and validates that the element is not present
-in the collection.
-.Pp
-.Fn ATF_REQUIRE_THROW
-takes the name of an exception and a statement and raises a failure if
-the statement does not throw the specified exception.
-.Fn ATF_REQUIRE_THROW_RE
-takes the name of an exception, a regular expresion and a statement and raises a
-failure if the statement does not throw the specified exception and if the
-message of the exception does not match the regular expression.
-.Pp
-.Fn ATF_CHECK_ERRNO
-and
-.Fn ATF_REQUIRE_ERRNO
-take, first, the error code that the check is expecting to find in the
-.Va errno
-variable and, second, a boolean expression that, if evaluates to true,
-means that a call failed and
-.Va errno
-has to be checked against the first value.
-.Ss Utility functions
-The following functions are provided as part of the
-.Nm
-API to simplify the creation of a variety of tests.
-In particular, these are useful to write tests for command-line interfaces.
-.Pp
-.Ft void
-.Fo atf::utils::cat_file
-.Fa "const std::string& path"
-.Fa "const std::string& prefix"
-.Fc
-.Bd -ragged -offset indent
-Prints the contents of
-.Fa path
-to the standard output, prefixing every line with the string in
-.Fa prefix .
-.Ed
-.Pp
-.Ft bool
-.Fo atf::utils::compare_file
-.Fa "const std::string& path"
-.Fa "const std::string& contents"
-.Fc
-.Bd -ragged -offset indent
-Returns true if the given
-.Fa path
-matches exactly the expected inlined
-.Fa contents .
-.Ed
-.Pp
-.Ft void
-.Fo atf::utils::copy_file
-.Fa "const std::string& source"
-.Fa "const std::string& destination"
-.Fc
-.Bd -ragged -offset indent
-Copies the file
-.Fa source
-to
-.Fa destination .
-The permissions of the file are preserved during the code.
-.Ed
-.Pp
-.Ft void
-.Fo atf::utils::create_file
-.Fa "const std::string& path"
-.Fa "const std::string& contents"
-.Fc
-.Bd -ragged -offset indent
-Creates
-.Fa file
-with the text given in
-.Fa contents .
-.Ed
-.Pp
-.Ft void
-.Fo atf::utils::file_exists
-.Fa "const std::string& path"
-.Fc
-.Bd -ragged -offset indent
-Checks if
-.Fa path
-exists.
-.Ed
-.Pp
-.Ft pid_t
-.Fo atf::utils::fork
-.Fa "void"
-.Fc
-.Bd -ragged -offset indent
-Forks a process and redirects the standard output and standard error of the
-child to files for later validation with
-.Fn atf::utils::wait .
-Fails the test case if the fork fails, so this does not return an error.
-.Ed
-.Pp
-.Ft bool
-.Fo atf::utils::grep_collection
-.Fa "const std::string& regexp"
-.Fa "const Collection& collection"
-.Fc
-.Bd -ragged -offset indent
-Searches for the regular expression
-.Fa regexp
-in any of the strings contained in the
-.Fa collection .
-This is a template that accepts any one-dimensional container of strings.
-.Ed
-.Pp
-.Ft bool
-.Fo atf::utils::grep_file
-.Fa "const std::string& regexp"
-.Fa "const std::string& path"
-.Fc
-.Bd -ragged -offset indent
-Searches for the regular expression
-.Fa regexp
-in the file
-.Fa path .
-The variable arguments are used to construct the regular expression.
-.Ed
-.Pp
-.Ft bool
-.Fo atf::utils::grep_string
-.Fa "const std::string& regexp"
-.Fa "const std::string& str"
-.Fc
-.Bd -ragged -offset indent
-Searches for the regular expression
-.Fa regexp
-in the string
-.Fa str .
-.Ed
-.Ft void
-.Fo atf::utils::redirect
-.Fa "const int fd"
-.Fa "const std::string& path"
-.Fc
-.Bd -ragged -offset indent
-Redirects the given file descriptor
-.Fa fd
-to the file
-.Fa path .
-This function exits the process in case of an error and does not properly mark
-the test case as failed.
-As a result, it should only be used in subprocesses of the test case; specially
-those spawned by
-.Fn atf::utils::fork .
-.Ed
-.Pp
-.Ft void
-.Fo atf::utils::wait
-.Fa "const pid_t pid"
-.Fa "const int expected_exit_status"
-.Fa "const std::string& expected_stdout"
-.Fa "const std::string& expected_stderr"
-.Fc
-.Bd -ragged -offset indent
-Waits and validates the result of a subprocess spawned with
-.Fn atf::utils::wait .
-The validation involves checking that the subprocess exited cleanly and returned
-the code specified in
-.Fa expected_exit_status
-and that its standard output and standard error match the strings given in
-.Fa expected_stdout
-and
-.Fa expected_stderr .
-.Pp
-If any of the
-.Fa expected_stdout
-or
-.Fa expected_stderr
-strings are prefixed with
-.Sq save: ,
-then they specify the name of the file into which to store the stdout or stderr
-of the subprocess, and no comparison is performed.
-.Ed
-.Sh EXAMPLES
-The following shows a complete test program with a single test case that
-validates the addition operator:
-.Bd -literal -offset indent
-#include <atf-c++.hpp>
-
-ATF_TEST_CASE(addition);
-ATF_TEST_CASE_HEAD(addition)
-{
- set_md_var("descr", "Sample tests for the addition operator");
-}
-ATF_TEST_CASE_BODY(addition)
-{
- ATF_REQUIRE_EQ(0 + 0, 0);
- ATF_REQUIRE_EQ(0 + 1, 1);
- ATF_REQUIRE_EQ(1 + 0, 1);
-
- ATF_REQUIRE_EQ(1 + 1, 2);
-
- ATF_REQUIRE_EQ(100 + 200, 300);
-}
-
-ATF_TEST_CASE(open_failure);
-ATF_TEST_CASE_HEAD(open_failure)
-{
- set_md_var("descr", "Sample tests for the open function");
-}
-ATF_TEST_CASE_BODY(open_failure)
-{
- ATF_REQUIRE_ERRNO(ENOENT, open("non-existent", O_RDONLY) == -1);
-}
-
-ATF_TEST_CASE(known_bug);
-ATF_TEST_CASE_HEAD(known_bug)
-{
- set_md_var("descr", "Reproduces a known bug");
-}
-ATF_TEST_CASE_BODY(known_bug)
-{
- expect_fail("See bug number foo/bar");
- ATF_REQUIRE_EQ(3, 1 + 1);
- expect_pass();
- ATF_REQUIRE_EQ(3, 1 + 2);
-}
-
-ATF_INIT_TEST_CASES(tcs)
-{
- ATF_ADD_TEST_CASE(tcs, addition);
- ATF_ADD_TEST_CASE(tcs, open_failure);
- ATF_ADD_TEST_CASE(tcs, known_bug);
-}
-.Ed
-.Sh SEE ALSO
-.Xr atf-test-program 1 ,
-.Xr atf-test-case 4
diff --git a/contrib/atf/atf-c++/atf-c++.3 b/contrib/atf/atf-c++/atf-c++.3
index 984ec93..601efaf 100644
--- a/contrib/atf/atf-c++/atf-c++.3
+++ b/contrib/atf/atf-c++/atf-c++.3
@@ -22,7 +22,7 @@
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Dd October 13, 2014
+.Dd March 6, 2017
.Dt ATF-C++ 3
.Os
.Sh NAME
@@ -145,10 +145,10 @@ ATF provides a C++ programming interface to implement test programs.
C++-based test programs follow this template:
.Bd -literal -offset indent
extern "C" {
-.Ns ... C-specific includes go here ...
+\&... C-specific includes go here ...
}
-.Ns ... C++-specific includes go here ...
+\&... C++-specific includes go here ...
#include <atf-c++.hpp>
@@ -182,7 +182,7 @@ ATF_TEST_CASE_BODY(tc3)
... third test case's body ...
}
-.Ns ... additional test cases ...
+\&... additional test cases ...
ATF_INIT_TEST_CASES(tcs)
{
@@ -202,7 +202,7 @@ To define test cases, one can use the
.Fn ATF_TEST_CASE_WITH_CLEANUP
or the
.Fn ATF_TEST_CASE_WITHOUT_HEAD
-macros, which take a single parameter specifiying the test case's
+macros, which take a single parameter specifying the test case's
name.
.Fn ATF_TEST_CASE ,
requires to define a head and a body for the test case,
@@ -232,7 +232,7 @@ opening and closing brackets.
Additionally, the
.Fn ATF_TEST_CASE_NAME
macro can be used to obtain the name of the class corresponding to a
-particular test case, as the name is internally manged by the library to
+particular test case, as the name is internally managed by the library to
prevent clashes with other user identifiers.
Similarly, the
.Fn ATF_TEST_CASE_USE
diff --git a/contrib/atf/atf-c/atf-c-api.3 b/contrib/atf/atf-c/atf-c-api.3
deleted file mode 100644
index b3b3086..0000000
--- a/contrib/atf/atf-c/atf-c-api.3
+++ /dev/null
@@ -1,772 +0,0 @@
-.\"
-.\" Automated Testing Framework (atf)
-.\"
-.\" Copyright (c) 2008 The NetBSD Foundation, Inc.
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
-.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
-.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
-.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.\"
-.Dd March 2, 2014
-.Dt ATF-C-API 3
-.Os
-.Sh NAME
-.Nm atf-c-api ,
-.Nm ATF_CHECK ,
-.Nm ATF_CHECK_MSG ,
-.Nm ATF_CHECK_EQ ,
-.Nm ATF_CHECK_EQ_MSG ,
-.Nm ATF_CHECK_MATCH ,
-.Nm ATF_CHECK_MATCH_MSG ,
-.Nm ATF_CHECK_STREQ ,
-.Nm ATF_CHECK_STREQ_MSG ,
-.Nm ATF_CHECK_ERRNO ,
-.Nm ATF_REQUIRE ,
-.Nm ATF_REQUIRE_MSG ,
-.Nm ATF_REQUIRE_EQ ,
-.Nm ATF_REQUIRE_EQ_MSG ,
-.Nm ATF_REQUIRE_MATCH ,
-.Nm ATF_REQUIRE_MATCH_MSG ,
-.Nm ATF_REQUIRE_STREQ ,
-.Nm ATF_REQUIRE_STREQ_MSG ,
-.Nm ATF_REQUIRE_ERRNO ,
-.Nm ATF_TC ,
-.Nm ATF_TC_BODY ,
-.Nm ATF_TC_BODY_NAME ,
-.Nm ATF_TC_CLEANUP ,
-.Nm ATF_TC_CLEANUP_NAME ,
-.Nm ATF_TC_HEAD ,
-.Nm ATF_TC_HEAD_NAME ,
-.Nm ATF_TC_NAME ,
-.Nm ATF_TC_WITH_CLEANUP ,
-.Nm ATF_TC_WITHOUT_HEAD ,
-.Nm ATF_TP_ADD_TC ,
-.Nm ATF_TP_ADD_TCS ,
-.Nm atf_tc_get_config_var ,
-.Nm atf_tc_get_config_var_wd ,
-.Nm atf_tc_get_config_var_as_bool ,
-.Nm atf_tc_get_config_var_as_bool_wd ,
-.Nm atf_tc_get_config_var_as_long ,
-.Nm atf_tc_get_config_var_as_long_wd ,
-.Nm atf_no_error ,
-.Nm atf_tc_expect_death ,
-.Nm atf_tc_expect_exit ,
-.Nm atf_tc_expect_fail ,
-.Nm atf_tc_expect_pass ,
-.Nm atf_tc_expect_signal ,
-.Nm atf_tc_expect_timeout ,
-.Nm atf_tc_fail ,
-.Nm atf_tc_fail_nonfatal ,
-.Nm atf_tc_pass ,
-.Nm atf_tc_skip ,
-.Nm atf_utils_cat_file ,
-.Nm atf_utils_compare_file ,
-.Nm atf_utils_copy_file ,
-.Nm atf_utils_create_file ,
-.Nm atf_utils_file_exists ,
-.Nm atf_utils_fork ,
-.Nm atf_utils_free_charpp ,
-.Nm atf_utils_grep_file ,
-.Nm atf_utils_grep_string ,
-.Nm atf_utils_readline ,
-.Nm atf_utils_redirect ,
-.Nm atf_utils_wait
-.Nd C API to write ATF-based test programs
-.Sh SYNOPSIS
-.In atf-c.h
-.Fn ATF_CHECK "expression"
-.Fn ATF_CHECK_MSG "expression" "fail_msg_fmt" ...
-.Fn ATF_CHECK_EQ "expression_1" "expression_2"
-.Fn ATF_CHECK_EQ_MSG "expression_1" "expression_2" "fail_msg_fmt" ...
-.Fn ATF_CHECK_MATCH "regexp" "string"
-.Fn ATF_CHECK_MATCH_MSG "regexp" "string" "fail_msg_fmt" ...
-.Fn ATF_CHECK_STREQ "string_1" "string_2"
-.Fn ATF_CHECK_STREQ_MSG "string_1" "string_2" "fail_msg_fmt" ...
-.Fn ATF_CHECK_ERRNO "exp_errno" "bool_expression"
-.Fn ATF_REQUIRE "expression"
-.Fn ATF_REQUIRE_MSG "expression" "fail_msg_fmt" ...
-.Fn ATF_REQUIRE_EQ "expression_1" "expression_2"
-.Fn ATF_REQUIRE_EQ_MSG "expression_1" "expression_2" "fail_msg_fmt" ...
-.Fn ATF_REQUIRE_MATCH "regexp" "string"
-.Fn ATF_REQUIRE_MATCH_MSG "regexp" "string" "fail_msg_fmt" ...
-.Fn ATF_REQUIRE_STREQ "string_1" "string_2"
-.Fn ATF_REQUIRE_STREQ_MSG "string_1" "string_2" "fail_msg_fmt" ...
-.Fn ATF_REQUIRE_ERRNO "exp_errno" "bool_expression"
-.Fn ATF_TC "name"
-.Fn ATF_TC_BODY "name" "tc"
-.Fn ATF_TC_BODY_NAME "name"
-.Fn ATF_TC_CLEANUP "name" "tc"
-.Fn ATF_TC_CLEANUP_NAME "name"
-.Fn ATF_TC_HEAD "name" "tc"
-.Fn ATF_TC_HEAD_NAME "name"
-.Fn ATF_TC_NAME "name"
-.Fn ATF_TC_WITH_CLEANUP "name"
-.Fn ATF_TC_WITHOUT_HEAD "name"
-.Fn ATF_TP_ADD_TC "tp_name" "tc_name"
-.Fn ATF_TP_ADD_TCS "tp_name"
-.Fn atf_tc_get_config_var "tc" "varname"
-.Fn atf_tc_get_config_var_wd "tc" "variable_name" "default_value"
-.Fn atf_tc_get_config_var_as_bool "tc" "variable_name"
-.Fn atf_tc_get_config_var_as_bool_wd "tc" "variable_name" "default_value"
-.Fn atf_tc_get_config_var_as_long "tc" "variable_name"
-.Fn atf_tc_get_config_var_as_long_wd "tc" "variable_name" "default_value"
-.Fn atf_no_error
-.Fn atf_tc_expect_death "reason" "..."
-.Fn atf_tc_expect_exit "exitcode" "reason" "..."
-.Fn atf_tc_expect_fail "reason" "..."
-.Fn atf_tc_expect_pass
-.Fn atf_tc_expect_signal "signo" "reason" "..."
-.Fn atf_tc_expect_timeout "reason" "..."
-.Fn atf_tc_fail "reason"
-.Fn atf_tc_fail_nonfatal "reason"
-.Fn atf_tc_pass
-.Fn atf_tc_skip "reason"
-.Ft void
-.Fo atf_utils_cat_file
-.Fa "const char *file"
-.Fa "const char *prefix"
-.Fc
-.Ft bool
-.Fo atf_utils_compare_file
-.Fa "const char *file"
-.Fa "const char *contents"
-.Fc
-.Ft void
-.Fo atf_utils_copy_file
-.Fa "const char *source"
-.Fa "const char *destination"
-.Fc
-.Ft void
-.Fo atf_utils_create_file
-.Fa "const char *file"
-.Fa "const char *contents"
-.Fa "..."
-.Fc
-.Ft void
-.Fo atf_utils_file_exists
-.Fa "const char *file"
-.Fc
-.Ft pid_t
-.Fo atf_utils_fork
-.Fa "void"
-.Fc
-.Ft void
-.Fo atf_utils_free_charpp
-.Fa "char **argv"
-.Fc
-.Ft bool
-.Fo atf_utils_grep_file
-.Fa "const char *regexp"
-.Fa "const char *file"
-.Fa "..."
-.Fc
-.Ft bool
-.Fo atf_utils_grep_string
-.Fa "const char *regexp"
-.Fa "const char *str"
-.Fa "..."
-.Fc
-.Ft char *
-.Fo atf_utils_readline
-.Fa "int fd"
-.Fc
-.Ft void
-.Fo atf_utils_redirect
-.Fa "const int fd"
-.Fa "const char *file"
-.Fc
-.Ft void
-.Fo atf_utils_wait
-.Fa "const pid_t pid"
-.Fa "const int expected_exit_status"
-.Fa "const char *expected_stdout"
-.Fa "const char *expected_stderr"
-.Fc
-.Sh DESCRIPTION
-ATF provides a C programming interface to implement test programs.
-C-based test programs follow this template:
-.Bd -literal -offset indent
-.Ns ... C-specific includes go here ...
-
-#include <atf-c.h>
-
-ATF_TC(tc1);
-ATF_TC_HEAD(tc1, tc)
-{
- ... first test case's header ...
-}
-ATF_TC_BODY(tc1, tc)
-{
- ... first test case's body ...
-}
-
-ATF_TC_WITH_CLEANUP(tc2);
-ATF_TC_HEAD(tc2, tc)
-{
- ... second test case's header ...
-}
-ATF_TC_BODY(tc2, tc)
-{
- ... second test case's body ...
-}
-ATF_TC_CLEANUP(tc2, tc)
-{
- ... second test case's cleanup ...
-}
-
-ATF_TC_WITHOUT_HEAD(tc3);
-ATF_TC_BODY(tc3, tc)
-{
- ... third test case's body ...
-}
-
-.Ns ... additional test cases ...
-
-ATF_TP_ADD_TCS(tp)
-{
- ATF_TP_ADD_TC(tcs, tc1);
- ATF_TP_ADD_TC(tcs, tc2);
- ATF_TP_ADD_TC(tcs, tc3);
- ... add additional test cases ...
-
- return atf_no_error();
-}
-.Ed
-.Ss Definition of test cases
-Test cases have an identifier and are composed of three different parts:
-the header, the body and an optional cleanup routine, all of which are
-described in
-.Xr atf-test-case 4 .
-To define test cases, one can use the
-.Fn ATF_TC ,
-.Fn ATF_TC_WITH_CLEANUP
-or the
-.Fn ATF_TC_WITHOUT_HEAD
-macros, which take a single parameter specifiying the test case's name.
-.Fn ATF_TC ,
-requires to define a head and a body for the test case,
-.Fn ATF_TC_WITH_CLEANUP
-requires to define a head, a body and a cleanup for the test case and
-.Fn ATF_TC_WITHOUT_HEAD
-requires only a body for the test case.
-It is important to note that these
-.Em do not
-set the test case up for execution when the program is run.
-In order to do so, a later registration is needed with the
-.Fn ATF_TP_ADD_TC
-macro detailed in
-.Sx Program initialization .
-.Pp
-Later on, one must define the three parts of the body by means of three
-functions.
-Their headers are given by the
-.Fn ATF_TC_HEAD ,
-.Fn ATF_TC_BODY
-and
-.Fn ATF_TC_CLEANUP
-macros, all of which take the test case name provided to the
-.Fn ATF_TC
-.Fn ATF_TC_WITH_CLEANUP ,
-or
-.Fn ATF_TC_WITHOUT_HEAD
-macros and the name of the variable that will hold a pointer to the
-test case data.
-Following each of these, a block of code is expected, surrounded by the
-opening and closing brackets.
-.Ss Program initialization
-The library provides a way to easily define the test program's
-.Fn main
-function.
-You should never define one on your own, but rely on the
-library to do it for you.
-This is done by using the
-.Fn ATF_TP_ADD_TCS
-macro, which is passed the name of the object that will hold the test
-cases; i.e. the test program instance.
-This name can be whatever you want as long as it is a valid variable
-identifier.
-.Pp
-After the macro, you are supposed to provide the body of a function, which
-should only use the
-.Fn ATF_TP_ADD_TC
-macro to register the test cases the test program will execute and return
-a success error code.
-The first parameter of this macro matches the name you provided in the
-former call.
-The success status can be returned using the
-.Fn atf_no_error
-function.
-.Ss Header definitions
-The test case's header can define the meta-data by using the
-.Fn atf_tc_set_md_var
-method, which takes three parameters: the first one points to the test
-case data, the second one specifies the meta-data variable to be set
-and the third one specifies its value.
-Both of them are strings.
-.Ss Configuration variables
-The test case has read-only access to the current configuration variables
-by means of the
-.Ft bool
-.Fn atf_tc_has_config_var ,
-.Ft const char *
-.Fn atf_tc_get_config_var ,
-.Ft const char *
-.Fn atf_tc_get_config_var_wd ,
-.Ft bool
-.Fn atf_tc_get_config_var_as_bool ,
-.Ft bool
-.Fn atf_tc_get_config_var_as_bool_wd ,
-.Ft long
-.Fn atf_tc_get_config_var_as_long ,
-and the
-.Ft long
-.Fn atf_tc_get_config_var_as_long_wd
-functions, which can be called in any of the three parts of a test case.
-.Pp
-The
-.Sq _wd
-variants take a default value for the variable which is returned if the
-variable is not defined.
-The other functions without the
-.Sq _wd
-suffix
-.Em require
-the variable to be defined.
-.Ss Access to the source directory
-It is possible to get the path to the test case's source directory from any
-of its three components by querying the
-.Sq srcdir
-configuration variable.
-.Ss Requiring programs
-Aside from the
-.Va require.progs
-meta-data variable available in the header only, one can also check for
-additional programs in the test case's body by using the
-.Fn atf_tc_require_prog
-function, which takes the base name or full path of a single binary.
-Relative paths are forbidden.
-If it is not found, the test case will be automatically skipped.
-.Ss Test case finalization
-The test case finalizes either when the body reaches its end, at which
-point the test is assumed to have
-.Em passed ,
-unless any non-fatal errors were raised using
-.Fn atf_tc_fail_nonfatal ,
-or at any explicit call to
-.Fn atf_tc_pass ,
-.Fn atf_tc_fail
-or
-.Fn atf_tc_skip .
-These three functions terminate the execution of the test case immediately.
-The cleanup routine will be processed afterwards in a completely automated
-way, regardless of the test case's termination reason.
-.Pp
-.Fn atf_tc_pass
-does not take any parameters.
-.Fn atf_tc_fail ,
-.Fn atf_tc_fail_nonfatal
-and
-.Fn atf_tc_skip
-take a format string and a variable list of parameters, which describe, in
-a user-friendly manner, why the test case failed or was skipped,
-respectively.
-It is very important to provide a clear error message in both cases so that
-the user can quickly know why the test did not pass.
-.Ss Expectations
-Everything explained in the previous section changes when the test case
-expectations are redefined by the programmer.
-.Pp
-Each test case has an internal state called
-.Sq expect
-that describes what the test case expectations are at any point in time.
-The value of this property can change during execution by any of:
-.Bl -tag -width indent
-.It Fn atf_tc_expect_death "reason" "..."
-Expects the test case to exit prematurely regardless of the nature of the
-exit.
-.It Fn atf_tc_expect_exit "exitcode" "reason" "..."
-Expects the test case to exit cleanly.
-If
-.Va exitcode
-is not
-.Sq -1 ,
-the runtime engine will validate that the exit code of the test case
-matches the one provided in this call.
-Otherwise, the exact value will be ignored.
-.It Fn atf_tc_expect_fail "reason" "..."
-Any failure (be it fatal or non-fatal) raised in this mode is recorded.
-However, such failures do not report the test case as failed; instead, the
-test case finalizes cleanly and is reported as
-.Sq expected failure ;
-this report includes the provided
-.Fa reason
-as part of it.
-If no error is raised while running in this mode, then the test case is
-reported as
-.Sq failed .
-.Pp
-This mode is useful to reproduce actual known bugs in tests.
-Whenever the developer fixes the bug later on, the test case will start
-reporting a failure, signaling the developer that the test case must be
-adjusted to the new conditions.
-In this situation, it is useful, for example, to set
-.Fa reason
-as the bug number for tracking purposes.
-.It Fn atf_tc_expect_pass
-This is the normal mode of execution.
-In this mode, any failure is reported as such to the user and the test case
-is marked as
-.Sq failed .
-.It Fn atf_tc_expect_signal "signo" "reason" "..."
-Expects the test case to terminate due to the reception of a signal.
-If
-.Va signo
-is not
-.Sq -1 ,
-the runtime engine will validate that the signal that terminated the test
-case matches the one provided in this call.
-Otherwise, the exact value will be ignored.
-.It Fn atf_tc_expect_timeout "reason" "..."
-Expects the test case to execute for longer than its timeout.
-.El
-.Ss Helper macros for common checks
-The library provides several macros that are very handy in multiple
-situations.
-These basically check some condition after executing a given statement or
-processing a given expression and, if the condition is not met, they
-report the test case as failed.
-.Pp
-The
-.Sq REQUIRE
-variant of the macros immediately abort the test case as soon as an error
-condition is detected by calling the
-.Fn atf_tc_fail
-function.
-Use this variant whenever it makes no sense to continue the execution of a
-test case when the checked condition is not met.
-The
-.Sq CHECK
-variant, on the other hand, reports a failure as soon as it is encountered
-using the
-.Fn atf_tc_fail_nonfatal
-function, but the execution of the test case continues as if nothing had
-happened.
-Use this variant whenever the checked condition is important as a result of
-the test case, but there are other conditions that can be subsequently
-checked on the same run without aborting.
-.Pp
-Additionally, the
-.Sq MSG
-variants take an extra set of parameters to explicitly specify the failure
-message.
-This failure message is formatted according to the
-.Xr printf 3
-formatters.
-.Pp
-.Fn ATF_CHECK ,
-.Fn ATF_CHECK_MSG ,
-.Fn ATF_REQUIRE
-and
-.Fn ATF_REQUIRE_MSG
-take an expression and fail if the expression evaluates to false.
-.Pp
-.Fn ATF_CHECK_EQ ,
-.Fn ATF_CHECK_EQ_MSG ,
-.Fn ATF_REQUIRE_EQ
-and
-.Fn ATF_REQUIRE_EQ_MSG
-take two expressions and fail if the two evaluated values are not equal.
-.Pp
-.Fn ATF_CHECK_MATCH ,
-.Fn ATF_CHECK_MATCH_MSG ,
-.Fn ATF_REQUIRE_MATCH
-and
-.Fn ATF_REQUIRE_MATCH_MSG
-take a regular expression and a string and fail if the regular expression does
-not match the given string.
-Note that the regular expression is not anchored, so it will match anywhere in
-the string.
-.Pp
-.Fn ATF_CHECK_STREQ ,
-.Fn ATF_CHECK_STREQ_MSG ,
-.Fn ATF_REQUIRE_STREQ
-and
-.Fn ATF_REQUIRE_STREQ_MSG
-take two strings and fail if the two are not equal character by character.
-.Pp
-.Fn ATF_CHECK_ERRNO
-and
-.Fn ATF_REQUIRE_ERRNO
-take, first, the error code that the check is expecting to find in the
-.Va errno
-variable and, second, a boolean expression that, if evaluates to true,
-means that a call failed and
-.Va errno
-has to be checked against the first value.
-.Ss Utility functions
-The following functions are provided as part of the
-.Nm
-API to simplify the creation of a variety of tests.
-In particular, these are useful to write tests for command-line interfaces.
-.Pp
-.Ft void
-.Fo atf_utils_cat_file
-.Fa "const char *file"
-.Fa "const char *prefix"
-.Fc
-.Bd -ragged -offset indent
-Prints the contents of
-.Fa file
-to the standard output, prefixing every line with the string in
-.Fa prefix .
-.Ed
-.Pp
-.Ft bool
-.Fo atf_utils_compare_file
-.Fa "const char *file"
-.Fa "const char *contents"
-.Fc
-.Bd -ragged -offset indent
-Returns true if the given
-.Fa file
-matches exactly the expected inlined
-.Fa contents .
-.Ed
-.Pp
-.Ft void
-.Fo atf_utils_copy_file
-.Fa "const char *source"
-.Fa "const char *destination"
-.Fc
-.Bd -ragged -offset indent
-Copies the file
-.Fa source
-to
-.Fa destination .
-The permissions of the file are preserved during the code.
-.Ed
-.Pp
-.Ft void
-.Fo atf_utils_create_file
-.Fa "const char *file"
-.Fa "const char *contents"
-.Fa "..."
-.Fc
-.Bd -ragged -offset indent
-Creates
-.Fa file
-with the text given in
-.Fa contents ,
-which is a formatting string that uses the rest of the variable arguments.
-.Ed
-.Pp
-.Ft void
-.Fo atf_utils_file_exists
-.Fa "const char *file"
-.Fc
-.Bd -ragged -offset indent
-Checks if
-.Fa file
-exists.
-.Ed
-.Pp
-.Ft pid_t
-.Fo atf_utils_fork
-.Fa "void"
-.Fc
-.Bd -ragged -offset indent
-Forks a process and redirects the standard output and standard error of the
-child to files for later validation with
-.Fn atf_utils_wait .
-Fails the test case if the fork fails, so this does not return an error.
-.Ed
-.Pp
-.Ft void
-.Fo atf_utils_free_charpp
-.Fa "char **argv"
-.Fc
-.Bd -ragged -offset indent
-Frees a dynamically-allocated array of dynamically-allocated strings.
-.Ed
-.Pp
-.Ft bool
-.Fo atf_utils_grep_file
-.Fa "const char *regexp"
-.Fa "const char *file"
-.Fa "..."
-.Fc
-.Bd -ragged -offset indent
-Searches for the
-.Fa regexp ,
-which is a formatting string representing the regular expression,
-in the
-.Fa file .
-The variable arguments are used to construct the regular expression.
-.Ed
-.Pp
-.Ft bool
-.Fo atf_utils_grep_string
-.Fa "const char *regexp"
-.Fa "const char *str"
-.Fa "..."
-.Fc
-.Bd -ragged -offset indent
-Searches for the
-.Fa regexp ,
-which is a formatting string representing the regular expression,
-in the literal string
-.Fa str .
-The variable arguments are used to construct the regular expression.
-.Ed
-.Pp
-.Ft char *
-.Fo atf_utils_readline
-.Fa "int fd"
-.Fc
-.Bd -ragged -offset indent
-Reads a line from the file descriptor
-.Fa fd .
-The line, if any, is returned as a dynamically-allocated buffer that must be
-released with
-.Xr free 3 .
-If there was nothing to read, returns
-.Sq NULL .
-.Ed
-.Pp
-.Ft void
-.Fo atf_utils_redirect
-.Fa "const int fd"
-.Fa "const char *file"
-.Fc
-.Bd -ragged -offset indent
-Redirects the given file descriptor
-.Fa fd
-to
-.Fa file .
-This function exits the process in case of an error and does not properly mark
-the test case as failed.
-As a result, it should only be used in subprocesses of the test case; specially
-those spawned by
-.Fn atf_utils_fork .
-.Ed
-.Pp
-.Ft void
-.Fo atf_utils_wait
-.Fa "const pid_t pid"
-.Fa "const int expected_exit_status"
-.Fa "const char *expected_stdout"
-.Fa "const char *expected_stderr"
-.Fc
-.Bd -ragged -offset indent
-Waits and validates the result of a subprocess spawned with
-.Fn atf_utils_wait .
-The validation involves checking that the subprocess exited cleanly and returned
-the code specified in
-.Fa expected_exit_status
-and that its standard output and standard error match the strings given in
-.Fa expected_stdout
-and
-.Fa expected_stderr .
-.Pp
-If any of the
-.Fa expected_stdout
-or
-.Fa expected_stderr
-strings are prefixed with
-.Sq save: ,
-then they specify the name of the file into which to store the stdout or stderr
-of the subprocess, and no comparison is performed.
-.Ed
-.Sh EXAMPLES
-The following shows a complete test program with a single test case that
-validates the addition operator:
-.Bd -literal -offset indent
-#include <atf-c.h>
-
-ATF_TC(addition);
-ATF_TC_HEAD(addition, tc)
-{
- atf_tc_set_md_var(tc, "descr",
- "Sample tests for the addition operator");
-}
-ATF_TC_BODY(addition, tc)
-{
- ATF_CHECK_EQ(0 + 0, 0);
- ATF_CHECK_EQ(0 + 1, 1);
- ATF_CHECK_EQ(1 + 0, 1);
-
- ATF_CHECK_EQ(1 + 1, 2);
-
- ATF_CHECK_EQ(100 + 200, 300);
-}
-
-ATF_TC(string_formatting);
-ATF_TC_HEAD(string_formatting, tc)
-{
- atf_tc_set_md_var(tc, "descr",
- "Sample tests for the snprintf");
-}
-ATF_TC_BODY(string_formatting, tc)
-{
- char buf[1024];
- snprintf(buf, sizeof(buf), "a %s", "string");
- ATF_CHECK_STREQ_MSG("a string", buf, "%s is not working");
-}
-
-ATF_TC(open_failure);
-ATF_TC_HEAD(open_failure, tc)
-{
- atf_tc_set_md_var(tc, "descr",
- "Sample tests for the open function");
-}
-ATF_TC_BODY(open_failure, tc)
-{
- ATF_CHECK_ERRNO(ENOENT, open("non-existent", O_RDONLY) == -1);
-}
-
-ATF_TC(known_bug);
-ATF_TC_HEAD(known_bug, tc)
-{
- atf_tc_set_md_var(tc, "descr",
- "Reproduces a known bug");
-}
-ATF_TC_BODY(known_bug, tc)
-{
- atf_tc_expect_fail("See bug number foo/bar");
- ATF_CHECK_EQ(3, 1 + 1);
- atf_tc_expect_pass();
- ATF_CHECK_EQ(3, 1 + 2);
-}
-
-ATF_TP_ADD_TCS(tp)
-{
- ATF_TP_ADD_TC(tp, addition);
- ATF_TP_ADD_TC(tp, string_formatting);
- ATF_TP_ADD_TC(tp, open_failure);
- ATF_TP_ADD_TC(tp, known_bug);
-
- return atf_no_error();
-}
-.Ed
-.Sh SEE ALSO
-.Xr atf-test-program 1 ,
-.Xr atf-test-case 4
diff --git a/contrib/atf/atf-c/atf-c.3 b/contrib/atf/atf-c/atf-c.3
index edb7207..d3e6b90 100644
--- a/contrib/atf/atf-c/atf-c.3
+++ b/contrib/atf/atf-c/atf-c.3
@@ -22,7 +22,7 @@
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Dd October 13, 2014
+.Dd March 6, 2017
.Dt ATF-C 3
.Os
.Sh NAME
@@ -203,7 +203,7 @@
ATF provides a C programming interface to implement test programs.
C-based test programs follow this template:
.Bd -literal -offset indent
-.Ns ... C-specific includes go here ...
+\&... C-specific includes go here ...
#include <atf-c.h>
@@ -237,7 +237,7 @@ ATF_TC_BODY(tc3, tc)
... third test case's body ...
}
-.Ns ... additional test cases ...
+\&... additional test cases ...
ATF_TP_ADD_TCS(tp)
{
@@ -259,7 +259,7 @@ To define test cases, one can use the
.Fn ATF_TC_WITH_CLEANUP
or the
.Fn ATF_TC_WITHOUT_HEAD
-macros, which take a single parameter specifiying the test case's name.
+macros, which take a single parameter specifying the test case's name.
.Fn ATF_TC ,
requires to define a head and a body for the test case,
.Fn ATF_TC_WITH_CLEANUP
@@ -299,7 +299,7 @@ library to do it for you.
This is done by using the
.Fn ATF_TP_ADD_TCS
macro, which is passed the name of the object that will hold the test
-cases; i.e. the test program instance.
+cases, i.e., the test program instance.
This name can be whatever you want as long as it is a valid variable
identifier.
.Pp
diff --git a/contrib/atf/atf-sh/atf-check.1 b/contrib/atf/atf-sh/atf-check.1
index a3bd379..a423e3a 100644
--- a/contrib/atf/atf-sh/atf-check.1
+++ b/contrib/atf/atf-sh/atf-check.1
@@ -22,7 +22,7 @@
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Dd October 5, 2014
+.Dd March 6, 2017
.Dt ATF-CHECK 1
.Os
.Sh NAME
@@ -40,10 +40,12 @@
executes a given command and analyzes its results, including
exit code, stdout and stderr.
.Pp
-.Em Test cases must use
-.Em Xr atf-sh 3 Ns ' Ns s
-.Em Nm atf_check
-.Em builtin function instead of calling this utility directly.
+.Bf Em
+Test cases must use
+.Xr atf-sh 3 Ns ' Ns s
+.Nm atf_check
+builtin function instead of calling this utility directly.
+.Ef
.Pp
In the first synopsis form,
.Nm
@@ -119,9 +121,6 @@ as a shell command line, executing it with the system shell defined by
You should avoid using this flag if at all possible to prevent shell quoting
issues.
.El
-.Sh EXIT STATUS
-.Nm
-exits 0 on success, and other (unspecified) value on failure.
.Sh ENVIRONMENT
.Bl -tag -width ATFXSHELLXX -compact
.It Va ATF_SHELL
@@ -129,6 +128,9 @@ Path to the system shell to be used when the
.Fl x
is given to run commands.
.El
+.Sh EXIT STATUS
+.Nm
+exits 0 on success, and other (unspecified) value on failure.
.Sh EXAMPLES
The following are sample invocations from within a test case.
Note that we use the
diff --git a/contrib/atf/atf-sh/atf-sh-api.3 b/contrib/atf/atf-sh/atf-sh-api.3
deleted file mode 100644
index a30aee7..0000000
--- a/contrib/atf/atf-sh/atf-sh-api.3
+++ /dev/null
@@ -1,340 +0,0 @@
-.\"
-.\" Automated Testing Framework (atf)
-.\"
-.\" Copyright (c) 2008 The NetBSD Foundation, Inc.
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
-.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
-.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
-.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.\"
-.Dd March 2, 2014
-.Dt ATF-SH-API 3
-.Os
-.Sh NAME
-.Nm atf_add_test_case ,
-.Nm atf_check ,
-.Nm atf_check_equal ,
-.Nm atf_config_get ,
-.Nm atf_config_has ,
-.Nm atf_expect_death ,
-.Nm atf_expect_exit ,
-.Nm atf_expect_fail ,
-.Nm atf_expect_pass ,
-.Nm atf_expect_signal ,
-.Nm atf_expect_timeout ,
-.Nm atf_fail ,
-.Nm atf_get ,
-.Nm atf_get_srcdir ,
-.Nm atf_pass ,
-.Nm atf_require_prog ,
-.Nm atf_set ,
-.Nm atf_skip ,
-.Nm atf_test_case
-.Nd POSIX shell API to write ATF-based test programs
-.Sh SYNOPSIS
-.Fn atf_add_test_case "name"
-.Fn atf_check "command"
-.Fn atf_check_equal "expr1" "expr2"
-.Fn atf_config_get "var_name"
-.Fn atf_config_has "var_name"
-.Fn atf_expect_death "reason" "..."
-.Fn atf_expect_exit "exitcode" "reason" "..."
-.Fn atf_expect_fail "reason" "..."
-.Fn atf_expect_pass
-.Fn atf_expect_signal "signo" "reason" "..."
-.Fn atf_expect_timeout "reason" "..."
-.Fn atf_fail "reason"
-.Fn atf_get "var_name"
-.Fn atf_get_srcdir
-.Fn atf_pass
-.Fn atf_require_prog "prog_name"
-.Fn atf_set "var_name" "value"
-.Fn atf_skip "reason"
-.Fn atf_test_case "name" "cleanup"
-.Sh DESCRIPTION
-ATF
-provides a simple but powerful interface to easily write test programs in
-the POSIX shell language.
-These are extremely helpful given that they are trivial to write due to the
-language simplicity and the great deal of available external tools, so they
-are often ideal to test other applications at the user level.
-.Pp
-Test programs written using this library must be run using the
-.Xr atf-sh 1
-interpreter by putting the following on their very first line:
-.Bd -literal -offset indent
-#! /usr/bin/env atf-sh
-.Ed
-.Pp
-Shell-based test programs always follow this template:
-.Bd -literal -offset indent
-atf_test_case tc1
-tc1_head() {
- ... first test case's header ...
-}
-tc1_body() {
- ... first test case's body ...
-}
-
-atf_test_case tc2 cleanup
-tc2_head() {
- ... second test case's header ...
-}
-tc2_body() {
- ... second test case's body ...
-}
-tc2_cleanup() {
- ... second test case's cleanup ...
-}
-
-.Ns ... additional test cases ...
-
-atf_init_test_cases() {
- atf_add_test_case tc1
- atf_add_test_case tc2
- ... add additional test cases ...
-}
-.Ed
-.Ss Definition of test cases
-Test cases have an identifier and are composed of three different parts:
-the header, the body and an optional cleanup routine, all of which are
-described in
-.Xr atf-test-case 4 .
-To define test cases, one can use the
-.Fn atf_test_case
-function, which takes a first parameter specifiying the test case's
-name and instructs the library to set things up to accept it as a valid
-test case.
-The second parameter is optional and, if provided, must be
-.Sq cleanup ;
-providing this parameter allows defining a cleanup routine for the test
-case.
-It is important to note that this function
-.Em does not
-set the test case up for execution when the program is run.
-In order to do so, a later registration is needed through the
-.Fn atf_add_test_case
-function detailed in
-.Sx Program initialization .
-.Pp
-Later on, one must define the three parts of the body by providing two
-or three functions (remember that the cleanup routine is optional).
-These functions are named after the test case's identifier, and are
-.Fn <id>_head ,
-.Fn <id>_body
-and
-.Fn <id>_cleanup.
-None of these take parameters when executed.
-.Ss Program initialization
-The test program must define an
-.Fn atf_init_test_cases
-function, which is in charge of registering the test cases that will be
-executed at run time by using the
-.Fn atf_add_test_case
-function, which takes the name of a test case as its single parameter.
-This main function should not do anything else, except maybe sourcing
-auxiliary source files that define extra variables and functions.
-.Ss Configuration variables
-The test case has read-only access to the current configuration variables
-through the
-.Fn atf_config_has
-and
-.Fn atf_config_get
-methods.
-The former takes a single parameter specifying a variable name and returns
-a boolean indicating whether the variable is defined or not.
-The latter can take one or two parameters.
-If it takes only one, it specifies the variable from which to get the
-value, and this variable must be defined.
-If it takes two, the second one specifies a default value to be returned
-if the variable is not available.
-.Ss Access to the source directory
-It is possible to get the path to the test case's source directory from
-anywhere in the test program by using the
-.Fn atf_get_srcdir
-function.
-It is interesting to note that this can be used inside
-.Fn atf_init_test_cases
-to silently include additional helper files from the source directory.
-.Ss Requiring programs
-Aside from the
-.Va require.progs
-meta-data variable available in the header only, one can also check for
-additional programs in the test case's body by using the
-.Fn atf_require_prog
-function, which takes the base name or full path of a single binary.
-Relative paths are forbidden.
-If it is not found, the test case will be automatically skipped.
-.Ss Test case finalization
-The test case finalizes either when the body reaches its end, at which
-point the test is assumed to have
-.Em passed ,
-or at any explicit call to
-.Fn atf_pass ,
-.Fn atf_fail
-or
-.Fn atf_skip .
-These three functions terminate the execution of the test case immediately.
-The cleanup routine will be processed afterwards in a completely automated
-way, regardless of the test case's termination reason.
-.Pp
-.Fn atf_pass
-does not take any parameters.
-.Fn atf_fail
-and
-.Fn atf_skip
-take a single string parameter that describes why the test case failed or
-was skipped, respectively.
-It is very important to provide a clear error message in both cases so that
-the user can quickly know why the test did not pass.
-.Ss Expectations
-Everything explained in the previous section changes when the test case
-expectations are redefined by the programmer.
-.Pp
-Each test case has an internal state called
-.Sq expect
-that describes what the test case expectations are at any point in time.
-The value of this property can change during execution by any of:
-.Bl -tag -width indent
-.It Fn atf_expect_death "reason" "..."
-Expects the test case to exit prematurely regardless of the nature of the
-exit.
-.It Fn atf_expect_exit "exitcode" "reason" "..."
-Expects the test case to exit cleanly.
-If
-.Va exitcode
-is not
-.Sq -1 ,
-the runtime engine will validate that the exit code of the test case
-matches the one provided in this call.
-Otherwise, the exact value will be ignored.
-.It Fn atf_expect_fail "reason"
-Any failure raised in this mode is recorded, but such failures do not report
-the test case as failed; instead, the test case finalizes cleanly and is
-reported as
-.Sq expected failure ;
-this report includes the provided
-.Fa reason
-as part of it.
-If no error is raised while running in this mode, then the test case is
-reported as
-.Sq failed .
-.Pp
-This mode is useful to reproduce actual known bugs in tests.
-Whenever the developer fixes the bug later on, the test case will start
-reporting a failure, signaling the developer that the test case must be
-adjusted to the new conditions.
-In this situation, it is useful, for example, to set
-.Fa reason
-as the bug number for tracking purposes.
-.It Fn atf_expect_pass
-This is the normal mode of execution.
-In this mode, any failure is reported as such to the user and the test case
-is marked as
-.Sq failed .
-.It Fn atf_expect_signal "signo" "reason" "..."
-Expects the test case to terminate due to the reception of a signal.
-If
-.Va signo
-is not
-.Sq -1 ,
-the runtime engine will validate that the signal that terminated the test
-case matches the one provided in this call.
-Otherwise, the exact value will be ignored.
-.It Fn atf_expect_timeout "reason" "..."
-Expects the test case to execute for longer than its timeout.
-.El
-.Ss Helper functions for common checks
-.Fn atf_check [options] command [args]
-.Pp
-This function wraps the execution of the
-.Nm atf-check
-tool and makes the test case fail if the tool reports failure.
-You should always use this function instead of the tool in your scripts.
-For more details on the parameters of this function, refer to
-.Xr atf-check 1 .
-.Pp
-.Fn atf_check_equal expr1 expr2
-.Pp
-This function takes two expressions, evaluates them and, if their
-results differ, aborts the test case with an appropriate failure message.
-.Sh EXAMPLES
-The following shows a complete test program with a single test case that
-validates the addition operator:
-.Bd -literal -offset indent
-atf_test_case addition
-addition_head() {
- atf_set "descr" "Sample tests for the addition operator"
-}
-addition_body() {
- atf_check_equal $((0 + 0)) 0
- atf_check_equal $((0 + 1)) 1
- atf_check_equal $((1 + 0)) 0
-
- atf_check_equal $((1 + 1)) 2
-
- atf_check_equal $((100 + 200)) 300
-}
-
-atf_init_test_cases() {
- atf_add_test_case addition
-}
-.Ed
-.Pp
-This other example shows how to include a file with extra helper functions
-in the test program:
-.Bd -literal -offset indent
-.Ns ... definition of test cases ...
-
-atf_init_test_cases() {
- . $(atf_get_srcdir)/helper_functions.sh
-
- atf_add_test_case foo1
- atf_add_test_case foo2
-}
-.Ed
-.Pp
-This example demonstrates the use of the very useful
-.Fn atf_check
-function:
-.Bd -literal -offset indent
-# Check for silent output
-atf_check -s exit:0 -o empty -e empty 'true'
-
-# Check for silent output and failure
-atf_check -s exit:1 -o empty -e empty 'false'
-
-# Check for known stdout and silent stderr
-echo foo >expout
-atf_check -s exit:0 -o file:expout -e empty 'echo foo'
-
-# Generate a file for later inspection
-atf_check -s exit:0 -o save:stdout -e empty 'ls'
-grep foo ls || atf_fail "foo file not found in listing"
-
-# Or just do the match along the way
-atf_check -s exit:0 -o match:"^foo$" -e empty 'ls'
-.Ed
-.Sh SEE ALSO
-.Xr atf-sh 1 ,
-.Xr atf-test-program 1 ,
-.Xr atf-test-case 4
diff --git a/contrib/atf/atf-sh/atf-sh.1 b/contrib/atf/atf-sh/atf-sh.1
index ac4a135..b81bd18 100644
--- a/contrib/atf/atf-sh/atf-sh.1
+++ b/contrib/atf/atf-sh/atf-sh.1
@@ -22,15 +22,15 @@
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Dd September 27, 2014
+.Dd March 6, 2017
.Dt ATF-SH 1
.Os
.Sh NAME
.Nm atf-sh
-.Op Fl s Ar shell
.Nd interpreter for shell-based test programs
.Sh SYNOPSIS
.Nm
+.Op Fl s Ar shell
.Ar script
.Sh DESCRIPTION
.Nm
@@ -75,6 +75,8 @@ Should not be overridden other than for testing purposes.
Path to the system shell to be used in the generated scripts.
Scripts must not rely on this variable being set to select a specific
interpreter.
+.It Va ATF_SHELL
+Path to the system shell to be used in the generated scripts.
.El
.Sh EXAMPLES
Scripts using
@@ -98,10 +100,5 @@ option afterwards as a
.Bd -literal -offset indent
#! /path/to/bin/atf-sh -s/bin/bash
.Ed
-.Sh ENVIRONMENT
-.Bl -tag -width ATFXSHELLXX -compact
-.It Va ATF_SHELL
-Path to the system shell to be used in the generated scripts.
-.El
.Sh SEE ALSO
.Xr atf-sh 3
diff --git a/contrib/atf/atf-sh/atf-sh.3 b/contrib/atf/atf-sh/atf-sh.3
index be56539..0d0db2f7 100644
--- a/contrib/atf/atf-sh/atf-sh.3
+++ b/contrib/atf/atf-sh/atf-sh.3
@@ -22,7 +22,7 @@
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Dd October 13, 2014
+.Dd March 6, 2017
.Dt ATF-SH 3
.Os
.Sh NAME
@@ -129,7 +129,7 @@ tc2_cleanup() {
... second test case's cleanup ...
}
-.Ns ... additional test cases ...
+\&... additional test cases ...
atf_init_test_cases() {
atf_add_test_case tc1
@@ -144,7 +144,7 @@ described in
.Xr atf-test-case 4 .
To define test cases, one can use the
.Nm atf_test_case
-function, which takes a first parameter specifiying the test case's
+function, which takes a first parameter specifying the test case's
name and instructs the library to set things up to accept it as a valid
test case.
The second parameter is optional and, if provided, must be
@@ -334,7 +334,7 @@ atf_init_test_cases() {
This other example shows how to include a file with extra helper functions
in the test program:
.Bd -literal -offset indent
-.Ns ... definition of test cases ...
+\&... definition of test cases ...
atf_init_test_cases() {
. $(atf_get_srcdir)/helper_functions.sh
diff --git a/contrib/atf/doc/atf-test-case.4 b/contrib/atf/doc/atf-test-case.4
index 3025411..34f5e1b 100644
--- a/contrib/atf/doc/atf-test-case.4
+++ b/contrib/atf/doc/atf-test-case.4
@@ -22,7 +22,7 @@
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Dd October 5, 2014
+.Dd March 6, 2017
.Dt ATF-TEST-CASE 4
.Os
.Sh NAME
@@ -79,8 +79,8 @@ Upon termination, a test case reports a status and, optionally, a textual
reason describing why the test reported such status.
The caller must ensure that the test case really performed the task that its
status describes, as the test program may be bogus and therefore providing a
-misleading result (e.g. providing a result that indicates success but the
-error code of the program says otherwise).
+misleading result, e.g., providing a result that indicates success but the
+error code of the program says otherwise.
.Pp
The possible exit status of a test case are one of the following:
.Bl -tag -width expectedXfailureXX
OpenPOWER on IntegriCloud