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.ctest' if you are on a linux platform.
  16
  17 3) Edit the copied file and make the necessary changes inside
  18    following the comments therein.
  19    If you changed the default test dir, do not forget to change
  20    the line set(CTEST_DASHBOARD_ROOT "$ENV{HOME}/dashboards").
  21
  22 4) For each project you want to test:
  23    4.1) Perform an initial checkout of the project in test dir,
  24         e.g. 'cvs co crea'
  25    4.2) Create a build dir with name PROJECTNAME-BUILDTYPE,
  26         e.g. 'crea-release'
  27    4.3) Go to the build dir, configure the project with cmake
  28         (run ccmake or CMakeSetup), setting your machine
  29         specific options (libraries paths, options, build type, ...)
  30    4.4) Copy the 'CMakeCache.txt' file created by cmake in the test dir
  31         renaming it 'PROJECTNAME-BUILDTYPE-CMakeCache.txt'
  32
  33 5) To run a test, type in test dir:
  34    'ctest -S creatools-OS.ctest,PROJECTNAME' [-V|-VV]
  35    Where : * 'creatools-OS.ctest' is the name of your customized ctest file,
  36            (OS is your OS type)
  37            * PROJECTNAME is the name of the project to build and test
  38            (e.g. crea, bbtk, ...)
  39            * add -V or -VV tu run in verbose or extra-verbose mode
  40
  41 ----------------
  42 If you want to build the whole suite, you have to follow the projects
  43 dependencies.
  44 When you configure manually a project with cmake,
  45 make sure that the path to the libraries of the suite
  46 are properly set to the build directories in the test dir.
  47
  48 A consistent build order is:
  49 - crea
  50 - bbtk (depends on crea)
  51 - creaEnvironment (depends on crea)
  52 - creaImageIO (depends on crea, bbtk)
  53 - creaMaracasVisu (depends on crea, bbtk)
  54 - creaContours (depends on crea, bbtk, creaImageIO, creaEnvironment, creaMaracasVisu)
  55
  56 ----------------
  57 REM: To schedule automatic build, see :
  58   http://www.vtk.org/Wiki/CMake_Scripting_Of_CTest
  59 ----------------
  60