Changeset 750cff for src/documentation/tests/unit-tests.dox

Timestamp:

Oct 31, 2011, 5:13:52 PM (14 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

5982c5

Parents:

19bc74

Message:

HUGE: Update on documenation.

• a general skeleton of the documentation is now in place with all the major components of MoleCuilder explained to some extent.
• some information has been transfered from TRAC (e.g. install procecure) into this doxygen documentation where it is general and not specific to the situation at our institute.

File:

• src/documentation/tests/unit-tests.dox (modified) (4 diffs)

src/documentation/tests/unit-tests.dox

@@ -18 +18 @@
  * Unit tests are done via the CppUnit framework (http://cppunit.sourceforge.net/doc/1.8.0/).
  *
- * \section Directory structure
+ * \section unittest-structure Directory structure
  *
  *  Unit tests are always located in a subfolder \b unittests of the component
@@ -24 +24 @@
  *  resides in \b src/Parser/unittests.
  *
- * \section Adding new tests
- *
- *  TODO: Documentation - explain how to add tests.
- *
- * \section Launching all tests
+ * \section unittest-launch-all Launching all tests
  *
  *  All unit tests can be launched as follows:
@@ -39 +35 @@
  * This will run all present unit tests one after the other.
  *
- * \section Launching some tests
+ * \section unittest-launch-some Launching some tests
  *
  *  If only some of the tests should be checked, then they have to be launched by
@@ -56 +52 @@
  *  libraries, which have not been installed so far, are found.
  *
- * \section Inspecting results
+ * \section unittest-results Inspecting results
  *
  *  Results of the test are shown during run. An \a Ok(2) indicates that
  *  two tests for the single launched testsuite passed.
  *
+ * \section unittest-add Adding new tests
+ *
+ *  \attention Name convention of files, (no spaces, use CamelCase) e.g.
+ *  \b AnalysisBondsUnitTest
+ *  - the unit test module should be called as follows:
+ *    -# either the name of the component or the module
+ *    -# followed by UnitTest.
+ *  - the test class should be called as follows:
+ *    -# the name of the class it tests
+ *    -# followed by Test.
+ *
+ *  Adding a new test is as easy as this:
+ *  -# Create a new module for declaration and definition of the unit test
+ *    in a suitable \b unittests subfolder (see above on policy and naming).
+ *    Check out one of the present unit tests and rename, but beware of
+ *    copy&paste errors!
+ *  -# Add the test to the \b Makefile.am contained in \b unittests.
+ *
+ *  If there is not yet a \b unittests folder:
+ *  -# Create a new \b Makefile.am, check out one of the present ones to get
+ *    an idea, below is a small list of contained elements. Note that the
+ *    variable must begin with a unique name as all Makefile.am on unit tests
+ *    are included into one big Makefile.am in \b src/unittests.
+ *  -# Add your ...SOURCES and ...HEADERS to TESTSOURCES and TESTHEADERS.
+ *  -# Add an include directive to \b src/unittests/Makefile.am of this
+ *    newly created \b Makefile.am.
+ *
+ *  What's contained in the \b Makefile.am:
+ *  -# ...SOURCES and ...HEADERS gathering all source and header files in this
+ *    \b unittests folder (this is needed for the test program that contains
+ *    all unit test in one executable).
+ *  -# ...TESTS gathering all test programs in this \b unittests folder.
+ *  -# ...TESTS is added to TESTS, check_PROGRAMS, noinst_PROGRAMS such that
+ *    it is known that they are just tests, programs for \a make \a check and
+ *    are not to be installed.
+ *  -# ...LIBS gathers general libs that all of the tests in this \b unittests
+ *    folder share.
+ *  -# for each unit test:
+ *    -# ...SOURCES gathers all source files that are required for the test.
+ *    -# ...LDADD gathers all libs that are required for compilation.
+ *
+ *
+ * \date 2011-10-31
+ *
  */