Unreal Engine Testing Framework

Last modified: 25 September 2024

JetBrains Rider includes support for the Unreal Engine testing framework. To work with Unreal Engine tests, use the Unit Tests window. In this tool window you can review the results of the tests, reruns failed, and all or specific tests.

Running UE tests

tip

For more information about working with C++ tests, refer to Unit Testing Assistance in C++.

Setting up

The Unreal Engine testing framework is built in and the Engine tests work without any additional configuration.

To get Unreal Engine plugin tests running in JetBrains Rider, you need to:

  1. Index plugins by enabling Index plugins setting on the Languages & Frameworks | C++ | Unreal Engine page of JetBrains Rider settings .

  2. Reference the plugin that includes the tests in the .uproject file.

Explore tests

In the Unit Tests window, you can explore all the existing categories in the current solution. The categories are defined by the flags passed to the tests. Use Group By switcher to change the grouping in the tool window.

Group By

Run tests

To run a single test or all tests in a test class, click the action indicator next to it. Even if you have a set of Spec tests defined in the Define method after the DEFINE_SPEC macro or the BEGIN_DEFINE_SPEC/END_DEFINE_SPEC macros, JetBrains Rider will successfully discover them and show the corresponding icon. You can also place the caret at the test /test class and press . In the action list, choose Run/Debug for a test class.

Alternatively, you can use the Run Unit Tests Run Unit Tests /Debug Unit Tests Debug Unit Tests commands, which are also available in the main menu ( Tests) and in the context menu.

UE Spec tests

Tests with EAutomationTestFlags::Disabled flag will stay disabled in JetBrains Rider, and will be marked with the corresponding Ignored symbol. Inconclusive tests are aborted tests, or other tests which were started but JetBrains Rider could not read the test runner output.