Commontk - User contributions [en]

Documentation/Widget testing

2012-03-16T18:45:27Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Doing}}
|
|'''Translator and player if popup'''
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|NA
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''qMRMLWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|qMRMLCaptureToolBar
|{{Doing}}
|
|
|-
|qMRMLCheckableNodeComboBox
|{{Done}}
|
|
|-
|qMRMLClipNodeWidget
|{{Done}}
|
|
|-
|qMRMLCollapsibleButton
|{{Done}}
|
|
|-
|qMRMLColorListView
|{{Done}}
|
|
|-
|qMRMLColorPickerWidget
|{{Doing}}
|
|
|-
|qMRMLColorTableComboBox
|{{Done}}
|
|
|-
|qMRMLColorTableView
|{{Done}}
|
|
|-
|qMRMLDisplayNodeWidget
|{{Done}}
|
|
|-
|qMRMLEventBrokerWidget
|{{Done}}
|
|
|-
|qMRMLLabelComboBox
|{{Done}}
|
|
|-
|qMRMLLayoutWidget
|{{Doing}}
|
|
|-
|qMRMLLinearTransformSlider
|{{Done}}
|
|
|-
|qMRMLListWidget
|{{Done}}
|
|
|-
|qMRMLMatrixWidget
|{{Done}}
|
|
|-
|qMRMLNavigationView
|{{Done}}
|
|
|-
|qMRMLNodeComboBox
|{{Done}}
|
|
|-
|qMRMLRangeWidget
|{{Done}}
|
|
|-
|qMRMLROIWidget
|{{Done}}
|
|
|-
|qMRMLScalarInvariantComboBox
|{{Done}}
|
|
|-
|qMRMLSceneFactoryWidget
|{{Done}}
|
|
|-
|qMRMLSceneViewMenu
|{{Done}}
|
|
|-
|qMRMLScreenShotDialog
|{{Done}}
|
|
|-
|qMRMLSliceControllerWidget
|{{Doing}}
|
|
|-
|qMRMLSliceWidget
|{{Doing}}
|
|
|-
|qMRMLThreeDViewControllerWidget
|{{Done}}
|
|
|-
|qMRMLThreeDView
|{{Doing}}
|
|
|-
|qMRMLThreeDWidget
|{{Doing}}
|
|
|-
|qMRMLTransformSliders
|NA
|
|
|-
|qMRMLTreeView
|{{Doing}}
|
|
|-
|qMRMLVolumeInfoWidget
|{{Done}}
|
|
|-
|qMRMLVolumeThresholdWidget
|{{Done}}
|
|
|-
|qMRMLWindowLevelWidget
|{{Doing}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2012-03-16T18:44:45Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Not Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Doing}}
|
|'''Translator and player if popup'''
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|NA
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''qMRMLWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|qMRMLCaptureToolBar
|{{Doing}}
|
|
|-
|qMRMLCheckableNodeComboBox
|{{Done}}
|
|
|-
|qMRMLClipNodeWidget
|{{Done}}
|
|
|-
|qMRMLCollapsibleButton
|{{Done}}
|
|
|-
|qMRMLColorListView
|{{Done}}
|
|
|-
|qMRMLColorPickerWidget
|{{Doing}}
|
|
|-
|qMRMLColorTableComboBox
|{{Done}}
|
|
|-
|qMRMLColorTableView
|{{Done}}
|
|
|-
|qMRMLDisplayNodeWidget
|{{Done}}
|
|
|-
|qMRMLEventBrokerWidget
|{{Done}}
|
|
|-
|qMRMLLabelComboBox
|{{Done}}
|
|
|-
|qMRMLLayoutWidget
|{{Doing}}
|
|
|-
|qMRMLLinearTransformSlider
|{{Done}}
|
|
|-
|qMRMLListWidget
|{{Done}}
|
|
|-
|qMRMLMatrixWidget
|{{Done}}
|
|
|-
|qMRMLNavigationView
|{{Done}}
|
|
|-
|qMRMLNodeComboBox
|{{Done}}
|
|
|-
|qMRMLRangeWidget
|{{Done}}
|
|
|-
|qMRMLROIWidget
|{{Done}}
|
|
|-
|qMRMLScalarInvariantComboBox
|{{Done}}
|
|
|-
|qMRMLSceneFactoryWidget
|{{Done}}
|
|
|-
|qMRMLSceneViewMenu
|{{Done}}
|
|
|-
|qMRMLScreenShotDialog
|{{Done}}
|
|
|-
|qMRMLSliceControllerWidget
|{{Doing}}
|
|
|-
|qMRMLSliceWidget
|{{Doing}}
|
|
|-
|qMRMLThreeDViewControllerWidget
|{{Done}}
|
|
|-
|qMRMLThreeDView
|{{Doing}}
|
|
|-
|qMRMLThreeDWidget
|{{Doing}}
|
|
|-
|qMRMLTransformSliders
|NA
|
|
|-
|qMRMLTreeView
|{{Doing}}
|
|
|-
|qMRMLVolumeInfoWidget
|{{Done}}
|
|
|-
|qMRMLVolumeThresholdWidget
|{{Done}}
|
|
|-
|qMRMLWindowLevelWidget
|{{Doing}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2012-01-12T18:52:48Z

Benjamin.long: /* Player/Translators Widget Testing */

Documentation/Widget testing

2012-01-12T18:45:08Z

Benjamin.long:

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Doing}}
|
|'''Translator and player if popup'''
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|NA
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''qMRMLWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|qMRMLCaptureToolBar
|{{Not Done}}
|
|
|-
|qMRMLCheckableNodeComboBox
|{{Not Done}}
|
|
|-
|qMRMLClipNodeWidget
|{{Not Done}}
|
|
|-
|qMRMLCollapsibleButton
|{{Not Done}}
|
|
|-
|qMRMLColorListView
|{{Not Done}}
|
|
|-
|qMRMLColorPickerWidget
|{{Not Done}}
|
|
|-
|qMRMLColorTableComboBox
|{{Not Done}}
|
|
|-
|qMRMLColorTableView
|{{Not Done}}
|
|
|-
|qMRMLDisplayNodeWidget
|{{Not Done}}
|
|
|-
|qMRMLEventBrokerWidget
|{{Not Done}}
|
|
|-
|qMRMLLabelComboBox
|{{Not Done}}
|
|
|-
|qMRMLLayoutWidget
|{{Not Done}}
|
|
|-
|qMRMLLinearTransformSlider
|{{Not Done}}
|
|
|-
|qMRMLListWidget
|{{Not Done}}
|
|
|-
|qMRMLMatrixWidget
|{{Not Done}}
|
|
|-
|qMRMLNavigationView
|{{Not Done}}
|
|
|-
|qMRMLNodeComboBox
|{{Not Done}}
|
|
|-
|qMRMLRangeWidget
|{{Not Done}}
|
|
|-
|qMRMLROIWidget
|{{Not Done}}
|
|
|-
|qMRMLScalarInvariantComboBox
|{{Not Done}}
|
|
|-
|qMRMLSceneFactoryWidget
|{{Not Done}}
|
|
|-
|qMRMLSceneViewMenu
|{{Not Done}}
|
|
|-
|qMRMLScreenShotDialog
|{{Not Done}}
|
|
|-
|qMRMLSliceControllerWidget
|{{Not Done}}
|
|
|-
|qMRMLSliceWidget
|{{Not Done}}
|
|
|-
|qMRMLThreeDViewControllerWidget
|{{Not Done}}
|
|
|-
|qMRMLThreeDView
|{{Not Done}}
|
|
|-
|qMRMLThreeDWidget
|{{Not Done}}
|
|
|-
|qMRMLTransformSliders
|{{Not Done}}
|
|
|-
|qMRMLTreeView
|{{Not Done}}
|
|
|-
|qMRMLVolumeInfoWidget
|{{Not Done}}
|
|
|-
|qMRMLVolumePropertyNodeWidget
|{{Not Done}}
|
|
|-
|qMRMLVolumeThresholdWidget
|{{Not Done}}
|
|
|-
|qMRMLWindowLevelWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2012-01-02T18:11:42Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Doing}}
|
|'''Translator and player if popup'''
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|NA
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-09T22:29:12Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Done}}
|
|
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|NA
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-09T21:58:50Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Done}}
|
|
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-09T21:57:50Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|'''+++'''
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Done}}
|
|
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-09T21:57:10Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|'''+++'''
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Done}}
|
|
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-09T21:56:49Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|NA
|
|''ctkPopupWidget inherit of it. See ctkPopupWidget''
|
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}
|
|
|-
|ctkCheckableHeaderView
|{{Done}}
|
|
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|
|-
|ctkColorPickerButton
|{{Done}}
|
|
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
|
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}} - TO VERIFY
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
|
|-
|ctkFittedTextBrowser
|NA
|
|''This widget just display text.''
|-
|ctkFlowLayout
|NA
|
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|NA
|
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ?
|-
|ctkMenuComboBox
|{{Done}}
|'''+++'''
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|NA
|
|
|-
|ctkPopupWidget
|{{Done}}
|
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|
|
|-
|ctkSettingsPanel
|{{Done}}
|
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Done}}
|
|
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|
|
|-
|ctkTreeComboBox
|{{Done}}
|
| '''Note: This won't work if there multiple items with a similar name. This is not an issue in Slicer since selection is based on string'''
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}
|
|''See ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}
|
|''See ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Not Done}}
|
| ''Not used in Slicer''
|-
|ctkVTKMatrixWidget
|{{Done}}
|
| ''See ctkVTKMatrixWidget - There is no need for specific translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Done}}
|
|''Since it's based on QVTKWidget - See ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-09T21:43:13Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|NA
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|NA
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|NA
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Done}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}
|
|
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|NA
|
|
|-
|ctkMaterialPropertyPreviewLabel
|NA
|
|
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
|
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}
|'''+++'''
| bgcolor="#efabab" |'' Developer should make sure menus have a parent. See https://bugreports.qt.nokia.com/browse/QTBUG-20929
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}
|'''++'''
| bgcolor="#efabab" |'' Note that the first time the listview is displayed, it will show on the top left corner of the screen.''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Done}}
|'''+'''
|
|-
|ctkQImageView
|NA
|
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
|
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|NA
|
|
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''See ctkSettingsDialog''
|-
|ctkSignalMapper
|NA
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|NA
|
|
|-
|ctkSliderWidget
|{{Done}}
|
|
|-
|ctkTestApplication
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}
|'''+'''
|
|-
|ctkWidgetsUtils
|NA
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-09T21:33:06Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
| bgcolor="f4db9e"|''QSpinBox issue if used''
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}
|'''+++'''
| bgcolor="#efabab" |'' Issue if the subMenus have no parent - Qt issue''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#efabab" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}
|'''+'''
|
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-06T19:20:02Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Not Done}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}
|
| bgcolor="f4db9e"|''QSpinBox issue if used''
|-
|ctkMatrixWidget
|{{Done}}
|
| '' no visuel effects ''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}
|'''+++'''
| bgcolor="#efabab" |'' Issue if the subMenus have no parent - Qt issue''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#efabab" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}
|'''+'''
|
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-06T19:13:54Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#efabab" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#efabab" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}
|'''+'''
|
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-12-01T19:36:45Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#efabab" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#efabab" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-30T22:21:08Z

