Skip to main content

Automated and Performance Tests

Last updated on October 23, 2024

Overview

ADT translates the results of your automated and performance tests from the JSON output file into an easy-to-interpret graph and test status.

You can choose from two types of test in ADT:

  1. Automated - script your automated test and send the results to ADT for collation and reporting.
  2. Performance - this is where you dig into the performance of your game and send the results to ADT.

Across ADT we call files that are added to a game build "metadata" files.

Automated tests

The two automated tests are known as the Sniff test and the Smoke test.

  • A Sniff test automatically tests the basics of a build, such as: Does it launch? Does it run?
  • A Smoke test typically runs through a much more rigorous testing regime. It tests whether certain states that you have tested for are achieved through your automated test.

Both of these tests are typically set up by build engineers and the QA team to run autonomously. For details, see Interpret the automated test output.

Performance test

These are the performance test measures:

  • Frame time
  • GPU time
  • Draw time

To perform these tests, you need to create a test that generates a JSON file using the correct format. Interpret the automated test output.

Run an automated test or performance test

These steps explain how to run an automated test or performance test in a sample game using Unreal Editor.

  1. Launch the project in Unreal Engine.
  2. Click the Window menu.
  3. Choose Developer Tools - Session Frontend.
  4. Click the Automated tab.
  5. Enable the Automated Test or Performance Test option.
  6. Click the Start Tests button. Unreal runs the test and outputs a JSON file.
  7. Use ADT CLI to upload the JSON file to the ADT Backend.