3rd-party
/
catch2
mirror of https://github.com/catchorg/Catch2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update contributing.md to reflect current test setup

This commit is contained in:
Martin Hořeňovský 2019-01-19 13:04:45 +01:00
parent bc02ada4b0
commit 2988e9f6cf
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/contributing.md
View File

@ -42,36 +42,37 @@ functionality, you should add tests covering and showcasing it. Even if you have
only made changes to Catch internals (i.e. you implemented some performance only made changes to Catch internals (i.e. you implemented some performance
improvements), you should still test your changes. improvements), you should still test your changes.
This means 3 things This means 2 things
* Compiling Catch's SelfTest project: * Compiling Catch's SelfTest project:
``` ```
$ cd Catch2 $ cd Catch2
$ cmake -Bcmake-build-debug -H. -DCATCH_BUILD_TESTING=ON $ cmake -Bdebug-build -H. -DCMAKE_BUILD_TYPE=Debug
$ cd cmake-build-debug/ $ cmake --build debug-build
$ make
``` ```
-- code that does not compile is evidently incorrect. Obviously, you are not because code that does not compile is evidently incorrect. Obviously,
expected to have access to all compilers and platforms Catch supports, Catch's you are not expected to have access to all the compilers and platforms
CI pipeline will compile your code using supported compilers once you open a PR. supported by Catch2, but you should at least smoke test your changes
on your platform. Our CI pipeline will check your PR against most of
the supported platforms, but it takes an hour to finish -- compiling
locally takes just a few minutes.
* Running the SelfTest binary:
```
$ ./cmake-build-debug/projects/SelfTest
```
There should be no unexpected failures on simple run.
*Note: on Windows, the binary is located at `cmake-build-debug\projects\Debug\SelfTest`*
* Running Catch's approval tests: * Running the tests via CTest:
``` ```
$ ./scripts/approvalTests.py $ cd debug-build
$ ctest -j 2 --output-on-failure
``` ```
Approval tests compare current output of the SelfTest binary in various If you added new tests, approval tests are very likely to fail. If they
configurations against known good output. If you've configured the SelfTest do not, it means that your changes weren't run as part of them. This
binary with your changes to be located in any other directory than _might_ be intentional, but usually is not.
`/cmake-build-debug/projects/SelfTest`, its path needs to be passed to the
script, like so: `$ ./scripts/approvalTests.py clang-build/SelfTest`. The approval tests compare current output of the SelfTest binary in various
The output should be fairly self-explanatory. configurations against known good outputs. The reason it fails is,
_usually_, that you've added new tests but have not yet approved the changes
they introduce. This is done with the `scripts/approve.py` script, but
before you do so, you need to check that the introduced changes are indeed
intentional.