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.

If the option CTK_USE_QTTESTING is enabled, the build system will:

• Download external project QtTesting
• Include the event translator and player required for custom CTK widgets. (Located in the same folder as their associated widget sources)
• Include the class ctkEventTranslaterPlayerWidget into CTKWidgets library
• If BUILD_TESTING is enabled: CTK widgets EventTranslatorTests will be compiled. These tests will use ctkEventTranslaterPlayerWidget and ensure that events associated with CTK widgets can be properly recorded and played.

Note: Option CTK_USE_QTTESTING will be automatically enabled if BUILD_TESTING is ON

Milestones

1. Integration: What and where.
2. Integrate QtTesting has an external projects
3. Implement ctkEventTranslaterPlayerWidget
4. Create custom translator/player if needed
5. Implement widgets EventTranslatorTests

Player/Translators Widget Testing

CTKWidgets

class="wikitable alternance" style="text-align:left; width:40%; border:1px solid black;"
Widgets	State	Priority	Notes
ctkActionsWidget
ctkAddRemoveComboBox
ctkAxesWidget
ctkBasePopupWidget		+++	ctkPopupWidget inherit of it. So we Test Directly ctkPopupWidget
ctkButtonGroup
ctkCheckableComboBox		+	minor issue with the currentText()
ctkCheckableHeaderView		++	more test ?
ctkCheckBoxPixmaps		--	Not used in Slicer
ctkCheckablePushButton		--	Not used in Slicer
ctkComboBox
ctkCompleter		-
ctkCollapsibleButton
ctkCollapsibleGroupBox
ctkColorDialog			QSpinBox issue if used
ctkColorPickerButton			QSpinBox issue if used
ctkConsole			May have a problem with the command
ctkConfirmExitDialog		-
ctkCoordinatesWidget			Problem with the QSpinBox
ctkCrosshairLabel		-
ctkDateRangeWidget			Problem with QDateTimer
ctkDirectoryButton			Value OK but no dialog
ctkDoubleRangeSlider
ctkDoubleSlider
ctkDynamicSpacer		-
ctkErrorLogStatusMessageHandler		---	Not a Widget
ctkErrorLogWidget		---
ctkExpandButton
ctkFileDialog			EventTranslator ?
ctkFittedTextBrowser		--	This widget just display text.
ctkFlowLayout		--	Layout are not tested through the event translator/player mechanism
ctkFontButton			QComboBox doesn't change the font
ctkIconEnginePlugin		--	Plugin are not tested through the event translator/player mechanism
ctkLayoutManager
ctkMaterialPropertyPreviewLabel			Not sure if something is requiered since it seems to be a label
ctkMaterialPropertyWidget			QSpinBox issue
ctkMatrixWidget			Skip all the visual effect
ctkMenuButton			Use in Slicer ? Implemented event translator/player
ctkMenuComboBox		+++	Issue if the subMenus have no parent
ctkModalityWidget
ctkPathLineEdit		++	Little issue with the listView for the fist show - As ctkMenuComboBox
ctkPixmapIconEngine		++
ctkPopupWidget		+	Implemented event translator/player
ctkQImageView		---
ctkRangeSlider
ctkRangeWidget			QDoubleSpinBox issue
ctkScreenshotDialog		-
ctkSearchBox
ctkSettings		+	Need a Test ?
ctkSettingsDialog		+
ctkSettingsPanel		+	It's a panel so doesn't need to be tested. However, is tested in ctkSettingsDialog testing
ctkSignalMapper			This object is not a widget and doesn't have to be tested through the event translator/player mechanism
ctkSimpleLayoutManager
ctkSliderWidget			QSpinBox Issue
ctkTestApplication			This is a utility class. Shouldn't be tested using the event translator/player mechanism
ctkThumbnailListWidget		--
ctkThumbnailWidget		--
ctkToolTipTrapper			This is a utility class. Shouldn't be tested using the event translator/player mechanism
ctkTransferFunctionBarsItem		-
ctkTransferFunctionControlPointsItem		-
ctkTransferFunctionGradientItem		-
ctkTransferFunctionItem		-
ctkTransferFunctionScene		-
ctkTransferFunctionView		-
ctkTreeComboBox		+	Good method ?
ctkWidgetsUtils			This is a utility class. Shouldn't be tested using the event translator/player mechanism
ctkWorkflowAbstractPagedWidget		-
ctkWorkflowButtonBoxWidget		-
ctkWorkflowGroupBox		-
ctkWorkflowStackedWidget		-
ctkWorkflowTabWidget		-
ctkWorkflowWidget		-
ctkWorkflowWidgetStep		-

|{| class="wikitable alternance" style="text-align:left; width:40%; border:1px solid black;" |+ CTKVisualizationVTKWidget |- ! scope=col style="background:#cde6f8;"| Widgets ! scope=col style="background:#cde6f8;"| State ! scope=col style="background:#cde6f8;"| Priority ! scope=col style="background:#cde6f8;"| Notes |- | | | | |- | | | | |}}

Screenshots

• 

  Simple application with recording / playing Qt testing capabilities

• 

  Little exemple of the widget testing