Difference between revisions of "Documentation/Nightly/Developers/QtTesting"
BenjaminLong (talk | contribs) |
BenjaminLong (talk | contribs) |
||
| Line 11: | Line 11: | ||
{{ambox | {{ambox | ||
| type = content | | type = content | ||
| − | |text = If you needs data, please first add the data to the Sample Data module, and use this module during the test. See instruction [http://www.slicer.org/slicerWiki/index.php/SampleData here]<br>[[Documentation/{{documentation/version}}/Modules/SampleData]] module according to the current Slicer version | + | |text = If you needs data, please first add the data to the Sample Data module, and use this module during the test. See instruction [http://www.slicer.org/slicerWiki/index.php/SampleData here]<br>[[Documentation/{{documentation/version}}/Modules/SampleData Sample Data]] module according to the current Slicer version |
}} | }} | ||
Revision as of 18:40, 24 May 2012
Home < Documentation < Nightly < Developers < QtTestingContents
Overview
QtTesting provides us a testing framework to test our application.
Following is a step by step guide to create slicer unit test, using this framework, which can be run as part of a nightly build automatic testing.
Write a 3DSlicer UnitTest with QtTesting
1/ Create your XML script
See QtTesting user Wiki to know how to create this xml script.
Save the xml script to Slicer4/Application/SlicerApp/Testing/QtTesting/Slicer4.X.X_tutorial_MY_TUTORIAL_NAME.xml
 |
If you needs data, please first add the data to the Sample Data module, and use this module during the test. See instruction here Documentation/Nightly/Modules/SampleData Sample Data module according to the current Slicer version |
2/ Create a Python script
This Python test will start 3DSlicer and run the previously recorded xml script
Create a file with the following code
import slicer
import slicer.testing
import slicer.util
filepath = os.environ['SLICER_HOME'] + 'path/to/your/script.xml'
testUtility = slicer.app.testingUtility()
success = testUtility.playTests(filepath)
if success :
slicer.util.exit(EXIT_SUCCESS)
else:
slicer.util.exit(EXIT_FAILURE)
Save to the directory ${Slicer_SOURCE_DIR}/Applications/SlicerApp/Testing/Python/
3/ Add the test in CMake
Edit the file Slicer4/Applications/SlicerApp/Testing/Python/CMakeLists.txt
Add your test at the end of the Slicer_USE_QTTESTING condition:
if(Slicer_USE_QTTESTING)
{
...
slicer_add_python_test(
SCRIPT pythonScriptName.py
SLICER_ARGS --launcher-no-splash --qt-testing)
}
You just wrote a Slicer Unit Test using QtTesting framework !
Create custom translator/player
QTTesting provides us basic translator and player template.
You can use the following command to create those basic files.
| Linux | Mac | Windows |
|---|---|---|
|
You need to open a terminal and go to the Slicer4 source directory. $ cd path/to/Slicer4-Superbuild/CTK-build/QtTesting/Utilities/Scripts $ python TranslatorPlayerWizard.py MY_WIDGET_NAME $ cd ../MY_WIDGET_NAME |
You need to open a terminal and go to the Slicer4 source directory. $ cd path\to\Slicer4-Superbuild $ python-build\PCBuild\python.exe CTK-build\QtTesting\Utilities\Scripts\ModuleWizard.py MY_WIDGET_NAME $ cd ../MY_WIDGET_NAME |
 |
4 files should have been created !
MY_WIDGET_NAMEPlayer.hThose files are only the basic code. You now have to implement the functions, according to your widget, to record the events |
Open bugs
Work in progress, following the two bug trackers :
