TubeTK/Dashboard Scripts

Overview

TubeTK uses a novel configuration-file based method for installing dashboard machines. In general, you will perform an initial download of TubeTK, copy an example configuration file to the level above the TubeTK source, edit that file as appropriate, and then setup cron jobs to call script files that are distributed with TubeTK and that are controlled by your configuration file.

TubeTK's current dashboard is available at: https://www.kitware.com/CDash/index.php?project=TubeTK

Tutorial

Assuming that your top-level dashboard directory is call "Dashboards" this tutorial assumes that you want a directory structure with the following hierarchy

 Dashboards/tubetk
 Dashboards/tubetk-${BUILD_TYPE}

where ${BUILD_TYPE} is one of Release, Debug, RelWithDebInfo, ...

Background

• You must have CMake 2.8.8 or greater installed to run a TubeTK dashboard system.
  • CMake downloads
• You must have Qt 4.7 or greater installed to compile TubeTK
  • Qt downloads
• This tutorial assumes you have some knowledge of CMake and CTest

Checkout a new TubeTK for your dashboard

> cd Dashboards
> git clone http://git.gitorious.org/tubetk/tubetk.git

Initialize local configuration file

The configuration file "tubetk_config.cmake" belongs at the top of the Dashboards directory:

Dashboards/tubetk_config.cmake

Linux

> cp tubetk/DashboardScripts/tubetk_config.cmake-linux tubetk_config.cmake

Windows

> cp tubetk/DashboardScripts/tubetk_config.cmake-windows tubetk_config.cmake
> cp tubetk/DashboardScripts/tubetk_nightly_windows.bat .
> cp tubetk/DashboardScripts/tubetk_continuous_windows.bat .

Edit local configuration file

The file has two parts. The first part contains commonly changed variables. The second part is for advanced users only.

Linux: Commonly changed variables

set( SITE_NAME "aylward@abydos.kitware" )
set( SITE_PLATFORM "Linux" )
set( SITE_BUILD_TYPE "Release" )
set( SITE_CMAKE_GENERATOR "Unix Makefiles" )

set( ENV{DISPLAY} ":0" )

set( SITE_MAKE_COMMAND "make -j3" )
set( SITE_CMAKE_COMMAND "/usr/local/bin/cmake" )
set( SITE_QMAKE_COMMAND "/usr/bin/qmake" )
set( SITE_CTEST_COMMAND "/usr/local/bin/ctest" )

set( SITE_MEMORYCHECK_COMMAND "/usr/bin/valgrind" )
set( SITE_COVERAGE_COMMAND "/usr/bin/gcov" )
set( SITE_KWSTYLE_DIR "/usr/local/bin" )

set( SITE_GIT_COMMAND "/usr/bin/git" )
set( SITE_SVN_COMMAND "/usr/bin/svn" )
set( SITE_CVS_COMMAND "/usr/bin/cvs" )

set( SITE_SOURCE_DIR "/home/aylward/src/tubetk" )
set( SITE_BINARY_DIR "/home/aylward/src/tubetk-${SITE_BUILD_TYPE}" )

set( SITE_EXPERIMENTAL_BUILD_TEST ON )
set( SITE_EXPERIMENTAL_STYLE ON )
set( SITE_EXPERIMENTAL_COVERAGE OFF )
set( SITE_EXPERIMENTAL_MEMORY OFF )

set( SITE_CONTINUOUS_BUILD_TEST ON ) # Must be ON for any Continuous to run
set( SITE_CONTINUOUS_STYLE ON )
set( SITE_CONTINUOUS_COVERAGE OFF )
set( SITE_CONTINUOUS_MEMORY OFF )

set( SITE_NIGHTLY_BUILD_TEST ON ) # Must be on for any Nightly to run
set( SITE_NIGHTLY_STYLE ON )
set( SITE_NIGHTLY_COVERAGE ON )
set( SITE_NIGHTLY_MEMORY ON )

Windows: Commonly changed variables

set( SITE_NAME "ginger.aylward.org" )
set( SITE_PLATFORM "WindowsXP-VS2010Exp" )
set( SITE_BUILD_TYPE "Release" )
set( SITE_CMAKE_GENERATOR "Visual Studio 10" )

