| 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 tests.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Oct 28, 2011
|
|---|
| 12 | * Author: heber
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 | /**
|
|---|
| 16 | * \page tests Automated Tests
|
|---|
| 17 | *
|
|---|
| 18 | * There are two kinds of tests:
|
|---|
| 19 | *
|
|---|
| 20 | * \li \subpage codetest "Code tests"
|
|---|
| 21 | * \li \subpage regressiontest "Regression tests"
|
|---|
| 22 | * \li \subpage unittest "Unit test"
|
|---|
| 23 | *
|
|---|
| 24 | * These behave more or less like top-down and bottom-up approaches to automated
|
|---|
| 25 | * testing. Tests are regarded here as a kind of contract. The code itself is
|
|---|
| 26 | * just one hand in two hands shaking, the other hand is resembled by the tests
|
|---|
| 27 | * that checks whether the code does exactly what it's supposed to do. Without
|
|---|
| 28 | * testing a larger project is impossible because it cannot evolve. With
|
|---|
| 29 | * increasing size, a project must be refactored
|
|---|
| 30 | * (http://en.wikipedia.org/wiki/Code_refactoring) such that new code does not
|
|---|
| 31 | * have to wiggle itself around the same old issues that are present from the
|
|---|
| 32 | * start. Before one starts refactoring, it must be assured by some means that
|
|---|
| 33 | * the code before and after behaves the same with respect to its intended
|
|---|
| 34 | * functionality. These means are the tests.
|
|---|
| 35 | *
|
|---|
| 36 | * Unit tests (http://en.wikipedia.org/wiki/Unit_testing) tests single
|
|---|
| 37 | * components (e.g. classes), dependencies on other classes are often just
|
|---|
| 38 | * mimicked via so-called stubs. These test whether a component always behaves
|
|---|
| 39 | * as desired.
|
|---|
| 40 | *
|
|---|
| 41 | * Regression test (http://en.wikipedia.org/wiki/Regression_testing) on the other
|
|---|
| 42 | * hand test some specific functionality of the code from the top-most scope,
|
|---|
| 43 | * i.e. they are integration test that check whether the code eventually does
|
|---|
| 44 | * what's wanted. Lateron, they also check whether added or altered functionality
|
|---|
| 45 | * has not changed the outcome of older functions.
|
|---|
| 46 | *
|
|---|
| 47 | * Note that all tests can be launched via
|
|---|
| 48 | * \code make check \endcode
|
|---|
| 49 | * in the top build directory.
|
|---|
| 50 | *
|
|---|
| 51 | * \section Policy on launching tests
|
|---|
| 52 | *
|
|---|
| 53 | * Note that the above run of \e all \e tests \e should \e pass for each and
|
|---|
| 54 | * every single test for each and every single commit in the code history before
|
|---|
| 55 | * it is pushed to the central repository (git has ample means via \a rebase for
|
|---|
| 56 | * correcting later found errors).
|
|---|
| 57 | *
|
|---|
| 58 | * Before a version tag is given (e.g. v1.1.3) it is to be made sure that also
|
|---|
| 59 | * \code make distcheck \endcode
|
|---|
| 60 | * runs fine and produces a distributable archive.
|
|---|
| 61 | *
|
|---|
| 62 | */
|
|---|
