ctest/README.txt

   1 # ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Santé)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 #
   7 #  This software is governed by the CeCILL-B license under French law and
   8 #  abiding by the rules of distribution of free software. You can  use,
   9 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  10 #  license as circulated by CEA, CNRS and INRIA at the following URL
  11 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  12 #  or in the file LICENSE.txt.
  13 #
  14 #  As a counterpart to the access to the source code and  rights to copy,
  15 #  modify and redistribute granted by the license, users are provided only
  16 #  with a limited warranty  and the software's author,  the holder of the
  17 #  economic rights,  and the successive licensors  have only  limited
  18 #  liability.
  19 #
  20 #  The fact that you are presently reading this means that you have had
  21 #  knowledge of the CeCILL-B license and that you accept its terms.
  22 # ------------------------------------------------------------------------ */
  23
  24
  25 This folder provides ctest scripts to automatically build anyone
  26 of the 'creatools', test it and submit results to creatis dashboard.
  27
  28 ----------------
  29  INSTRUCTIONS
  30 ----------------
  31
  32 1) Create a directory where you are going to run the tests.
  33    The default directory is '${HOME}/dashboards'
  34    If you change this location then you MUST change the line :
  35    set(CTEST_DASHBOARD_ROOT "$ENV{HOME}/dashboards")
  36    in your ctest file (see below)
  37
  38 2) Copy the ctest file corresponding to your os in the test dir,
  39    e.g. copy 'creatools-linux-osx.ctest' if you are on a linux
  40    or on a mac osx platform.
  41
  42 3) Edit the copied file and make the necessary changes inside
  43    following the comments therein.
  44    If you changed the default test dir, do not forget to change
  45    the line set(CTEST_DASHBOARD_ROOT "$ENV{HOME}/dashboards").
  46
  47 4) For each project you want to test:
  48    4.1) Perform an initial checkout of the project in test dir,
  49         e.g. 'cvs co crea'
  50    4.2) Create a build dir with name PROJECTNAME-BUILDTYPE,
  51         e.g. 'crea-release'
  52    4.3) Go to the build dir, configure the project with cmake
  53         (run ccmake or CMakeSetup), setting your machine
  54         specific options (libraries paths, options, build type, ...)
  55    4.4) Copy the 'CMakeCache.txt' file created by cmake in the test dir
  56         renaming it 'PROJECTNAME-BUILDTYPE-CMakeCache.txt'
  57
  58 5) To run a test, type in test dir:
  59    'ctest -S creatools-OS.ctest,PROJECTNAME' [-V|-VV]
  60    Where : * 'creatools-OS.ctest' is the name of your customized ctest file,
  61            (e.g. creatools-linux-osx.ctest)
  62            * PROJECTNAME is the name of the project to build and test
  63            (e.g. crea, bbtk, ...)
  64            * add -V or -VV tu run in verbose or extra-verbose mode
  65
  66 ----------------
  67 If you want to build the whole suite, you have to follow the projects
  68 dependencies.
  69 When you configure manually a project with cmake,
  70 make sure that the path to the libraries of the suite
  71 are properly set to the build directories in the test dir.
  72
  73 A consistent build order is:
  74 - crea
  75 - bbtk (depends on crea)
  76 - creaEnvironment (depends on crea)
  77 - creaImageIO (depends on crea, bbtk)
  78 - creaMaracasVisu (depends on crea, bbtk)
  79 - creaContours (depends on crea, bbtk, creaImageIO, creaEnvironment, creaMaracasVisu)
  80
  81 On linux or osx, see the bash script ctest-all-creatools.sh
  82
  83 ----------------
  84 REM: To schedule automatic build, see :
  85   http://www.vtk.org/Wiki/CMake_Scripting_Of_CTest
  86 ----------------
  87