From Eigen
Revision as of 19:32, 12 November 2009 by Bjacob (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


First of all, this page applies to the development branch, not 2.0.

You need to know how to use CMake, see our page on that topic.

From now on, we assume that we are in the build directory and that you have already run cmake. There is no need to pass a particular option to CMake to enable tests.

Building and running unit tests

To build and run all tests using CTest, use the check target. For example, if your platform uses make:

 $ make check

This will not sent a report to the online dashboard. If you want to do that, see below.

We do not use the "test" target because of a well-documented limitation of CTest (the "test" target does not build the tests).

If you only want to build the tests, not run them, use the buildtests target. For example, with make, do:

 $ make buildtests

Working on one specific test

Suppose that a particular test, say "basicstuff", has failed. If you want to build specifically this test, just prepend it with "test_". For example:

 $ make test_basicstuff

If you want to run specifically that test and see the error messages it produces, you can run it directly:

 $ test/test_basicstuff

Note that these test executables take optional command-line parameters to control the number of repetitions and the seed. To get some help:

 $ test/test_basicstuff help

Filtering tests with regular expressions

We have two scripts for that, directly in your build directory. They currently assume "make" and the Bash shell, feel free to port them to your platform.

To build all tests matching a regular expression pattern, do:

 $ ./maketests regexp [jobs]

The optional second parameter is to launch multiple build jobs ("make -j").

To build and run all tests matching a regular expression pattern, do:

 $ ./mctestr regexp [jobs]

Notice that that is the same as doing "maketests" followed by "ctest -R".

Build types and debugging

There are 2 build types, Debug and Release.

The default build type is "Release".

If you have a test that fails and want to debug into it, you'll probably have to rebuild it in Debug mode. This is controlled by the standard CMake variable CMAKE_BUILD_TYPE. On Windows/MSVC, this is controlled from within the IDE as usual. Otherwise, we provide scripts for re-running CMake with that variable changed, just do:

 $ ./debug


 $ ./release

Note that in Debug mode, optimization is disabled and full debugging info is generated. Tests take a ton of disk space, and a very long time to finish.

Submitting test suite reports to the dashboard

To submit reports to the dashboard:

  • Update your mercurial clone to the desired branch:
 cd path/to/eigen2
 hg pull -u
 hg up 2.0   <or>   hg up default
  • Create a folder for the tests and copy the script:
 mkdir cdash
 cd cdash
 cp path/to/eigen2/test/testsuite.cmake .
  • run the testsuite:
 ctest -VV -S testsuite.cmake,EIGEN_BUILD_STRING=fedora-10-`uname -m`-gcc-4.3.2,EIGEN_CXX=g++-4.3,EIGEN_MODE=Experimental

Of course, change the value of the variable to match your system. The full list of options with description is available in the testsuite.cmake file.

Then you can check the results on our dashboard: http://eigen.tuxfamily.org/CDash.

For further information, check theses web pages: