Changeset 750cff for src/documentation/tests/code-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, Candidate_v1.7.0, 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/code-tests.dox (modified) (2 diffs)

src/documentation/tests/code-tests.dox

@@ -22 +22 @@
  * -# Every .cpp files must include \b config.h and \b CodePatterns/MemDebug.hpp
  * -# Every .hpp files must include \b config.h
+ * -# Every .dox file contains a (correctly formatted: YYYY-MM-DD) date stamp.
  *
  * These make sure that the memory debugger is catching every movement on the
- * heap and that every module knows about the behavior controling defines that
- * are checked by autoconf and written to \b config.h in the build directory.
+ * heap and that every module knows about the behavior controling \e #define's that
+ * are checked by autoconf and written to \b config.h in the build directory. And
+ * also that for every documentation file it is known when it was current.
  *
- * \section Directory structure
+ * \section codetest-structure Directory structure
  *
  * The code tests are contained in \b tests/CodeChecks. Therein are all test
@@ -33 +35 @@
  * Mostly, these look through files
  *
- * \section Launching all tests
+ * \section codetest-launch-all Launching all tests
  *
- *  TODO: Documentation - explain how to launch all code tests.
+ *  In order to launch all tests, simply do:
+ *  -# Enter \b tests/CodeChecks in your build directory
+ *  -# Run
+ *    \code make check \endcode
+ *    there
  *
- * \section Launching some tests
+ * \section codetest-launch-some Launching some tests
  *
- *  TODO: Documentation - explain how to launch some code tests
+ *  Launching a single or just some of the tests is only a little bit more
+ *  complicated. Proceed as follows:
+ *  -# Enter \b tests/CodeChecks in your build directory
+ *  -# Run
+ *  \code ../../../tests/CodeChecks/testsuite <option> AUTOTEST_PATH="<buildpath>/src" \endcode,
+ *  where \a <option> is explained in the subsections below and \a <buildpath> is
+ *  the build path (i.e. the variable \a AUTOTEST_PATH should contain the path to
+ *  the executable).
  *
- * \section Inspecting results
+ *  \subsection regressiontest-launch-by-number ... by number
  *
- *  TODO: Documentation - explain how to inspect code test results.
+ *    Tests can be launched by specifying their test number, e.g. then \a <option>
+ *    might be \a 1 or \a 1-2 or just nothing for all of them.
+ *
+ *  \subsection regressiontest-launch-by-keyword .. by keyword
+ *
+ *    Tests may as well be launched by some keywords, e.g. each code check has
+ *    a specific keyword which is given via \b AT_KEYWORD directive of Autotest.
+ *    I.e. we may launch the test on \b config.h presence via the \a <option>
+ *    \a -k \a config_h. Also multiple keywords may be given.
+ *
+ * \section codetest-results Inspecting results
+ *
+ *  The testsuite can be launched with the additional option of \a -d which leaves the
+ *  directory of the test present even though the test has passed for inspection.
+ *
+ *  If a test fails, in whatever way it was launched, will leave in the build directory
+ *  a folder \b tests/CodeChecks/testsuite.dir/<nr> where \a <nr> is the number of the
+ *  test (padded maybe with some zeros).
+ *
+ *  In the current state tests will fail because one file does not include \b
+ *  config.h or \b MemDebug.hpp. Hence, check the testsuite's log to get the file
+ *  name of the culprit at its very bottom.
+ *
+ * \section unittest-add Adding new tests
+ *
+ *  \attention Name convention of files, (no spaces, use underscore) e.g.
+ *  \b testsuite-config_h.at
+ *  - the test script file should be called as follows:
+ *    -# testsuite-...
+ *    -# followed by the construct that is tested.
+ *
+ *  In order to add a new test, you have to do the following:
+ *  -# Add a new \b testsuite-....at script to the folder \b tests/CodeChecks
+ *    (have a look at the present ones and see above for help on the commands
+ *    recognized by Autotest. \e Mind \e giving it a suitable \e keyword!).
+ *  -# Add the file to Makefile.am such that the testsuite is re-created when
+ *    you change the test script.
+ *  -# Add the file as an \e m4_include directive to testsuite.at.
+ *
+ *
+ * \date 2011-10-31
  *
  */