Slicer3:Testing

From Slicer Wiki
Jump to: navigation, search
Home < Slicer3:Testing

How to do testing in Slicer3.

Writing Tests

See Execution Model Testing for how to write tests for plug in modules.

C++

Tcl

Calling tests from CMake/CTest

Setting up automatic builds

Note: this can also be used for continuous builds using the --test-type Continuous flag.

Windows

For windows you need to use the Add Scheduled Task option in the Control Panel to create the build. This task runs in a 'dumb' dos shell, so you need to help it get jump started. The following works:

  • create a .bat file that that is called from the Scheduled Task
  • create a shell script that runs the build and call that from the .bat file

Here's an example for run.bat:

echo off

C:
chdir C:\cygwin\bin

set CYGWIN=binmode tty ntsec

rxvt -sl 1000 -e c:/pieper/run.csh -l

this example uses rxvt, which is available from cygwin, but not installed by default (it's an xterm ported to cygwin).

And here's an example run.csh:

#!/bin/csh

setenv PATH "/usr/local/bin:/usr/bin:/bin:/usr/X11R6/bin:/cygdrive/c/WINDOWS/system32:/cygdrive/c/WINDOWS:/cygdrive/c/WINDOWS/System32/Wbem"

c:/pieper/bwh/slicer3/latest/Slicer3/Scripts/getbuildtest.tcl --update --test-type Nightly |& c:/cygwin/bin/tee c:/pieper/bwh/slicer3/latest/Slicer3.build-log

c:/cygwin/bin/sleep 5

Unix (linux)

Here's an example script that can be dropped into /etc/cron.daily

#!/bin/bash

cd /home/pieper/slicer3/nightly
rm -rf Slicer3 Slicer3-lib Slicer3-build

su - pieper -c "cd /home/pieper/slicer3/nightly; svn co http://svn.slicer.org/Slicer3/trunk Slicer3 2>&1 | tee nightly.log"
su - pieper -c "export DISPLAY=:0.0; cd /home/pieper/slicer3/nightly; ./Slicer3/Scripts/getbuildtest.tcl -t Nightly 2>&1 | tee -a nightly.log"

Note: this assumes your shell is bash. If you use csh, replace the "2>&1 |" with "|&".

Note: the DISPLAY variable should be set to be the X display you want to run with. Most systems will have :0.0 as the default display.

Be sure to always leave the X server running or tests will fail.

Here's a similar example for a continuous build

#!/usr/bin/zsh

cd /playpen/davisb/Slicer3/continuous/Slicer3
date > continuous.log
export DISPLAY=:0
./Scripts/getbuildtest2.tcl --update --test-type Continuous |& tee -a continuous.log
date >> continuous.log

You can set up the script to be called every hour by adding this line to your cron file (crontab -e)

0 * *  * * /PathToTheScriptShownJustAbove/TestSlicer3Continuous.sh

Mac OSX

The scripts are basically the same as the linux versions, with the addition of a line to open the X11 application explicitly. Also, the script doesn't run as superuser, so no su commands are needed.

#!/bin/bash 

cd /extra/pieper/slicer3/nightly
rm -rf Slicer3 Slicer3-lib Slicer3-build

cd /extra/pieper/slicer3/nightly
svn co http://svn.slicer.org/Slicer3/trunk Slicer3 2>&1 > nightly.log
open /Applications/Utilities/X11.app
./Slicer3/Scripts/getbuildtest.tcl -t Nightly 2>&1 >> nightly.log

On Mac, the launchctl program is used to manage nightly builds (see Nick's excellent description from the FreeSurfer wiki).

Here's the example .plist file for a slicer build that calls the script above every day at 4am.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
        <key>GroupName</key>
        <string>slicer</string>
        <key>Label</key>
        <string>NightlyBuild</string>
        <key>Program</key>
        <string>/extra/pieper/slicer3/nightly/slicer.nightly</string>
        <key>ProgramArguments</key>
        <array>
                <string>&</string>
        </array>
        <key>ServiceDescription</key>
        <string>nightly clean build of slicer trunk</string>
        <key>StartCalendarInterval</key>
        <dict>
                <key>Hour</key>
                <integer>4</integer>
                <key>Minute</key>
                <integer>0</integer>
        </dict>
        <key>UserName</key>
        <string>pieper</string>
</dict>
</plist>


Reporting errors during genlib stage

If you would like to report the errors during building the dependency libraries to be reported to the dashboard, you can modify the following script http://www.cdash.org/CDash/viewNotes.php?buildid=398460, modify it to fit your environment, and then launch it with

ctest -S testscript.ctest