C++QED  v2 Milestone 10
a framework for simulating open quantum dynamics
Test suite

Running the test suite

After cloning the C++QED repository, there are several ways to run the test suite fully or partially.

The test suite is only active on 64bit systems.

make check* targets

Make targets have the advantage that they build everything the tests depend on automatically. They will run all tests with verbose output and offer the possibility to run fine grained groups of tests. Example usage:

# Run the full test suite
$ make check_full

# Run the physics test suite
$ make check_physics

# Run the test suite without the physics test suite
$ make check

# Run a subset of the test suite which runs faster (no on-demand compilation tests, no physics test suite)
$ make check_fast

# Perform the tests of the "continue" directory
$ make check_continue

# Perform only a single test by name
$ make fail_CompositeError2

# Go back through each not yet pushed commit and try to compile, then run 'make check' on the most current commit.
$ make check_push

Success is indicated by the make target completing without errors. Parallelization is supported by passing -DTEST_PARALLEL=N to CMake when configuring the project, where N is the number of tests which should be run in parallel. Verbose test output can be switched by the CMake option -DTEST_VERBOSE=ON/OFF. This method is suited best for usage from within kdevelop, for example while debugging some feature one can add the relevant test to the build sequence and just hit F8, which will recompile the dependencies and run the test.

make test target

This target is added by cmake automatically. It has no dependency checking, which means the framework has to be built in full before calling it. It features a nicer and compact output (no verbose messages from the tests) and a summary of all completed and failed tests. No parallelization is supported.


ctest is the tool that manages the tests, it is internally called by all the make targets. It can also be called directly. Example usage:

# Run the full test suite on 2 cores
$ ctest -j2

# Run all tests matching run_ on 2 cores
$ ctest -j2 -R run_

Again there is no dependency checking, the framework has to be built in full before calling ctest. However, tests depending on other tests will be run in the right order. The advantage over the check targets is that you have better control over the ctest parameters. For example you can pass a regular expression to -R to determine which tests should be run.

For multi-configuration CMake generators like XCode, the make targets are disabled. Use ctest from the command line instead and pass the correct configuration, e.g. ctest -C Release ....

Test suite layout

This section is only relevant to developers who want to incorporate new tests or modify existing ones.

The cmake part

Tests are grouped into sub-directories of Testing. To add a new directory, the CMakeLists.txt has to include the statement

testdir(<dirname> [dependency1 dependency2 ...])

Among other things, this will create the check_<dirname> target. The optional dependencies are cmake targets which are required to be built before all of the tests in this directory can be run. For example, if one of the tests requires 1particle1mode one has to add 1particle1mode to the dependencies.

Each test can use one of two test drivers: the Python or boost test driver. The method how to add a new test depends on the test driver. In any case, before a new test can be used, the project has to be re-configured with cmake.

The Python test driver

To add a new test, one has to call declaretest(), add_test() and optionally set_tests_properties. Here is an example how to add a new test in the CMakeLists.txt:

declaretest(<unique test name>)
# the following line is optional, adds a dependency:
set_tests_properties(${TESTNAME} PROPERTIES DEPENDS <some other test>)

The variable ${TESTNAME} is set to the current test name by declaretest(). This will call the Python script testdriver.py as test driver. The variable ${TESTSCRIPT} points to testdriver.py and already adds some needed parameters to pass in the build configuration (debug or release) and the configuration file. The required <parameters> are:

  • --test=TEST (required): the name of the test, usually passed in as --test=${TESTNAME}. This name also defines the section in the configuration file.
  • --testclass=TESTCLASS (required): the name of the python class which defines the mode of operation of the test driver

The other parameters depend on the used test class and are documented here.

Configuration files

The Python test driver reads in a global configuration file (Testing/testdriver.conf.in, pre-processed by cmake) and a per-directory configuration file (testdriver.conf). The [Setup] section of the global configuration file, defines global behavior. For example, one can set command line options which should be used for all scripts:

opts=--precision 6 --epsAbs 1e-5 --logLevel 2

See this list for all recognized keys in this section.

In the per-directory configuration files, there is a section for every test name. The available configuration keys of the sections depend on the used test class and are documented here. One can import the options from another section by an import statement:



Note that configuration keys which are also defined in the current section will not be overwritten by an import.

Test classes

The Python test driver defines a group of test classes. Each class represents a mode of operation, and multiple tests can use the same test class. A test class is chosen with the --testclass=TESTCLASS parameter. Some test classes inherit from others, in this case the configuration file keys and command line options from the base class are valid in the derived one.

This is a list of all available test classes, together with their recognized command line options and configuration file keys.

The boost test driver

Boost comes with its own test driver, which can be easily used with this test suite. All boost tests are declared in the directory Testing/boost.

To add a new test, a C++ source file, e.g. new_test.cc, has to be added to Testing/boost which implements the test:

#include <boost/test/unit_test.hpp>
// for example: BOOST_CHECK(...)

In Testing/boost/CMakeLists.txt, one has to add new_test.cc to BOOST_TEST_SOURCES and UNIQUE_TEST_NAME to BOOST_TESTS:

set(BOOST_TEST_SOURCES ... new_test.cc)

Afterwards, the new test will be integrated into the test suite.