From 1a7f7e85c2294d4d77377017facf80e19bd9ae6e Mon Sep 17 00:00:00 2001 From: shuffle2 Date: Wed, 3 Sep 2014 13:45:28 -0700 Subject: [PATCH] Updated Running unit tests (markdown) --- Running unit tests.md | 33 +++++++++++++++++++++++++++++++++ Running-unit-tests.md | 17 ----------------- 2 files changed, 33 insertions(+), 17 deletions(-) create mode 100644 Running unit tests.md delete mode 100644 Running-unit-tests.md diff --git a/Running unit tests.md b/Running unit tests.md new file mode 100644 index 0000000..10253af --- /dev/null +++ b/Running unit tests.md @@ -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``. \ No newline at end of file diff --git a/Running-unit-tests.md b/Running-unit-tests.md deleted file mode 100644 index 22839fd..0000000 --- a/Running-unit-tests.md +++ /dev/null @@ -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``. \ No newline at end of file