| 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2010 University of Bonn. All rights reserved.
|
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * \file unit-tests.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Oct 28, 2011
|
|---|
| 12 | * Author: heber
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 | /**
|
|---|
| 16 | * \page unittest "Unit test"
|
|---|
| 17 | *
|
|---|
| 18 | * Unit tests are done via the CppUnit framework (http://cppunit.sourceforge.net/doc/1.8.0/).
|
|---|
| 19 | *
|
|---|
| 20 | * \section Directory structure
|
|---|
| 21 | *
|
|---|
| 22 | * Unit tests are always located in a subfolder \b unittests of the component
|
|---|
| 23 | * that they test, e.g. if checking one of the Parsers, then its unit test
|
|---|
| 24 | * resides in \b src/Parser/unittests.
|
|---|
| 25 | *
|
|---|
| 26 | * \section Adding new tests
|
|---|
| 27 | *
|
|---|
| 28 | * TODO: Documentation - explain how to add tests.
|
|---|
| 29 | *
|
|---|
| 30 | * \section Launching all tests
|
|---|
| 31 | *
|
|---|
| 32 | * All unit tests can be launched as follows:
|
|---|
| 33 | * -# Enter the build directory
|
|---|
| 34 | * -# Enter \b src/unittests
|
|---|
| 35 | * -# Run
|
|---|
| 36 | * \code make check
|
|---|
| 37 | * \endcode
|
|---|
| 38 | *
|
|---|
| 39 | * This will run all present unit tests one after the other.
|
|---|
| 40 | *
|
|---|
| 41 | * \section Launching some tests
|
|---|
| 42 | *
|
|---|
| 43 | * If only some of the tests should be checked, then they have to be launched by
|
|---|
| 44 | * hand via entering the same directory as in the section before and e.g.
|
|---|
| 45 | * \code
|
|---|
| 46 | * ./AnalysisBondsUnitTest
|
|---|
| 47 | * \endcode
|
|---|
| 48 | * Note that to allow for debugging of the unit tests, one has to prepend the
|
|---|
| 49 | * executable as follows:
|
|---|
| 50 | * \code
|
|---|
| 51 | * libtool --mode=execute gdb --args ./AnalysisBondsUnitTest
|
|---|
| 52 | * \endcode
|
|---|
| 53 | * As we use libtool to take care of shared libraries the executables in
|
|---|
| 54 | * \b src/unittests are just scripts. The true executables hide in another
|
|---|
| 55 | * subfolder \b .libs. The scripts set environment variables such that shared
|
|---|
| 56 | * libraries, which have not been installed so far, are found.
|
|---|
| 57 | *
|
|---|
| 58 | * \section Inspecting results
|
|---|
| 59 | *
|
|---|
| 60 | * Results of the test are shown during run. An \a Ok(2) indicates that
|
|---|
| 61 | * two tests for the single launched testsuite passed.
|
|---|
| 62 | *
|
|---|
| 63 | */
|
|---|
