Documentation/Widget testing

From Commontk
Jump to navigationJump to search
Home < Documentation < Widget testing

Back to CTK Documentation

Overview

Testing of both CTK widgets and application built on top of CTK could leverage the capabilities offered by the QtTesting library developed by 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 :

  1. Download external project QtTesting
  2. Compile the CTKQtTesting Library
    • Including the class :
      • ctkEventTranslaterPlayerWidget : Widget used by the Unit Test - 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.
  3. For CTKWidget - CTKVisualizationWidget - CTKCoreWidget :
    • Include the event translator and player required for custom widgets. (Located in the same folder as their associated widget sources)
  4. 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 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

  1. Create a variable ctkTestingUtiliy - can be added to your mainWindow class.
  2. Create a button Redord, and link it to the ctkTestUtility slot record
  3. Create a button Play, and link it to the ctkTestingUtility slot play

Limits

  1. 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 Note: We are working on this limit to find a better solution.

  1. All the CTK Widgets are not yet tested - Below 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 Znak A-14.png - 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 : Yes check.png

  1. Change the normalization into a normalization by the widget center.
  2. Implemented the scroll action
  3. 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 : ... X mark.png

Building

Milestones

  1. Integrate QtTesting has an external projects Yes check.png
  2. Add unit test to all the widget - Below, the summuray table -
    1. Implement ctkEventTranslaterPlayerWidget Yes check.png
    2. Create custom translator/player if needed Znak A-14.png
    3. Implement widgets EventTranslatorTests Znak A-14.png
  3. Create an Application test - ctkQtTesting - Yes check.png

Player/Translators Widget Testing

Summury table, to know each widgets' state.
The state can be Done : Yes check.png , Done with QtTesting issue : Yes check.pngZnak A-14.png , in progress : Znak A-14.png , or without unit test: X mark.png.

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

Screenshots