Running Gauntlet Tests

Instructions on how to run a Gauntlet test and an explanation of what happens during the process.

Choose your operating system:

Windows

macOS

Linux

In this guide, you will run an existing Gauntlet test available for the Elemental demo in Unreal Engine. This will familiarize you with the process for running tests and give you an idea what is happening at each step along the way.

ElementalDemo Test Node

image_0.png

Run the ElementalDemo Example

  1. Open a command prompt and change directory to Engine/Build/BatchFiles within your Unreal Engine root directory.

  2. Enter the following in the command prompt:

    RunUAT BuildCookRun -project=Samples/Showcases/ElementalDemo/ElementalDemo.uproject -platform=Win64 -configuration=Development -build -cook -pak -stage
  3. Once that process completes, enter the following in the command prompt:

    RunUAT RunUnreal -project=Samples/Showcases/ElementalDemo -platform=Win64 -configuration=Development -build=local -test=ElementalDemoTest

ElementalDemo Test Explanation

  1. BuildCookRun generated a Win64 build of ElementalDemo in Samples/ElementalDemo/Saved/StagedBuilds.

  2. RunUnreal launched Gauntlet, which:

    1. Created an instance of the ElementalDemoTest node, which provided basic rules for running the test.

    2. Discovered local builds for the ElementalDemo Project.

    3. Validated that a Win64 Development build was available.

    4. Launched ElementalDemo.

    5. Monitored the running process for any issues.

    6. Detected that ElementalDemo had exited.

    7. Checked for common issues such as crashes, asserts, and fatal errors.

  3. Along the way, provided the ElementalDemoTest node verifies that the test was still running and that no errors had occurred, create a summary report.

Tags