ctest/README.txt

   1 This folder provides ctest scripts to automatically build anyone
   2 of the 'creatools', test it and submit results to creatis dashboard.
   3
   4 ----------------
   5  INSTRUCTIONS
   6 ----------------
   7
   8 1) Create a directory where you are going to run the tests.
   9    The default directory is '${HOME}/dashboards'
  10    If you change this location then you MUST change the line :
  11    set(CTEST_DASHBOARD_ROOT "$ENV{HOME}/dashboards")
  12    in your ctest file (see below)
  13
  14 2) Copy the ctest file corresponding to your os in the test dir,
  15    e.g. copy 'creatools-linux-osx.ctest' if you are on a linux
  16    or on a mac osx platform.
  17
  18 3) Edit the copied file and make the necessary changes inside
  19    following the comments therein.
  20    If you changed the default test dir, do not forget to change
  21    the line set(CTEST_DASHBOARD_ROOT "$ENV{HOME}/dashboards").
  22
  23 4) For each project you want to test:
  24    4.1) Perform an initial checkout of the project in test dir,
  25         e.g. 'cvs co crea'
  26    4.2) Create a build dir with name PROJECTNAME-BUILDTYPE,
  27         e.g. 'crea-release'
  28    4.3) Go to the build dir, configure the project with cmake
  29         (run ccmake or CMakeSetup), setting your machine
  30         specific options (libraries paths, options, build type, ...)
  31    4.4) Copy the 'CMakeCache.txt' file created by cmake in the test dir
  32         renaming it 'PROJECTNAME-BUILDTYPE-CMakeCache.txt'
  33
  34 5) To run a test, type in test dir:
  35    'ctest -S creatools-OS.ctest,PROJECTNAME' [-V|-VV]
  36    Where : * 'creatools-OS.ctest' is the name of your customized ctest file,
  37            (e.g. creatools-linux-osx.ctest)
  38            * PROJECTNAME is the name of the project to build and test
  39            (e.g. crea, bbtk, ...)
  40            * add -V or -VV tu run in verbose or extra-verbose mode
  41
  42 ----------------
  43 If you want to build the whole suite, you have to follow the projects
  44 dependencies.
  45 When you configure manually a project with cmake,
  46 make sure that the path to the libraries of the suite
  47 are properly set to the build directories in the test dir.
  48
  49 A consistent build order is:
  50 - crea
  51 - bbtk (depends on crea)
  52 - creaEnvironment (depends on crea)
  53 - creaImageIO (depends on crea, bbtk)
  54 - creaMaracasVisu (depends on crea, bbtk)
  55 - creaContours (depends on crea, bbtk, creaImageIO, creaEnvironment, creaMaracasVisu)
  56
  57 On linux or osx, see the bash script ctest-all-creatools.sh
  58
  59 ----------------
  60 REM: To schedule automatic build, see :
  61   http://www.vtk.org/Wiki/CMake_Scripting_Of_CTest
  62 ----------------
  63