Manual Pages  — ATF-C++

#include <atf-c++.hpp>

extern "C" {
amp;... C-specific includes go here ...
}

amp;... 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 ...
}

amp;... 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 ...
}

After the macro, you are supposed to provide the body of a function, which should only use the 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.

ATF_PASS() does not take any parameters. ATF_FAIL() and 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.

Each test case has an internal state called '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:

expect_death(reason)
	Expects the test case to exit prematurely regardless of the nature of the exit.
expect_exit(exitcode, reason)
	Expects the test case to exit cleanly. If exitcode is not '-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.
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 'expected failure'; this report includes the provided reason as part of it. If no error is raised while running in this mode, then the test case is reported as 'failed'. 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 reason as the bug number for tracking purposes.
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 'failed'.
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.
expect_signal(signo, reason)
	Expects the test case to terminate due to the reception of a signal. If signo is not '-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.
expect_timeout(reason)
	Expects the test case to execute for longer than its timeout.

ATF_REQUIRE() takes an expression and raises a failure if it evaluates to false.

ATF_REQUIRE_EQ() takes two expressions and raises a failure if the two do not evaluate to the same exact value. The common style is to put the expected value in the first parameter and the actual value in the second parameter.

ATF_REQUIRE_IN() takes an element and a collection and validates that the element is present in the collection.

ATF_REQUIRE_MATCH() takes a regular expression and a string and raises a failure if the regular expression does not match the string.

ATF_REQUIRE_NOT_IN() takes an element and a collection and validates that the element is not present in the collection.

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. ATF_REQUIRE_THROW_RE() takes the name of an exception, a regular expression 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.

ATF_CHECK_ERRNO() and ATF_REQUIRE_ERRNO() take, first, the error code that the check is expecting to find in the errno variable and, second, a boolean expression that, if evaluates to true, means that a call failed and errno has to be checked against the first value.

void atf::utils::cat_file(const std::string& path, const std::string& prefix) Prints the contents of path to the standard output, prefixing every line with the string in prefix.

bool atf::utils::compare_file(const std::string& path, const std::string& contents) Returns true if the given path matches exactly the expected inlined contents.

void atf::utils::copy_file(const std::string& source, const std::string& destination) Copies the file source to destination. The permissions of the file are preserved during the code.

void atf::utils::create_file(const std::string& path, const std::string& contents) Creates file with the text given in contents.

void atf::utils::file_exists(const std::string& path) Checks if path exists.

pid_t atf::utils::fork(void) Forks a process and redirects the standard output and standard error of the child to files for later validation with atf::utils::wait(). Fails the test case if the fork fails, so this does not return an error.

bool atf::utils::grep_collection(const std::string& regexp, const Collection& collection) Searches for the regular expression regexp in any of the strings contained in the collection. This is a template that accepts any one-dimensional container of strings.

bool atf::utils::grep_file(const std::string& regexp, const std::string& path) Searches for the regular expression regexp in the file path. The variable arguments are used to construct the regular expression.

bool atf::utils::grep_string(const std::string& regexp, const std::string& str) Searches for the regular expression regexp in the string str. void atf::utils::redirect(const int fd, const std::string& path) Redirects the given file descriptor fd to the file 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 atf::utils::fork().

void atf::utils::wait(const pid_t pid, const int expected_exit_status, const std::string& expected_stdout, const std::string& expected_stderr) Waits and validates the result of a subprocess spawned with atf::utils::wait(). The validation involves checking that the subprocess exited cleanly and returned the code specified in expected_exit_status and that its standard output and standard error match the strings given in expected_stdout and expected_stderr.

If any of the expected_stdout or expected_stderr strings are prefixed with '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.

ATF_BUILD_CC
	Path to the C compiler.
ATF_BUILD_CFLAGS
	C compiler flags.
ATF_BUILD_CPP
	Path to the C/C++ preprocessor.
ATF_BUILD_CPPFLAGS
	C/C++ preprocessor flags.
ATF_BUILD_CXX
	Path to the C++ compiler.
ATF_BUILD_CXXFLAGS
	C++ compiler flags.

#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(1, 0 + 1);
    ATF_REQUIRE_EQ(1, 1 + 0);

    ATF_REQUIRE_EQ(2, 1 + 1);

    ATF_REQUIRE_EQ(300, 100 + 200);
}

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);
}