Running Unit Tests

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. Using the GoogleTest Runner extension for Visual Studio in order to integrate tests into the Test Explorer. This requires a version of Visual Studio that supports the use of extensions.

2. Invoking 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. You can, of course, also go to the UnitTests build output directory and directly run the binary:

pushd Build\x64\Release\UnitTests\bin
UnitTests

Running tests on CMake-based systems (Linux / macOS)

Use the unittests build target:

make unittests

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