Skip to end of metadata
Go to start of metadata

Overview

The Test Runner is the engine tool dedicated to testing certain features of the engine, projects or the plugins that have been previously implemented. The Test Runner makes it possible to run feature tests more easily and quickly; it is especially useful for non-programmers as it can be used to run custom tests provided that they have been previously introduced to the Engine.

The default tests that have been provided in the Test Runner tool can only be used to test the Engine-specific features. If a different feature needs to be tested, a related test should be introduced to the Engine first. For more information about introducing new tests to Test Runner, please refer to the Test Runner programming page.

The Test Runner tool can be used to run all the tests that are available under a category, or to run a test individually.

The Test Runner tool can be found on Tools → Advanced → Test Runner and it is comprised of the following sections:

1. Menu

The Menu can be accessed via the  button on the top-right corner of the Test Runner. When clicked, it reveals the following sub-menus.

Toolbars

Option

Description

Customize...

Opens the toolbar customization window allowing users to customize existing toolbars, and/or create new toolbars within the Test Runner.

Lock Toolbars

When disabled, the positions of toolbars and spacers within the Test Runner can be changed by drag and drop.

Spacers

The following options allow users to use spacers in positioning their toolbars.

Insert Expanding SpacerAdds an expanding spacer to the toolbar layout; an expanding spacer pushes all elements situated at its ends to the edge of a panel.
Insert Fixed SpacerAdds a fixed spacer, which has a fixed size of one icon.


The Spacers menu options are only available when Toolbars → Lock Toolbars is disabled.
ToolbarsLists all default and custom toolbars created for the Test Runner, allowing you to select which toolbar you'd like to hide or display.

When a tool has a toolbar, whether this is a default one or a custom one, the options above are also available when right-clicking in the toolbar area (only when a toolbar is already displayed).

Window

Option

Description

Panels

Displays the panels that have been previously closed or not yet opened on the Test Runner panel.

The following panels can be displayed via this option:

  • Output
  • Tests

Reset layout

Resets the layout. This option is a quick way to go back to the default Test Runner layout.

Help

Opens the documentation page for this tool.

2. Tests Panel

The Tests panel displays all the available tests that can be executed. These can either be the default tests or the custom ones that were already implemented by the user.

When a single test or a category is right-clicked, a context menu appears with Run selected tests option which then can be clicked upon to execute these test(s).

The Tests panel is comprised of the following sections:

SectionDescription
Run AllExecutes all the tests that are currently available in the Tests list.
Search BarSearches for a specific test based on its name, narrowing down the scope of the displayed tests on the list.
TestsDisplays the tests that can be executed.
ResultsDisplays the result of the tests that has been executed.

3. Output Panel

The Output panel of the Test Runner tool displays the result of each test that has been previously executed. The outcome of each tool can be different depending on whether a test fails or succeeds.

The Output panel is especially useful to see where in the Engine a test failed and why. It then helps the user to track down the source of the problem and potentially fix it.

The test results will be archived in <Project Folder>\user\testresults, as an .xml file.

On This Page