catch2/docs
Philip Salzmann d548be26e3
Add new SKIP macro for skipping tests at runtime (#2360)
* Add new SKIP macro for skipping tests at runtime

This adds a new `SKIP` macro for dynamically skipping tests at runtime.
The "skipped" status of a test case is treated as a first-class citizen,
like "succeeded" or "failed", and is reported with a new color on the
console.

* Don't show "skipped assertions" in console/compact reporters

Also extend skip tests to cover a few more use cases.

* Return exit code 4 if all test cases are skipped

* Use LightGrey for the skip colour

This isn't great, but is better than the deep blue that was borderline
invisible on dark backgrounds. The fix is to redo the colouring
a bit, including introducing light-blue that is actually visible.

* Add support for explicit skips in all reporters

* --allow-running-no-tests also allows all tests to be skipped

* Add docs for SKIP macro, deprecate IEventListener::skipTest

Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
2023-01-12 15:01:47 +01:00
..
assertions.md Update explanation of REQUIRE_FALSE in docs/assertions.md 2022-10-17 15:13:00 +02:00
benchmarks.md Mention that run == iteration in benchmarking docs 2021-11-15 23:09:18 +01:00
ci-and-misc.md v3.2.0 2022-11-16 20:05:48 +01:00
cmake-integration.md Fix typos in docs (#2514) 2022-09-09 16:00:39 +02:00
command-line.md Add new SKIP macro for skipping tests at runtime (#2360) 2023-01-12 15:01:47 +01:00
commercial-users.md Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
comparing-floating-point-numbers.md Update comparing-floating-point-numbers.md 2022-10-29 12:42:45 +02:00
configuration.md v3.2.0 2022-11-16 20:05:48 +01:00
contributing.md Mention BUILD.bazel in contributing docs for CATCH_CONFIG* 2022-11-12 22:08:23 +01:00
deprecations.md Add new SKIP macro for skipping tests at runtime (#2360) 2023-01-12 15:01:47 +01:00
event-listeners.md Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
faq.md Add repeatability guarantees to faq.md 2022-11-16 11:21:00 +01:00
generators.md Mention that RangeGenerator works on half open ranges 2021-11-15 23:52:26 +01:00
limitations.md Avoid usage of master when possible 2022-12-09 23:22:10 +01:00
list-of-examples.md Examples: remove references to catch_default_main 2022-02-20 13:10:42 +01:00
logging.md Fix introduced in version placeholders 2021-03-13 10:26:12 +01:00
matchers.md Add MessageMatches matcher for exception (#2570) 2022-12-12 00:40:47 +01:00
migrate-v2-to-v3.md Explain TU as translation unit where appropriate 2022-09-03 22:22:10 +02:00
opensource-users.md Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
other-macros.md v3.0.1 2022-05-17 22:13:36 +02:00
own-main.md Rewrite own-main.md for v3 2021-11-19 15:52:32 +01:00
Readme.md Add new SKIP macro for skipping tests at runtime (#2360) 2023-01-12 15:01:47 +01:00
release-notes.md v3.2.1 2022-12-09 23:10:18 +01:00
release-process.md Update release-process.md for v3 2022-01-03 23:30:39 +01:00
reporter-events.md Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
reporters.md v3.0.1 2022-05-17 22:13:36 +02:00
skipping.md Add new SKIP macro for skipping tests at runtime (#2360) 2023-01-12 15:01:47 +01:00
test-cases-and-sections.md Remove obsolete link to benchmarking tests 2022-07-15 19:49:24 +02:00
test-fixtures.md Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
tostring.md Fix introduced in version placeholders 2021-03-13 10:26:12 +01:00
tutorial.md Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
usage-tips.md Fix typos in docs (#2514) 2022-09-09 16:00:39 +02:00
why-catch.md Fix typos in docs (#2514) 2022-09-09 16:00:39 +02:00