Benjamin.long: /* Issues found on QtTesting */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox] 
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-30T22:20:34Z

Benjamin.long: /* Issues found on QtTesting */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}}
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQSpinBox QSpinBox]
Here the link to my Github for the [https://github.com/benjaminlong/QtTesting/tree/88-IssueQDoubleSpinBox QDoublSpinBox]

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T23:32:10Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}}

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Doing}}
|'''+++'''
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T22:10:54Z

Benjamin.long: /* Issues found on QtTesting */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribut to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}}

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T22:10:37Z

Benjamin.long: /* Issues found on QtTesting */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}}

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T22:03:37Z

Benjamin.long: /* Limits */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
Note that there are still severals limits to this testing framework :
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T22:02:09Z

Benjamin.long: /* How */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''
<pre>
QObject::connect(Ui.RecordButton, SIGNAL(clicked(bool)), this, SLOT(record()));
QObject::connect(Ui.PlayBackButton, SIGNAL(clicked(bool)), this, SLOT(play()));
</pre>

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T22:01:10Z

Benjamin.long: /* How */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Record, and link it to the ctkQtTestUtility slot ''record''
# Create a button Play, and link it to the ctkQtTestingUtility slot ''play''

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T22:00:40Z

Benjamin.long: /* Adding the testing framework into your application */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>
{{Note}} You can have your own ''EventObserver'' and ''EventSource''
# Create a button Redord, and link it to the ctkTestUtility slot ''record''
# Create a button Play, and link it to the ctkTestingUtility slot ''play''

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:55:04Z