set( SITE_MAKE_COMMAND "${CTEST_BUILD_COMMAND}" )
set( SITE_CMAKE_COMMAND "C:\\Program Files\\CMake 2.8\\bin\\cmake" )
set( SITE_QMAKE_COMMAND "C:\\Qt\\4.6.3\\bin\\qmake" )
set( SITE_CTEST_COMMAND "C:\\Program Files\\CMake 2.8\\bin\\ctest" )

set( SITE_MEMORYCHECK_COMMAND "" )
set( SITE_COVERAGE_COMMAND "" )
set( SITE_STYLE_COMMAND "" )
set( SITE_CTEST_COMMAND "ctest" )

set( SITE_GIT_COMMAND 
  "C:\\Program Files\\Git\\bin\\git" )
set( SITE_SVN_COMMAND 
  "C:\\Program Files\\CollabNet\\Subversion Client\\svn" )

set( SITE_SOURCE_DIR 
  "C:\\Documents and Settings\\aylward\\My Documents\\src\\tubetk" )
set( SITE_BINARY_DIR 
  "C:\\Documents and Settings\\aylward\\My Documents\\src\\tubetk-Release" )

set( SITE_EXPERIMENTAL_BUILD_TEST ON )
set( SITE_EXPERIMENTAL_STYLE OFF )
set( SITE_EXPERIMENTAL_COVERAGE OFF )
set( SITE_EXPERIMENTAL_MEMORY OFF )

set( SITE_CONTINUOUS_BUILD_TEST ON ) # Must be ON for any Continuous to run
set( SITE_CONTINUOUS_STYLE OFF )
set( SITE_CONTINUOUS_COVERAGE OFF )
set( SITE_CONTINUOUS_MEMORY OFF )

set( SITE_NIGHTLY_BUILD_TEST ON ) # Must be ON for any Nightly to run
set( SITE_NIGHTLY_STYLE OFF )
set( SITE_NIGHTLY_COVERAGE OFF )
set( SITE_NIGHTLY_MEMORY OFF )

Setup cron job

Linux

> crontab -l

0 23  *  *  *  /home/kitware/Dashboards/cmake-2.8.2/bin/ctest -V -VV -S /home/kitware/Dashboards/tubetk/DashboardScripts/tubetk_run_nightly.cmake 1> /home/kitware/Dashboards/tubetk_nightly.log 2&>1
0 6  *  *  *  /home/kitware/Dashboards/cmake-2.8.2/bin/ctest -V -VV -S /home/kitware/Dashboards/tubetk/DashboardScripts/tubetk_run_continuous.cmake 1> /home/kitware/Dashboards/tubetk_continuous.log 2&>1

Windows

Edit the two bat files that include the necessary vcvars.bat files for Visual Studio to work:

edit Dashboards/tubetk_nightly_windows.bat 
edit Dashboards/tubetk_continuous_windows.bat 

Setup "Scheduled Jobs" to execute those batch files.

Running and submitting an experimental build

CTest's -S option runs a script:

> ctest -S tubetk/DashboardScripts/tubeTK_run_experimental.cmake

The tubeTK_run_experimental.cmake script uses the four configurations that you just specified in tubetk_config.cmake to run the test and report to the dashboard:

SITE_EXPERIMENTAL_BUILD_TEST
SITE_EXPERIMENTAL_STYLE
SITE_EXPERIMENTAL_COVERAGE
SITE_EXPERIMENTAL_MEMORY

New Features

Testing leaks

• Use tubetk_config.cmake file to control how your working source is built. I can then edit it at any time to focus on build/test, style, coverage, or memory checks. In the example below, I turn off all experimental options except MEMORY, and then I use the ctest command to run and test a single test and report its leaks on the dashboard:

set( SITE_EXPERIMENTAL_BUILD_TEST OFF )
set( SITE_EXPERIMENTAL_STYLE OFF )
set( SITE_EXPERIMENTAL_COVERAGE OFF )
set( SITE_EXPERIMENTAL_MEMORY ON )

> ctest -S tubetk/DashboardScripts/tubetk_run_experimental.cmake -R itkMatrix

Produces a dashboard submission that displays the testing results and memory leaks for all tests containing "itkMatrix" in their names.