This repository has been archived on 2023-11-20. You can view files and clone it, but cannot push or open issues or pull requests.
foam-extend4.1-coherent-io/testHarness
Martin Beaudoin 6cebda5e41 testHarness: adding the environment variable CDASH_SCM_INFO in order to override
the SCM information that gets appended at the end of the buildname string.

The buildname string is the string that will identify your test run when
published on the foam-extend CDash service.

When using git, this SCM information is picked up automatically from the CTest
script: -git-branch=the_git_branch_name-git-rev=the_git_revision_number.

But when using a non-git SCM (mercurial, etc), when the foam-extend source
code you are testing is not under a valid git repository, or simply when a user
needs to add more details to the standard SCM information (branch name and
revision number), then setting the environment variable CDASH_SCM_INFO to the
proper information will allow you to override the suffix we add at the end of
the buildname.

Please note that in order to keep the CMake script simple, for non-git
repositories, the fallback solution to try grabbing the information through
Mercurial has been removed. Please use the CDASH_SCM_INFO environment
varible instead.
2015-08-15 14:23:15 -04:00
..
foam-extend/3.2 testHarness: adding the environment variable CDASH_SCM_INFO in order to override 2015-08-15 14:23:15 -04:00
OSIG/Turbomachinery test harness enabled 2013-12-17 10:30:27 +00:00
README.txt testHarness: adjusting some messages for foam-extend 2015-08-06 12:16:44 +01:00

Description
===========
This part of the repository is for FOAM test harnesses.


Directory Structure
===================

foam-extend-3.2    : Test harness for foam-extend version 3.2. See the file foam-extend-3.2/README.txt for more information

OSIG                : CMake/CTest scripts for FOAM Special Interest Group (OSIG) test harness
OSIG/TurboMachinery : Test harness for the TurboMachinery OSIG. See the file OSIG/Turbomachinery/README.txt for more information.


Martin Beaudoin, Hydro-Quebec, 2010. All rights reserved.


1: Select your git branch of choice: ie:

   git checkout master   # For Hrv master branch


2: Make sure your FOAM environment is properly configured to run FOAM.


3: The minimal cmake version number for running the test loop is 2.8.0. Make sure you are there.


4: Make sure you have the test harness scripts available under your git branch;
   otherwise, you will need to fetch this from Hrv's master branch, and merge it into yours

   ls $WM_PROJECT_DIR/testHarness  # Checking availability of testHarness under this branch


5: move to the runDir directory for the FOAM test harness

   cd $WM_PROJECT_DIR/testHarness/foam-extend/3.2/runDir


6: Normally, if using the master branch, everything should already be setup for you to run the test harness.
   Still, I recommand always checking that these two important files are up-to-date:

   cp ../CMakeFiles/CMakeLists.txt $WM_PROJECT_DIR
   cp ../CMakeFiles/CTestConfig.cmake.foam-extend $WM_PROJECT_DIR/CTestConfig.cmake


7:   Next, running the test loop is pretty simple:

   cd $WM_PROJECT_DIR/testHarness/foam-extend/3.2/runDir # you should already be there...
   ./Allclean
   ./Allrun_Experimental


8: The results will be published on the CDash dashboard on foam-extend.

   To see your results:
   URL      : http://foam-extend.sourceforge.net/CDash/index.php?project=foam-extend-3.2


9: You can customize your system identifier on the dashboard using the environment variable $CDASH_SUBMIT_LOCAL_HOST_ID.
   Otherwise, the fully qualified name of your system will be used.

   A good customization idea would be to add the name of your git branch in your system ID.
   I will probably modify my scripts to add this information automagically.

   NB: Please no "forward slash" or "/" in the system ID; it looks like CDash will choke on this.


10: In general, see the file $WM_PROJECT_DIR/testHarness/foam-extend/3.2/README.txt for the necessary information about running the
    test loop.


11: Please do not hesitate to report any problems, comments, suggestions about the test loop.