Gromacs
2020-beta3
|
Common helper classes and functions for writing tests using Google Test.
General documentation for the testing in GROMACS can be found in the developer guide. This page provides an overview of the actual API provided by the testutils
module.
There are several distinct functionalities provided:
stdout
) from code that uses gmx::IFileOutputRedirector, and checking that output against reference data.stdin
reading cannot be easily mocked.Additionally, testinit.h and mpi_printer.h, and their corresponding source files, provide functionality that is not visible on the API level: they provide initialization routines for the above functionality, which are automatically called by the main() function provided in unittest_main.cpp.
mpi_printer.h provides a Google Test listener that is installed when the tests are compiled with MPI. This listener allows the test binary to be run on multiple MPI ranks, and synchronizes the execution and output from the test cases, as well as makes the test fail on even if an assertion fails only on one rank.
Assertions for exceptions | |
These macros replace | |
#define | EXPECT_THROW_GMX(statement, expected_exception) |
Asserts that a statement throws a given exception. | |
#define | EXPECT_NO_THROW_GMX(statement) |
Asserts that a statement does not throw. | |
#define | ASSERT_THROW_GMX(statement, expected_exception) |
Asserts that a statement throws a given exception. | |
#define | ASSERT_NO_THROW_GMX(statement) |
Asserts that a statement does not throw. | |
Assertions for floating-point comparison | |
These routines extend See gmx::test::FloatingPointTolerance for the possible ways to specify the tolerance, and gmx::test::FloatingPointDifference for some additional details of the difference calculation. | |
#define | EXPECT_FLOAT_EQ_TOL(value1, value2, tolerance) |
Asserts that two single-precision values are within the given tolerance. | |
#define | EXPECT_DOUBLE_EQ_TOL(value1, value2, tolerance) |
Asserts that two double-precision values are within the given tolerance. | |
#define | EXPECT_REAL_EQ_TOL(value1, value2, tolerance) |
Asserts that two real values are within the given tolerance. | |
#define | ASSERT_FLOAT_EQ_TOL(value1, value2, tolerance) |
Asserts that two single-precision values are within the given tolerance. | |
#define | ASSERT_DOUBLE_EQ_TOL(value1, value2, tolerance) |
Asserts that two double-precision values are within the given tolerance. | |
#define | ASSERT_REAL_EQ_TOL(value1, value2, tolerance) |
Asserts that two real values are within the given tolerance. | |
#define | EXPECT_REAL_EQ(value1, value2) EXPECT_REAL_EQ_TOL(value1, value2, ::gmx::test::defaultRealTolerance()) |
EXPECT_REAL_EQ_TOL with default tolerance. | |
#define | ASSERT_REAL_EQ(value1, value2) ASSERT_REAL_EQ_TOL(value1, value2, ::gmx::test::defaultRealTolerance()) |
ASSERT_REAL_EQ_TOL with default tolerance. | |
Classes | |
class | gmx::test::CommandLine |
Helper class for tests that need to construct command lines. More... | |
class | gmx::test::CommandLineTestHelper |
Helper class for tests that construct command lines that need to reference existing files. More... | |
class | gmx::test::CommandLineTestBase |
Test fixture for tests that call a single command-line program with input/output files. More... | |
class | gmx::test::ConfMatch |
Match the contents as an gro file. More... | |
class | gmx::test::IFileMatcher |
Represents a file matcher, matching file contents against reference (or other) data. More... | |
class | gmx::test::IFileMatcherSettings |
Represents a factory for creating a file matcher. More... | |
class | gmx::test::TextFileMatch |
Use a ITextBlockMatcher for matching the contents. More... | |
class | gmx::test::NoContentsMatch |
Do not check the contents of the file. More... | |
class | gmx::test::InteractiveTestHelper |
Helper class for testing interactive sessions. More... | |
class | gmx::test::LoggerTestHelper |
Helper class for tests to check output written to a logger. More... | |
class | gmx::test::TestReferenceData |
Handles creation of and comparison to test reference data. More... | |
class | gmx::test::TestReferenceChecker |
Handles comparison to test reference data. More... | |
class | gmx::test::StdioTestHelper |
Helper class for tests where code reads directly from stdin . More... | |
class | gmx::test::StringTestBase |
Test fixture for tests that check string formatting. More... | |
class | gmx::test::FloatingPointDifference |
Computes and represents a floating-point difference value. More... | |
class | gmx::test::FloatingPointTolerance |
Specifies a floating-point comparison tolerance and checks whether a difference is within the tolerance. More... | |
class | gmx::test::TestException |
Exception class for reporting errors in tests. More... | |
class | gmx::test::TestFileManager |
Helper for tests that need input and output files. More... | |
class | gmx::test::TestFileInputRedirector |
In-memory implementation for IFileInputRedirector for tests. More... | |
class | gmx::test::TestFileOutputRedirector |
In-memory implementation of IFileOutputRedirector for tests. More... | |
class | gmx::test::TestOptionsProvider |
Provides additional options for the test executable. More... | |
class | gmx::test::ITextBlockMatcher |
Represents a text matcher, matching text stream contents against reference data. More... | |
class | gmx::test::ITextBlockMatcherSettings |
Represents a factory for creating a text matcher. More... | |
class | gmx::test::ExactTextMatch |
Use an exact text match (the contents should be exactly equal). More... | |
class | gmx::test::NoTextMatch |
Do not match the text (the contents are ignored). More... | |
class | gmx::test::FilteringExactTextMatch |
Use an exact text match after scrubbing lines of the text that match the supplied regular expressions. More... | |
class | gmx::test::XvgMatch |
Match the contents as an xvg file. More... | |
Macros | |
#define | GMX_MPI_TEST(expectedRankCount) ASSERT_EQ(expectedRankCount, ::gmx::test::getNumberOfTestMpiRanks()) |
Declares that this test is an MPI-enabled unit test. More... | |
#define | EXPECT_PLAIN(expr) |
Assert for predicates that return AssertionResult and produce a full failure message. More... | |
#define | ASSERT_PLAIN(expr) |
Assert for predicates that return AssertionResult and produce a full failure message. More... | |
#define | GMX_TEST_OPTIONS(name, options) |
Macro to add additional command-line options for the test binary. More... | |
Enumerations | |
enum | gmx::test::ReferenceDataMode { gmx::test::erefdataCompare, gmx::test::erefdataCreateMissing, gmx::test::erefdataUpdateChanged, gmx::test::erefdataUpdateAll } |
Mode of operation for reference data handling. More... | |
Functions | |
int | gmx::test::getNumberOfTestMpiRanks () |
Returns the number of MPI ranks to use for an MPI test. More... | |
void | gmx::test::initReferenceData (IOptionsContainer *options) |
Initializes reference data handling. More... | |
void | gmx::test::registerTestOptions (const char *name, TestOptionsProvider *provider) |
Registers a test option provider with the test framework. More... | |
void | gmx::test::initTestOptions (IOptionsContainer *options) |
Initializes the options from all registered test providers. More... | |
static FloatingPointTolerance | ulpTolerance (uint64_t ulpDiff) |
Creates a tolerance that only allows a specified ULP difference. More... | |
FloatingPointTolerance | relativeToleranceAsFloatingPoint (double magnitude, double tolerance) |
Creates a tolerance that allows a difference in two compared values that is relative to the given magnitude. More... | |
FloatingPointTolerance | relativeToleranceAsPrecisionDependentFloatingPoint (double magnitude, float singleTolerance, double doubleTolerance) |
Creates a tolerance that allows a precision-dependent difference in two compared values that is relative to the given magnitude. More... | |
static FloatingPointTolerance | relativeToleranceAsPrecisionDependentUlp (double magnitude, uint64_t singleUlpDiff, uint64_t doubleUlpDiff) |
Creates a tolerance that allows a precision-dependent relative difference in a complex computation. More... | |
static FloatingPointTolerance | absoluteTolerance (double tolerance) |
Creates a tolerance that allows a specified absolute difference. | |
static FloatingPointTolerance | relativeToleranceAsUlp (double magnitude, uint64_t ulpDiff) |
Creates a tolerance that allows a relative difference in a complex computation. More... | |
static FloatingPointTolerance | defaultRealTolerance () |
Returns the default tolerance for comparing real numbers. | |
static FloatingPointTolerance | defaultFloatTolerance () |
Returns the default tolerance for comparing single-precision numbers when compared by GROMACS built in either precision mode. More... | |
Directories | |
directory | testutils |
Testing Utilities (testutils) | |
directory | tests |
Unit tests for Testing Utilities (testutils). | |
Files | |
file | cmdlinetest.h |
Declares utilities testing command-line programs. | |
file | conftest.h |
Declares function to add the content of a conf file to a checker. | |
file | filematchers.h |
Declares utility classes for testing file contents. | |
file | interactivetest.h |
Provides helper classes for testing interactive prompts. | |
file | loggertest.h |
Declares gmx::test::LoggerTestHelper. | |
file | mpitest.h |
Helper functions for MPI tests to make thread-MPI look like real MPI. | |
file | refdata.h |
Functionality for writing tests that can produce their own reference data. | |
file | setenv.h |
Helper functions to have identical behavior of setenv and unsetenv on Unix and Windows systems. | |
file | simulationdatabase.h |
Functionality for testing whether calls to mdrun produce the same energy and force quantities when they should do so. | |
file | stdiohelper.h |
Declares gmx::test::StdioTestHelper. | |
file | stringtest.h |
Declares gmx::test::StringTestBase. | |
file | testasserts.h |
Extra assertions for unit tests. | |
file | testexceptions.h |
Exception classes for errors in tests. | |
file | testfilemanager.h |
Declares gmx::test::TestFileManager. | |
file | testfileredirector.h |
Declares generic mock implementations for interfaces in fileredirector.h. | |
file | testmatchers.h |
Extra GoogleMock matchers for unit tests. | |
file | testoptions.h |
Functions for accessing test command-line options. | |
file | textblockmatchers.h |
Declares utility classes for testing multi-line strings against reference data. | |
file | tprfilegenerator.h |
Helper for generating reusuable TPR files for tests within the same test binary. | |
file | xvgtest.h |
Declares function to add the content of an xvg file to a checker. | |
#define ASSERT_PLAIN | ( | expr | ) |
Assert for predicates that return AssertionResult and produce a full failure message.
expr
should evaluate to AssertionResult, and on failure the message from the result is used as-is, unlike in ASSERT_TRUE().
#define EXPECT_PLAIN | ( | expr | ) |
Assert for predicates that return AssertionResult and produce a full failure message.
expr
should evaluate to AssertionResult, and on failure the message from the result is used as-is, unlike in EXPECT_TRUE().
#define GMX_MPI_TEST | ( | expectedRankCount | ) | ASSERT_EQ(expectedRankCount, ::gmx::test::getNumberOfTestMpiRanks()) |
Declares that this test is an MPI-enabled unit test.
[in] | expectedRankCount | Expected number of ranks for this test. The test will fail if run with unsupported number of ranks. |
To write unit tests that run under MPI, you need to do a few things:
When you do the above, the following will happen:
You need to be extra careful for variables in the test fixture, if you use one: when run under thread-MPI, these will be shared across all the ranks, while under real MPI, these are naturally different for each process. Local variables in the test body are private to each rank in both cases.
Currently, it is not possible to specify the number of ranks as one, because that will lead to problems with (at least) thread-MPI, but such tests can be written as serial tests anyways.
#define GMX_TEST_OPTIONS | ( | name, | |
options | |||
) |
Macro to add additional command-line options for the test binary.
name | Unique name for the set of options. |
options | Placeholder name for an gmx::Options object for adding options. |
The macro should be followed by a block that adds the desired command-line options to options
using gmx::Options::addOption(). Extensible Handling of Options (options) provides an overview of the options machinery.
name
must be unique within the executable to which the options are added. If the macro is within an unnamed namespace, then it is sufficient that it is unique within the file.
Typical usage:
\cond
and \endcond
statements are necessary around the macro to avoid Doxygen warnings.
One macro invocation per an added option, with more of the implementation details hidden inside the macro, could be nicer. But that requires more elaborate macro machinery, so it is probably not worth the effort and complexity.
Mode of operation for reference data handling.
There should be no need to use this type outside the test utility module.
Enumerator | |
---|---|
erefdataCompare |
Compare to existing reference data. If reference data does not exist, or if the test results differ from those in the reference data, the test fails. |
erefdataCreateMissing |
Create missing reference data. If reference data does not exist for a test, that test behaves as if erefdataUpdateAll had been specified. Tests for which reference data exists, behave like with erefdataCompare. |
erefdataUpdateChanged |
Update reference data that does not pass comparison. Tests utilizing reference data should always pass in this mode unless there is an I/O error. |
erefdataUpdateAll |
Update reference data, overwriting old data. Tests utilizing reference data should always pass in this mode unless there is an I/O error. |
|
related |
Returns the default tolerance for comparing single-precision numbers when compared by GROMACS built in either precision mode.
This permits a checker compiled with any GROMACS precision to compare equal or not in the same way.
int gmx::test::getNumberOfTestMpiRanks | ( | ) |
Returns the number of MPI ranks to use for an MPI test.
For thread-MPI builds, this will return the requested number of ranks even before the thread-MPI threads have been started.
void gmx::test::initReferenceData | ( | IOptionsContainer * | options | ) |
Initializes reference data handling.
Adds command-line options to options
to set the reference data mode. By default, erefdataCompare is used, but --ref-data create
or --ref-data update
can be used to change it.
This function is automatically called by initTestUtils().
void gmx::test::initTestOptions | ( | IOptionsContainer * | options | ) |
Initializes the options from all registered test providers.
options | The options are added here. |
This is called automatically by initTestUtils().
void gmx::test::registerTestOptions | ( | const char * | name, |
TestOptionsProvider * | provider | ||
) |
Registers a test option provider with the test framework.
[in] | name | Name of the options provider (for ordering). |
[in] | provider | The provider to register. |
std::bad_alloc | if out of memory. |
tMPI::system_error | on mutex failures. |
Typically not used directly in test code, but through the GMX_TEST_OPTIONS macro.
This gets called from constructors for global variables, so ideally it would not throw to avoid unhandled exceptions. But since this is only test code, it is not worth the effort to try to remove those rare exceptions (mutex failures and out-of-memory from STL).
|
related |
Creates a tolerance that allows a difference in two compared values that is relative to the given magnitude.
[in] | magnitude | Magnitude of the numbers the computation operates in. |
[in] | tolerance | Relative tolerance permitted (e.g. 1e-4). |
In addition to setting an relative tolerance for both precisions, this sets the absolute tolerance such that values close to zero (in general, smaller than magnitude
) do not fail the check if they differ by less than tolerance
evaluated at magnitude
. This accounts for potential loss of precision for small values, and should be used when accuracy of values much less than magnitude
do not matter for correctness.
|
related |
Creates a tolerance that allows a precision-dependent difference in two compared values that is relative to the given magnitude.
[in] | magnitude | Magnitude of the numbers the computation operates in. |
[in] | singleTolerance | Relative tolerance permitted (e.g. 1e-4) in single precision. |
[in] | doubleTolerance | Relative tolerance permitted (e.g. 1e-4) in double precision. |
In addition to setting an relative tolerance for both precisions, this sets the absolute tolerance such that values close to zero (in general, smaller than magnitude
) do not fail the check if they differ by less than tolerance
evaluated at magnitude
. This accounts for potential loss of precision for small values, and should be used when accuracy of values much less than magnitude
do not matter for correctness.
|
related |
Creates a tolerance that allows a precision-dependent relative difference in a complex computation.
[in] | magnitude | Magnitude of the numbers the computation operates in. |
[in] | singleUlpDiff | Expected accuracy of single-precision computation (in ULPs). |
[in] | doubleUlpDiff | Expected accuracy of double-precision computation (in ULPs). |
This works as relativeToleranceAsUlp(), but allows setting the ULP difference separately for the different precisions. This supports cases where the double-precision calculation can acceptably has a higher ULP difference, but relaxing the single-precision tolerance would lead to an unnecessarily loose test.
|
related |
Creates a tolerance that allows a relative difference in a complex computation.
[in] | magnitude | Magnitude of the numbers the computation operates in. |
[in] | ulpDiff | Expected accuracy of the computation (in ULPs). |
In addition to setting the ULP tolerance as ulpTolerance(), this sets the absolute tolerance such that values close to zero (in general, smaller than magnitude
) do not fail the check if they differ by less than ulpDiff
evaluated at magnitude
. This accounts for potential loss of precision for small values, and should be used when accuracy of values much less than magnitude
do not matter for correctness.
|
related |
Creates a tolerance that only allows a specified ULP difference.
The tolerance uses the given ULP value for both precisions, i.e., double precision will have much stricter tolerance.