Updated Running unit tests (markdown)

shuffle2 2014-09-03 13:45:28 -07:00
parent a886ad3bbc
commit 1a7f7e85c2
2 changed files with 33 additions and 17 deletions

33
Running unit tests.md Normal file

@ -0,0 +1,33 @@
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](https://code.google.com/p/googletest/) framework.
## 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](http://visualstudiogallery.msdn.microsoft.com/9dd47c21-97a6-4369-b326-c562678066f0) extension for Visual Studio in order to integrate tests into the Test Explorer.
Requires a version of Visual Studio supporting 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 / OS X)
Use the ``unittests`` build target:
make unittests
Each module test can also be run independently using the binaries in ``$OUTPUT_DIR/Binaries/Tests``.

@ -1,17 +0,0 @@
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](https://code.google.com/p/googletest/) framework.
## Running tests on Windows
**TODO**
## Running tests on CMake-based systems (Linux / OS X)
Use the ``unittests`` build target:
make unittests
Each module test can also be run independently using the binaries in ``$OUTPUT_DIR/Binaries/Tests``.