11 Running Unit Tests

Amphitryon0 edited this page 2024-12-08 04:11:12 -06:00

Table of Contents

• Running Tests on Windows
• Running Tests on CMake-Based Systems (Linux and macOS)

The Dolphin source code contains unit tests that aim to:

• Help find bugs when porting Dolphin to a new platform
• Make refactoring and code changes safer by enforcing API contracts

The tests are located in the Source/UnitTests directory and use the Google Test framework.

For tests that can compare Dolphin to actual hardware, see the hwtests repository.

Running Tests on Windows

The UnitTests project is compiled as part of the normal build on Windows. There are a few ways to run the tests:

1. Use the Test Adapter for Google Test component for Visual Studio in order to integrate tests into the Test Explorer.

2. Invoke execution via msbuild with the RunUnitTests property, for example:

pushd Source
msbuild /v:m /m /p:Platform=x64 /p:Configuration=Release /p:RunUnitTests=true dolphin-emu.sln

3. Directly run the UnitTests binary:

pushd Build\x64\Release\UnitTests\bin
UnitTests

Running Tests on CMake-Based Systems (Linux and macOS)

Use the unittests build target:

make unittests

Each module test can also be run independently using the binaries in $OUTPUT_DIR/Binaries/Tests.

Dolphin GitHub Wiki

• Building

  • Linux
  • Windows
  • macOS
  • OpenBSD

• Feature explanations

  • FIFO Player Overview
  • Running Unit Tests
  • IOS Overview
  • Post Processing Shaders
  • Sys and User Folders

• Dolphin Infrastructure

  • About Dolphin's CI Bot
  • Buildbot Overview
  • Release Process
  • Auto Update Internals
  • Who Can Access What?

• Reference

  • Zelda Microcode
  • GameCube Action Replay Code Types
  • GameCube Action Replay Code Types (Simple Version)

Homepage | Project Site | Forums | Wiki | Issue Tracker | Coding Style | Transifex Page