Benjamin.long: /* How */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkQtTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
<pre>
this->TestUtility = new ctkQtTestingUtility(this);
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this));
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this));</pre>

# Create a button Redord, and link it to the ctkTestUtility slot ''record''
# Create a button Play, and link it to the ctkTestingUtility slot ''play''

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:52:13Z

Benjamin.long: /* How */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkTestingUtiliy - can be added to your mainWindow class.
#* And initialize this variable as following :
this->TestUtility = new ctkQtTestingUtility(this); 
this->TestUtility->addEventObserver("xml", new ctkXMLEventObserver(this)); 
this->TestUtility->addEventSource("xml", new ctkXMLEventSource(this)); 
{{Note}} you can implemente your own ''EventSource'' and ''EventObserver''
# Create a button Redord, and link it to the ctkTestUtility slot ''record''
# Create a button Play, and link it to the ctkTestingUtility slot ''play''

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:47:13Z

Benjamin.long: /* Adding the testing framework into your application */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
Follow these steps to add this testing framework to your application.
# Create a variable ctkTestingUtiliy - can be added to your mainWindow class.
# Create a button Redord, and link it to the ctkTestUtility slot ''record''
# Create a button Play, and link it to the ctkTestingUtility slot ''play''

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings. {{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:45:32Z

Benjamin.long: /* Adding the testing framework into your application */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
Follow these steps to add this testing framework to your application. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
# Create a variable ctkTestingUtiliy - can be added to your mainWindow class.
# Create a button Redord, and link it to the ctkTestUtility slot ''record''
# Create a button Play, and link it to the ctkTestingUtility slot ''play''

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings.

{{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - Below the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:45:01Z

Benjamin.long: /* Adding the testing framework into your application */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
Follow these steps to add this testing framework to your application. 
You can see the application exemple created in CTK to have an exemple:

=== How ===
# Create a variable ctkTestingUtiliy - can be added to your mainWindow class.
# Create a button Redord, and link it to the ctkTestUtility slot ''record''
# Create a button Play, and link it to the ctkTestingUtility slot ''play''

=== Limits ===
# The ctkVTKRenderView had to have the same size between the record and the playback.
#* To solve the issue, ctkTestingUtility record all the application property - size, state, font ... - and before a playback, if these property are differents, ask the user if he wants to load the settings.

{{Note}} We are working on this limit to find a better solution.
# All the CTK Widgets are not yet tested - see the [summary table] -

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:15:11Z

Benjamin.long: /* Adding the testing framework into your application */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
Adding the testing framework will allow users to recover script, but also a easy way to create tutorial or to test all the widget. 
Follow these steps to add this testing framework to your application.

=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:09:07Z

Benjamin.long: /* Adding the testing framework into your application */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== Why ===
...

=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:02:27Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:02:00Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}} - Not working if the renderView has a different size
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T21:00:42Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
| ''Translator/Player implemented What we want : - Wheel event {{Done}} - Better normalization {{Done}}
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T20:58:47Z

Benjamin.long: /* Player/Translators Widget Testing */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===
Summury table, to know each widgets' state. 
The state can be ''Done'' : {{Done}} , ''Done with QtTesting issue'' : {{Done}}{{Doing}} , ''in progress'' : {{Doing}} , or ''without unit test'': {{Not Done}}.

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T20:51:39Z

Benjamin.long:

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

Documentation/Widget testing

2011-11-25T20:50:35Z

Benjamin.long:

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Building =
=== Milestones ===
# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

=== Player/Translators Widget Testing ===

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:49:23Z

Benjamin.long:

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Builds Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:48:19Z

Benjamin.long: /* Milestones */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Builds Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:47:46Z

Benjamin.long: /* How added the testing framework into your application */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Adding the testing framework into your application =
=== How ===
# ...
# ...

=== Limits ===
# ...
# ...

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:47:00Z

Benjamin.long: /* Limits */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= How added the testing framework into your application =
=== Milestones ===
# ...
# ...

=== Limits ===

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:46:49Z

Benjamin.long: /* Milestones */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= How added the testing framework into your application =
=== Milestones ===
# ...
# ...

== Limits ==

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:44:52Z

Benjamin.long:

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= How added the testing framework into your application =
== Milestones ==
# ...
# ...
== Limits ==

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:39:46Z

Benjamin.long: /* Overview */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test - [http://www.commontk.org/index.php/File:CtkEventTranslatorPlayerWidget.png Image]
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''How added the testing framework into your application if you're using CTK :'''
*''Milestones :""
*# ...
*# ...
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:38:38Z

Benjamin.long: /* Milestones */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''How added the testing framework into your application if you're using CTK :'''
*''Milestones :""
*# ...
*# ...
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - [http://www.commontk.org/index.php/File:CtkQtTestingScreenShot.png ctkQtTesting] - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:29:04Z

Benjamin.long: /* Overview */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''How added the testing framework into your application if you're using CTK :'''
*''Milestones :""
*# ...
*# ...
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - ctkQtTesting - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:28:16Z

Benjamin.long: /* Overview */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''How added the testing framework into your application if you're using CTK :'''
*''Milestones :""
*#
*#
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - ctkQtTesting - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:25:43Z

Benjamin.long: /* Overview */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''How added the testing framework into your application if you're using CTK :'''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - ctkQtTesting - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:23:51Z

Benjamin.long: /* Overview */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#* Including the class :
#**''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test
#**''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
#**''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
#**''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - ctkQtTesting - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}

Documentation/Widget testing

2011-11-25T20:22:32Z

Benjamin.long: /* Overview */

[[Documentation|Back to CTK Documentation]]

= Overview =

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the [http://www.paraview.org/Wiki/Testing_design QtTesting library] developed by [http://www.paraview.org Paraview] folks.

 
'''How added the testing framework to CTK :'''
* Turn the variable ''CTK_USE_QTTESTING'' into ''ON''.
 
'''If the option '''CTK_USE_QTTESTING''' is enabled, the build system will :'''
# Download external project QtTesting
# Compile the CTKQtTesting Library
#*; Including the class :
''ctkEventTranslaterPlayerWidget'' : Widget used by the Unit Test
''ctkQtTestingUtility'' : Class used by the application - inherits from pqTestUtility
''ctkXMLEventObserver'' : Recover the Event and write the .xml file.
''ctkXMLEventSource'' : Read the .xml file and create the events.
# For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
#* Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
# If '''BUILD_TESTING''' is enabled: widgets EventTranslatorTests will be compiled.
#*''These tests will use ''ctkEventTranslaterPlayerWidget'' and ensure that events associated with widgets can be properly recorded and played.''
 
'''{{note}}''' 
Option '''CTK_USE_QTTESTING''' will be automatically enabled if '''BUILD_TESTING''' is ON

= Milestones =

# Integrate QtTesting has an external projects {{Done}}
# Add unit test to all the widget - Below, the [http://www.commontk.org/index.php/Documentation/Widget_testing#Player.2FTranslators_Widget_Testing summuray table] -
## Implement ''ctkEventTranslaterPlayerWidget'' {{Done}}
## Create custom translator/player if needed {{Doing}}
## Implement widgets EventTranslatorTests {{Doing}}
# Create an Application test - ctkQtTesting - {{Done}}

= Issues found on QtTesting =

*''' QSpinBox/QDoubleSpinBox :'''
** A long click on the up/down arrow -> just one click even if the value change severals times.
** Fast click -> Double click -> no effect.
** clik on the up/down arrow just after editing the spin Box -> no effect.
''Solve : Contribution to the QtTesting by modified the pqSpinBoxEventTranslator'' {{Doing}} - Push on my local branch -

*''' In pq3DView :'''
** The scroll button has no effect - Implemented for ctk.
** Shift between the current/Expected image.
''Solve : new Implementation with the ctkVTKRenderViewEventTranslator and the ctkVTKRenderViewEventPlayer :'' {{Done}}
# ''Change the normalization into a normalization by the widget center.''
# ''Implemented the scroll action''
# ''Add a better rounded when we cast from double to int to not have shift issue.''

*''' QComboBox when it is editable :'''
** The hight-event "set_sting" crash if we edit the comboBox.
*** '''''Exemple :''' If we have an item "foo", we are going to edit the comboBox with "f", but the item "f" doesn't exist, and the player will crash.''
''Solve : ...'' {{Not Done}}

= Screenshots =

<gallery widths=300 px heights=200px perrow=3>
Image:CtkQtTestingScreenShot.png|Simple application with recording / playing Qt testing capabilities
Image:CtkEventTranslatorPlayerWidget.png|Little exemple of the widget testing
</gallery>

= Player/Translators Widget Testing =

{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|- valign=top
| style="width:50%;" |
{|class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkActionsWidget
|{{Done}}
|
|
|-
|ctkAddRemoveComboBox
|{{Done}}
|
|
|-
|ctkAxesWidget
|{{Done}}
|
|''Translator/player implemented''
|-
|ctkBasePopupWidget
|{{Done}}
|'''+++'''
|''ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget''
|-
|ctkButtonGroup
|{{Done}}
|
|
|-
|ctkCheckableComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''minor issue with the currentText()''
|-
|ctkCheckableHeaderView
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |''more test ?''
|-
|ctkCheckBoxPixmaps
|{{Not Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkCheckablePushButton
|{{Done}}
|'''--'''
|''Not used in Slicer''
|-
|ctkComboBox
|{{Done}}
|
|
|-
|ctkCompleter
|{{Not Done}}
|'''-'''
|
|-
|ctkCollapsibleButton
|{{Done}}
|
|
|-
|ctkCollapsibleGroupBox
|{{Done}}
|
|
|-
|ctkColorDialog
|{{Done}}
|
|bgcolor="#f4db9e" |''QSpinBox issue if used''
|-
|ctkColorPickerButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QSpinBox issue if used''
|-
|ctkConsole
|{{Done}}{{Doing}}
|
|''May have a problem with the command''
|-
|ctkConfirmExitDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkCoordinatesWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''Problem with the QSpinBox''
|-
|ctkCrosshairLabel
|{{Not Done}}
|'''-'''
|
|-
|ctkDateRangeWidget
|{{Doing}}
|
|''Problem with QDateTimer''
|-
|ctkDirectoryButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''Value OK but no dialog''
|-
|ctkDoubleRangeSlider
|{{Done}}
|
|
|-
|ctkDoubleSlider
|{{Done}}
|
|
|-
|ctkDynamicSpacer
|{{Not Done}}
|'''-'''
|
|-
|ctkErrorLogStatusMessageHandler
|{{Done}}
|'''---'''
|''Not a Widget''
|-
|ctkErrorLogWidget
|{{Not Done}}
|'''---'''
|
|-
|ctkExpandButton
|{{Done}}
|
|
|-
|ctkFileDialog
|{{Doing}}
|
| bgcolor="#efabab" |'' EventTranslator ?''
|-
|ctkFittedTextBrowser
|{{Done}}
|'''--'''
|''This widget just display text.''
|-
|ctkFlowLayout
|{{Done}}
|'''--'''
|''Layout are not tested through the event translator/player mechanism''
|-
|ctkFontButton
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e" |''QComboBox doesn't change the font''
|-
|ctkIconEnginePlugin
|{{Done}}
|'''--'''
|''Plugin are not tested through the event translator/player mechanism''
|-
|ctkLayoutManager
|{{Not Done}}
|
|
|-
|ctkMaterialPropertyPreviewLabel
|{{Not Done}}
|
|''Not sure if something is requiered since it seems to be a label''
|-
|ctkMaterialPropertyWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox issue''
|-
|ctkMatrixWidget
|{{Done}}
|
| bgcolor="#f4db9e" |''Skip all the visual effect''
|-
|ctkMenuButton
|{{Not Done}}
|
|''Use in Slicer ? Implemented event translator/player''
|-
|ctkMenuComboBox
|{{Done}}{{Doing}}
|'''+++'''
| bgcolor="#f4db9e" |'' Issue if the subMenus have no parent ''
|-
|ctkModalityWidget
|{{Done}}
|
|
|-
|ctkPathLineEdit
|{{Done}}{{Doing}}
|'''++'''
| bgcolor="#f4db9e" |'' Little issue with the listView for the fist show - As ctkMenuComboBox ''
|-
|ctkPixmapIconEngine
|{{Not Done}}
|'''++'''
|
|-
|ctkPopupWidget
|{{Doing}}
|'''+'''
| bgcolor="#efabab" |''Implemented event translator/player ''
|-
|ctkQImageView
|{{Not Done}}
|'''---'''
|
|-
|ctkRangeSlider
|{{Done}}
|
|
|-
|ctkRangeWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QDoubleSpinBox issue''
|-
|ctkScreenshotDialog
|{{Not Done}}
|'''-'''
|
|-
|ctkSearchBox
|{{Done}}
|
|
|-
|ctkSettings
|{{Not Done}}
|'''+'''
|''Need a Test ?''
|-
|ctkSettingsDialog
|{{Done}}
|'''+'''
|
|-
|ctkSettingsPanel
|{{Done}}
|'''+'''
|''It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing''
|-
|ctkSignalMapper
|{{Done}}
|
|''This object is not a widget and doesn't have to be tested through the event translator/player mechanism''
|-
|ctkSimpleLayoutManager
|{{Not Done}}
|
|
|-
|ctkSliderWidget
|{{Done}}{{Doing}}
|
| bgcolor="f4db9e"|''QSpinBox Issue''
|-
|ctkTestApplication
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkThumbnailListWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkThumbnailWidget
|{{Not Done}}
|'''--'''
|
|-
|ctkToolTipTrapper
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkTransferFunctionBarsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionControlPointsItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionGradientItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionItem
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionScene
|{{Not Done}}
|'''-'''
|
|-
|ctkTransferFunctionView
|{{Not Done}}
|'''-'''
|
|-
|ctkTreeComboBox
|{{Done}}{{Doing}}
|'''+'''
| bgcolor="#f4db9e" |''Good method ? - Spy count error''
|-
|ctkWidgetsUtils
|{{Done}}
|
|''This is a utility class. Shouldn't be tested using the event translator/player mechanism''
|-
|ctkWorkflowAbstractPagedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowButtonBoxWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowGroupBox
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowStackedWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowTabWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidget
|{{Not Done}}
|'''-'''
|
|-
|ctkWorkflowWidgetStep
|{{Not Done}}
|'''-'''
|
|}
| style="width:50%; "text-align: center; " |
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKVisualizationVTKWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkVTKAbstractMatrixWidget
|{{Done}}{{Doing}}
|
|''Tested in ctkVTKMatrixWidget''
|-
|ctkVTKAbstractView
|{{Done}}{{Doing}}
|'''+++'''
|''Tested in ctkVTKRenderView''
|-
|ctkVTKChartView
|{{Not Done}}
|
|
|-
|ctkVTKDataSetArrayComboBox
|{{Done}}
|
|
|-
|ctkVTKDataSetModel
|{{Done}}
|
|
|-
|ctkVTKMagnifyView
|{{Doing}}
|'''-'''
|
|-
|ctkVTKMatrixWidget
|{{Done}}
|
|''use ctkMatrixWidget translator & player''
|-
|ctkVTKRenderView
|{{Doing}}
|'''+++'''
|bgcolor="#efabab" | ''Translator/Player implemented What we want : - Wheel event {{Done}} - Record the widget size {{Done}} - Resize the view before the playback {{Doing}} - Add QMessageBox to prevent the user - BUG - {{Doing}}''
|-
|ctkVTKScalarBarWidget
|{{Done}}{{Doing}}
|
|bgcolor="#f4db9e" |''QSpinBox issue + key "."(pad) on the line edit''
|-
|ctkVTKScalarsToColorsUtils
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsView
|{{Not Done}}
|
|
|-
|ctkVTKScalarsToColorsWidget
|{{Not Done}}
|
|
|-
|ctkVTKSliceView
|{{Doing}}
|'''+++'''
|''may use the ctkVTKRenderView translator & player''
|-
|ctkVTKSurfaceMaterialPropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKTextPropertyWidget
|{{Done}}
|
|
|-
|ctkVTKThresholdWidget
|{{Not Done}}
|
|
|-
|ctkVTKThumbnailView
|{{Not Done}}
|
|
|-
|ctkVTKVolumePropertyWidget
|{{Not Done}}
|
|
|-
|ctkVTKWidgetsUtils
|{{Not Done}}
|
|
|}
{| class="wikitable alternance" style="text-align:left; width:100%; border:1px solid black;"
|+ '''''CTKDICOMWidgets'''''
|-
! scope=col style="background:#cde6f8;"| Widgets
! scope=col style="background:#cde6f8;"| State
! scope=col style="background:#cde6f8;"| Priority
! scope=col style="background:#cde6f8;"| Notes
|-
|ctkDICOMAppWidget
|{{Not Done}}
|
|
|-
|ctkDICOMDatasetView
|{{Not Done}}
|
|
|-
|ctkDICOMDirectoryListWidget
|{{Not Done}}
|
|
|-
|ctkDICOMImage
|{{Not Done}}
|
|
|-
|ctkDICOMImportWidget
|{{Not Done}}
|
|
|-
|ctkDICOMItemTreeModel
|{{Not Done}}
|
|
|-
|ctkDICOMListenerWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryResultsTabWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryRetrieveWidget
|{{Not Done}}
|
|
|-
|ctkDICOMQueryWidget
|{{Not Done}}
|
|
|-
|ctkDICOMServerNodeWidget
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailGenerator
|{{Not Done}}
|
|
|-
|ctkDICOMThumbnailListWidget
|{{Not Done}}
|
|
|}
|}