3rd-party
/
catch2
mirror of https://github.com/catchorg/Catch2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
4,460 Commits 8 Branches 131 Tags 78 MiB
Commit Graph

739 Commits

Author SHA1 Message Date
Alex Voicu ce54ec185f
Add the HIP CPU Runtime as a Catch2 user (#2123) 2020-12-18 13:23:17 +01:00
Norbert Wenzel be813faaa0 Fix typo 2020-12-12 15:31:20 +01:00
Emil Jarosz b9fe8a208f
Update cmake-integration.md 
The "contrib" folder was renamed to "extras", but the name wasn't updated in the documentation.
 2020-11-30 13:10:26 +00:00
Martin Hořeňovský 3bd5fd6bc5
Mention GENERATE decaying inputs in release notes docs 2020-11-26 18:35:02 +01:00
Martin Hořeňovský 33bcdc6bf5
Picked release notes for v2.13.3 2020-11-02 14:42:24 +01:00
laoshanxi ed9ef85a34
Add AppMesh to Open Source projects using Catch 2020-11-02 14:42:13 +01:00
Augustas dc3c22f9ec
update from Hudson to Jenkins 
Hudson is discontinued in 2016. Changed to Jenkins
 2020-10-31 21:48:28 +02:00
Martin Hořeňovský 735f46ed6d
Link to the migration docs from main readme and docs/readme 2020-10-31 09:08:58 +01:00
Martin Hořeňovský 39aabede62
Add a short documentation for migrating from v2 to v3 2020-10-31 08:14:50 +01:00
Clare Macrae 40b9df567f Add missing cmake option to fix buildAndTest.sh 
Note that the documentation was updated automatically, by running:
 ./tools/scripts/updateDocumentSnippets.py
 2020-10-28 11:38:06 +01:00
Clare Macrae c6352c3e1f Embed the script buildAndTest.sh inside the docs 2020-10-28 11:38:06 +01:00
Clare Macrae f57689f888 Fix minor typo in docs. 2020-10-28 11:38:06 +01:00
Martin Hořeňovský 0c7f96ba63
Update documentation not to reference master branch 2020-10-21 19:59:59 +02:00
Martin Hořeňovský b9853b4b35
Bump version to v3.0.0 preview 3 2020-10-08 15:26:30 +02:00
Martin Hořeňovský 853565bfb8
Pick release notes for v2.13.2 2020-10-08 12:51:07 +02:00
Matt Godbolt b841650253
Add missing syntax highlighting tag 2020-10-08 11:37:31 +02:00
Martin Stump c522e88afa
Add REPORTER and OUTPUT_* args 2020-10-08 11:35:42 +02:00
Florian Berchtold b1df96e7e4
Docu/Show how to use CMake FetchContent (#2028) 2020-10-08 11:35:18 +02:00
kotaiadam 9e172c707e
fixes bug in example - undeclared identifier 
j was not declared in `SECTION("two")`
 2020-10-08 11:34:25 +02:00
Martin Hořeňovský 340ff00058
Rewrite contributing docs for v3 2020-10-06 12:36:20 +02:00
Martin Hořeňovský d1625f30b1
Pick release notes from v2.13.1 2020-09-07 14:34:36 +02:00
mattkurz 08fb5cbab2
Fix typo in generators docs 2020-09-07 13:02:38 +02:00
Martin Hořeňovský 33ad1ee2ac
Split EventListener base from streaming_base.hpp 
The base was also renamed from `TestEventListenerBase` to
`EventListenerBase`, and modified to derive directly from the
reporter interface, rather than deriving from `StreamingReporterBase`.
 2020-08-29 19:09:54 +02:00
Martin Hořeňovský 6efeecc179
Cherry-pick doc updates for v2.13.0 2020-07-26 15:14:38 +02:00
Martin Hořeňovský a004423c7f
Improve documentation for --min-duration 2020-07-26 14:06:52 +02:00
Martin Hořeňovský 4b344f11ea
Document GENERATE's new usage between SECTIONs 2020-07-26 14:06:34 +02:00
John Bytheway 80b0d6975c
Add --min-duration option 
A test runner already has a --durations option to print durations.
However, this isn't entirely satisfactory.

When there are many tests, this produces output spam which makes it hard
to find the test failure output.  Nevertheless, it is helpful to be
informed of tests which are unusually slow.

Therefore, introduce a new option --min-duration that causes all
durations above a certain threshold to be printed.  This allows slow
tests to be visible without mentioning every test.
 2020-07-26 10:47:53 +02:00
Eric Huber 36131f7ffa
Escaping literal "*" ("times") to fix markdown 2020-07-24 22:36:58 +02:00
Martin Hořeňovský f52018205d
Cherry pick release notes for v2.12.4 2020-07-24 22:36:13 +02:00
Martin Hořeňovský e28018c659
Cherry pick release notes for v2.12.3 2020-07-24 22:33:59 +02:00
Martin Hořeňovský 2a25a267ea
Cherry pick release notes for v2.12.2 2020-07-24 22:33:26 +02:00
Richard Ash 2840ce1e70
Add an example of using GENERATE(table()) 
There are some examples on issue #850 of using this feature, but they
are not easily found from the documentation. Adding them here as an
example makes them more findable and ensures they keep working if the
API changes.
 2020-07-22 21:49:54 +02:00
Richard Ash ed9be5a00b
Add notes on compiling the examples. 
This took me some time to figure out so document for others.
 2020-07-22 21:43:53 +02:00
Martin Hořeňovský 314bb7e632
Clarify documentation about nested generators 
Closes #1947
 2020-07-22 21:18:49 +02:00
Martin Hořeňovský 4394d3ae65
Translate exceptions by const reference instead of plain ref 2020-05-20 08:15:27 +02:00
Martin Hořeňovský e867ce7769
Fix missing backticks on release notes 
Closes #1932
 2020-05-15 10:54:20 +02:00
Martin Hořeňovský f7fbbac601
Update release notes for v3 2020-05-14 14:57:22 +02:00
Martin Hořeňovský ddde2f5e33
Remove obsolete configuration macros from the documentation 2020-05-14 14:52:33 +02:00
Martin Hořeňovský d5e87eabbb
Add provided generic matchers to the documentation 2020-05-14 14:48:48 +02:00
Martin Hořeňovský 04c171f91f
Update CATCH_CONFIG_WINDOWS_CRTDBG docs to reflect new distribution 2020-05-06 18:17:51 +02:00
Martin Hořeňovský 31ff89709f
Pick docs for v2.12.1 2020-05-03 07:54:07 +02:00
Martin Hořeňovský 4aefbbcd02
Pick docs for v2.12.0 2020-05-03 07:49:05 +02:00
Martin Hořeňovský bbbc7a0d7f
Fix CATCH_CONFIG_CPP17_UNCAUGHT_EXCEPTION interaction with feature macro 2020-05-01 20:26:40 +02:00
Martin Hořeňovský 89fab65382
Update documentation for --order 2020-05-01 14:46:14 +02:00
Phoebe 46cc551b7a
Add vcpkg installation instructions (#1898) 
* Add vcpkg installation instructions

* Add index
 2020-05-01 09:31:41 +02:00
Mark Gillard f34aacfe5f
Added toml++ to opensource-users.md 2020-05-01 09:31:12 +02:00
Mark Gillard 0d3e933d71
Fix alphabetical ordering of opensource-users.md 2020-05-01 09:31:03 +02:00
Martin Hořeňovský 656b15d37b
Pick doc changes for v2.11.3 2020-05-01 09:28:17 +02:00
Martin Hořeňovský 08f8a81b2c
Picking v2.11.2 docs changes 2020-04-30 21:44:16 +02:00
Julius Hülsmann 38a0dfca6d
Update tutorial.md 
Fix: typo; remove trailing ","
 2020-04-29 21:17:54 +02:00
Julius Hülsmann b014d988fe
Update slow-compiles.md 
Add missing "."
 2020-04-29 21:17:30 +02:00
magnus.ornebring 7a0f8ff4b8
Add king as user 2020-04-29 16:55:03 +02:00
Martin Hořeňovský 4d63c36402
Update release notes with matcher changes 2020-03-29 14:57:29 +02:00
Martin Hořeňovský ab0ca2f566
Rename some matcher-related files 
The two changes are
`catch_matchers_templates` -> `catch_matchers_templated` and
`catch_matchers_generic` -> `catch_matchers_predicate`. The former
is mostly cosmetic, but the second was previously significantly
misleading, and as the library is now to be consumed by including
specific headers, this needed to be fixed.
 2020-03-27 10:24:08 +01:00
Martin Hořeňovský 3a3efebd16
Add IsEmpty and SizeIs matchers for ranges/containers 
`SizeIs` can accept both `size_t` and a matcher. In the first case,
it checks whether the size of the range is equal to specified size.
In the second case, it checks whether the provided matcher accepts
the size of the range.
 2020-03-27 10:24:08 +01:00
Martin Hořeňovský c2daf468bb
Standardize matcher headers to use .hpp suffix 2020-03-27 10:22:25 +01:00
Martin Hořeňovský 64d7f9b98a
New and hopefully improved documentation for matchers 2020-03-27 10:22:25 +01:00
Martin Hořeňovský a15ffb735d
Make ListeningReporter final 
In general, for Catch2 v3 we are making virtual types `final`,
unless they were explicitly designed to be derived-from.
`ListeningReporter` is definitely not designed to be derived-from.
 2020-03-09 21:15:30 +01:00
Martin Hořeňovský 3bb9fcd916
Remove trailing semi in REGISTER_TEST_CASE 2020-02-21 23:10:01 +01:00
Martin Hořeňovský cf6575576f
Start fixing up Matchers: namespaces, composition ops 
This commit also forbids composing lvalues of composed matchers, as
per previous deprecation notice. I do not expect this to be contentious
in practice, because there was a bug in that usage for years, and
nobody complained.
 2020-02-20 13:03:30 +01:00
Tristan Stenner 6a2c025bfc
Add command line option 'never' to --wait-for-keypress (#1866) 
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
 2020-02-16 16:11:11 +01:00
Clare Macrae 442283ee11
Add link to list of commercial user projects 2020-02-16 16:05:18 +01:00
Clare Macrae 3f81dd753a
Fix typo in link in docs 2020-02-16 16:05:08 +01:00
Martin Hořeňovský f8794634c2
Fix significant bug with storing composed matchers 
Given that in the 2 or so years that matchers are thing nobody complained,
it seems that people do not actually write this sort of code, and the
possibility will be removed in v3. However, to avoid correctness bugs,
we will have to support this weird code in v2.
 2020-02-16 16:02:31 +01:00
khyperia 3c7e737a7b
Allow configuring of benchmark warmup time 2020-02-16 15:44:23 +01:00
khyperia e880da93bd
Make CATCH_BREAK_INTO_DEBUGGER be user-configurable 2020-02-16 15:27:21 +01:00
Martin Hořeňovský 32617f42d0
Cherry-pick release notes for v2.11.1 2020-02-16 15:11:30 +01:00
Joe Burzinski 0fbf4f3e15
Fix wrong namespacing of benchmarking constructor helpers 2020-02-13 16:15:50 +01:00
Martin Hořeňovský 13e01d273a
Cherry pick v2.11.0 release notes and docs 2020-02-13 15:30:46 +01:00
Martin Hořeňovský cd7d7a1c67
Remove CATCH_CONFIG_ENABLE_BENCHMARKING compilation toggle 
Now that Catch2 is a proper library, we can always build the full
library (comparatively minor slowdown) and the user can avoid
including benchmarking headers to avoid the compilation slowdown.
 2020-02-06 11:36:46 +01:00
Martin Hořeňovský bce5b364d3
Unconditionally provide <chrono> StringMakers 2020-02-03 20:53:36 +01:00
Martin Hořeňovský ddd0e7218d
Remove the !hide special tag 2020-01-28 20:48:32 +01:00
Martin Hořeňovský 6c3a5ef625
Remove CATCH_CONFIG_DISABLE_MATCHERS 
Now that the recommended distribution and usage method is proper
library, users can just avoid including the matcher headers to get
basically the same effect.
 2020-01-25 09:07:36 +01:00
Martin Hořeňovský 70ef2f7f12
Update building of examples for static lib 2019-12-08 15:55:04 +01:00
Martin Hořeňovský 91ee07e08c
Moved scripts/ to tools/scripts/ 2019-12-06 11:53:31 +01:00
Martin Hořeňovský ae10e4ef72
Sections no longer save their description 
Users can still write a description for their sections, but it will
no longer be saved as part of the `SectionInfo` struct. This ability
has also been added to the documentation.

Closes #1319
 2019-11-03 23:13:25 +01:00
Martin Hořeňovský ca4c6218d4
Remove SourceLineInfo::empty() 2019-10-30 18:01:38 +01:00
Martin Hořeňovský 316a5c0572
Remove type erasure in predicate matcher 
Now the type of the predicate is part of the type of the
PredicateMatcher.
 2019-10-29 23:28:08 +01:00
Martin Hořeňovský 4f47d1c6c1
Hidden tests now require positive filter match to be selected 
This also required some refactoring of how the pattern matching
works. This means that the concepts of include and exclude patterns
are no longer unified, with exclusion patterns working as just
negation of an inclusion patterns (which led to including hidden
tags by default, as they did not match the exclusion), but rather
both include and exclude patterns are handled separately.

The new logic is that given a filter and a test case, the test
case must match _all_ include patterns and _no_ exclude patterns
to be included by the filter. Furthermore, if the test case is
hidden, then the filter must have at least one include pattern
for the test case to be used.

Closes #1184
 2019-10-29 14:07:18 +01:00
Martin Hořeňovský 2bcf1b3db6
Remove support for test case descriptions 
Closes #1189
 2019-10-29 14:07:18 +01:00
Martin Hořeňovský be44cfa63b
Specialize XML reporter's --list output 2019-10-29 14:07:18 +01:00
Martin Hořeňovský 0f39438aae
Stop checking verbosities up-front 2019-10-29 14:07:18 +01:00
Martin Hořeňovský c582e351ce
Remove --list-test-names-only 
People should use verbosity modifiers with `--list-tests` instead.

Closes #1190
 2019-10-29 14:07:18 +01:00
Martin Hořeňovský d2cddfc9c5
Make --list-* exit code be 0 
Previously it returned the sum of listed things because ???. This
was completely useless and in many ways actively counterproductive
because of the success/failure conventions around exit codes.

Closes #1410
 2019-10-29 14:07:18 +01:00
Martin Hořeňovský 557b336125
Remove superfluous semicolon in the INFO macro 
Closes #1456
 2019-10-29 14:07:18 +01:00
Martin Hořeňovský 141761745a
Remove ANON_TEST_CASE 
It can be fully replaced with `TEST_CASE` without any arguments,
so there is no need to keep it around.

Closes #1220
 2019-10-29 14:07:18 +01:00
Martin Hořeňovský 0685216175
Mark type erasure in PredicateFunction as deprecated 2019-10-28 15:15:13 +01:00
sp-dani-garcia 51b29ced1a Add SonarQube Generic Test Data reporter 
It outputs reports in the `Generic Execution Test Data` format, see
https://docs.sonarqube.org/latest/analysis/generic-test/, specifically
https://docs.sonarqube.org/latest/analysis/generic-test/#header-2

Close #1738 (this is a cherry-pick and fixup of that PR)
 2019-10-27 10:02:41 +01:00
Martin Hořeňovský 9a558171d8
Merge pull request #1776 from mvd4/bugfix/enable-floating-point-ranges 
Enable floating point ranges
 2019-10-27 09:17:15 +01:00
Martin Hořeňovský c5c688820c
Document that matcher combinators (&&, ||, !) do not take ownership 
Closes #1781
 2019-10-26 21:07:38 +02:00
Martin Hořeňovský 6a08225863
Add documentation for floating point `range` generator 2019-10-26 20:52:40 +02:00
Jozef Grajciar 87b745da66
v2.10.2 2019-10-24 18:41:25 +02:00
Martin Hostettler 8fb1219013 docs: command-line: Add example to specify tests by file name. 2019-10-21 23:51:33 +02:00
Martin Hořeňovský a2c8dce85c
v2.10.1 2019-10-20 21:03:22 +02:00
Martin Hořeňovský 1e379de9d7
Fix "ldd" -> "lld" typo in docs 2019-10-20 20:57:55 +02:00
Martin Hořeňovský 407ee0af2f
Add a section on slow linking under MinGW to "Known Limitations" docs 
Unless someone steps up to fix the long link times with a set of
unobtrusive changes, the recommended solution will remain "use a better
linker".

Related to #1205, #1247, and #1637

Closes #1247
Closes #1637
 2019-10-20 19:52:39 +02:00
Mertz, Arne 1aa98c76ac add a note how to run selftests using multiconfig generators 2019-10-17 20:23:51 +02:00
data-man 3195c242c2 Remove JSON library from users 2019-10-17 20:20:02 +02:00
Martin Hořeňovský 7c9f92bc1c
v2.10.0 2019-10-13 23:44:18 +02:00
Martin Hořeňovský a92a7d0229
Rewrite documentation for floating point matchers 2019-10-13 21:31:48 +02:00
Martin Hořeňovský 2cc0c71856
Add a matcher that checks exception's message 
Only works for exceptions that publicly derive from `std::exception`
and the matching is done exactly, including case and whitespace.

Closes #1649
Closes #1728

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
# On branch master
# Your branch is up-to-date with 'origin/master'.
#
# Changes to be committed:
#	modified:   ../docs/matchers.md
#	modified:   ../include/internal/catch_capture_matchers.h
#	modified:   ../projects/CMakeLists.txt
#	modified:   ../projects/SelfTest/Baselines/compact.sw.approved.txt
#	modified:   ../projects/SelfTest/Baselines/console.std.approved.txt
#	modified:   ../projects/SelfTest/Baselines/console.sw.approved.txt
#	modified:   ../projects/SelfTest/Baselines/junit.sw.approved.txt
#	modified:   ../projects/SelfTest/Baselines/xml.sw.approved.txt
#	modified:   ../projects/SelfTest/UsageTests/Matchers.tests.cpp
#
# Untracked files:
#	./
#	../clang-full/
#	../clang-test/
#	../clang10-build/
#	../coverage-build/
#	../gcc-build/
#	../gcc-full/
#	../include/internal/catch_matchers_exception.cpp
#	../include/internal/catch_matchers_exception.hpp
#	../misc-build/
#	../msvc-sln/
#	../notes.txt
#	../test-install/
#
 2019-10-13 20:37:07 +02:00
Martin Hořeňovský c8db4e77c4
Add a from_range(Container) overload to the generator helpers 2019-10-09 14:51:36 +02:00
Martin Hořeňovský 319cb9e1da
Add a generator that takes an iterator pair 2019-10-06 13:55:10 +02:00
Kevin Granade a0ebd63806
Add Cataclysm:Dark Days Ahead to project list 2019-10-05 20:18:31 -07:00
Wim Leflere fcda35f645 update name of Value Generators in doc to match class names 2019-10-04 13:31:37 +02:00
Martin Hořeňovský af84f1350e
Add documentation for the table generator helper 2019-09-21 01:00:53 +02:00
Martin Hořeňovský 293012a002
Inline SourceLineInfo::empty definition 2019-09-08 18:20:49 +02:00
Martin Hořeňovský 071bacad5e
Properly linkthrough additions to the configuration docs 2019-09-06 13:24:51 +02:00
Martin Hořeňovský addf799040
Workaround missing std::nextafter in uClibc 
Luckily, the rest of C++11 features seem to be supported...

Closes #1739
 2019-09-06 13:08:44 +02:00
Martin Hořeňovský 155274f0df
Add disabling the use of Android's logging at compile time 
This is done via the new compile time toggle,
`CATCH_CONFIG_ANDROID_LOGWRITE`.

Closes #1743
 2019-09-06 12:44:06 +02:00
Benjamin Schmithüsen 46f767e602
add UX3D to commercial users 2019-09-06 11:27:33 +02:00
Martin Hořeňovský edcfd7fc62
Add missed item to v2.9.2 release notes 2019-08-09 10:57:59 +02:00
Martin Hořeňovský 2c869e17e4
v2.9.2 2019-08-08 14:05:24 +02:00
Clare Macrae 67b4ada6b0 Add 'Introduced in Catch 2.3.0.' text 2019-08-02 19:18:47 +02:00
Clare Macrae 119569a67e Add 'Introduced in Catch 2.4.0.' text 2019-08-02 19:18:47 +02:00
Clare Macrae ab713894cc Add docs for AND_GIVEN macro - see #1360 2019-08-02 19:18:47 +02:00
Clare Macrae 69fc94d6f8 Add 'Introduced in Catch 2.4.1.' text 2019-08-02 19:18:47 +02:00
Clare Macrae 49cd7c96b4 Add 'Introduced in Catch 2.4.2.' text 2019-08-02 19:18:47 +02:00
Clare Macrae e998d152cc Add 'Introduced in Catch 2.5.0.' text 2019-08-02 19:18:47 +02:00
Clare Macrae 42a5903188 Add 'Introduced in Catch 2.6.0.' text 2019-08-02 19:18:47 +02:00
Clare Macrae c071f07e1a Add 'Introduced in Catch 2.7.0.' note 2019-08-02 19:18:47 +02:00
Clare Macrae 53776a90cf Add 'Introduced in Catch 2.7.1.' note 2019-08-02 19:18:47 +02:00
Clare Macrae 4511dc0c16 Add 'Introduced in Catch 2.8.0.' text 2019-08-02 19:18:47 +02:00
Clare Macrae e7c3bdb351 Add 'Introduced in Catch 2.8.0.' text 2019-08-02 19:18:47 +02:00
Clare Macrae 9aab958667 Add section headers, so I can later say when features were introduced 2019-08-02 19:18:47 +02:00
Clare Macrae 8cd58f75ec Add missing struct Template_Fixture_2 so that the example compiles. 
Code copied from projects/SelfTest/UsageTests/Class.tests.cpp
 2019-08-02 19:18:47 +02:00
Clare Macrae d5a69cd400 Add 'Introduced in Catch 2.9.0.' text 2019-08-02 19:18:47 +02:00
Martin Hořeňovský de0674c116
Add a template for creating new documentation page 
Related to #1695
 2019-08-02 13:17:22 +02:00
Martin Hořeňovský 3d7282c2bd
Add a section on documentation to contributing.md 
Related to #1695
 2019-08-02 10:58:51 +02:00
Czapa10 7b70b11c23 Add PopHead to Open Source projects using Catch 2019-07-30 09:37:05 +02:00
Martin Hořeňovský ab80277a86
Improve the REQUIRE_THROWS_MATCHES documentation a bit 2019-07-29 20:39:02 +02:00
Martin Hořeňovský 425957dc63
Update vector matcher documentation 
As it turns out, there were 2 undocumented vector matchers. I also
improved the documentation of them all.

Closes #1699
 2019-07-27 18:41:42 +02:00
Martin Hořeňovský d017f6d18f
Document CATCH_CONFIG_CPP17_BYTE macro 
Leftover from #1686
 2019-07-26 21:43:46 +02:00
Martin Hořeňovský 91244d30a7
Document CATCH_CONFIG_CPP17_OPTIONAL macro 2019-07-26 21:42:54 +02:00
Clare Macrae 032068b889
Fix typo in 2.7.1 release notes 
GENERATE_VAR -> GENERATE_REF
 2019-07-21 22:04:50 +01:00
Martin Hořeňovský 03ffc1014c
Add a notice that benchmarking supports needs opt-in 2019-07-14 15:49:17 +02:00
Clare Macrae 0c27554af5 Update Contents in docs #1667 2019-07-06 17:25:55 +02:00
Scott Hutchinson 6f32c67ea7 Adding to documentation for --order and --rng-seed 2019-06-21 15:17:55 +02:00
Martin Hořeňovský 2f631bb808
v2.9.1 2019-06-17 12:02:14 +02:00
Martin Hořeňovský f9dce28e7d
v2.9.0 2019-06-16 10:42:59 +02:00
Jozef Grajciar e90d5a86e4 docs for TEMPLATE_LIST_TEST_CASE 2019-06-15 15:40:39 +02:00
Martin Hořeňovský c365ac392b
Standardize and document the parallel processing toggle 2019-06-15 12:50:36 +02:00
Martin Hořeňovský b468d7cbff
Link benchmarking docs from the doc main page 2019-06-15 09:23:00 +02:00
Martin Hořeňovský e340ab8db6
Various improvements to the benchmarking support 
* Units from <ratio> are no longer redeclared in our own namespace
* The default clock is `steady_clock`, not `high_resolution_clock`,
because, as HH says "high_resolution_clock is useless. If you want
measure the passing of time, use steady_clock. If you want user
friendly time, use system_clock".
* Benchmarking support is opt-in, not opt-out, to avoid the large
(~10%) compile time penalty.
* Benchmarking-related options in CLI are always present, to decrease
the amount of code that is only compiled conditionally and making
the whole shebang more maintainble.
 2019-06-06 21:28:56 +02:00
Joachim Meyer ce2560ca95 Integrate Nonius benchmark into Catch2 
Changes done to Nonius:
* Moved things into "Catch::Benchmark" namespace
* Benchmarks were integrated with `TEST_CASE`/`SECTION`/`GENERATE` macros
* Removed Nonius's parameters for benchmarks, Generators should be used instead
* Added relevant methods to the reporter interface (default-implemented, to avoid
breaking existing 3rd party reporters)
* Async processing is guarded with `_REENTRANT` macro for GCC/Clang, used by default
on MSVC
* Added a macro `CATCH_CONFIG_DISABLE_BENCHMARKING` that removes all traces of
benchmarking from Catch
 2019-06-06 19:33:37 +02:00
Martin Hořeňovský 00347f1e79
v2.8.0 2019-05-26 22:47:00 +02:00
Jozef Grajciar 732e4b06db docs for signature based parametrised test cases 2019-05-23 21:03:47 +02:00
mlimber f1e14a1168 Add missing word 2019-05-09 22:40:59 +02:00
Martin Hořeňovský e2862a8d71
Add documentation for custom precision in float stringification 2019-05-03 15:40:21 +02:00
Phil nash 979bbf03bb Removed another redundant ; (from docs) 2019-04-27 18:52:38 +01:00
Phil nash 33ce3f3953 added cpp to another code block in docs 2019-04-27 18:51:26 +01:00
Phil nash 87a9424c9d Removed redundant ; 2019-04-27 18:50:05 +01:00
Phil nash 46066ede17 Merge branch enum stringification work 2019-04-26 11:26:45 +01:00
Wu Yuanshou 182fc3e46e fix example's mistake in slow-compiles.md 
the example lack the generation of factorial.o file which lead to an undefined reference error.
 2019-04-25 09:48:22 +02:00
Martin Hořeňovský 7c37501b07
v2.7.2 2019-04-22 23:15:59 +02:00
Phil Nash e02d9e788f Document CATCH_REGISTER_ENUM 2019-04-21 20:32:20 +03:00
Martin Hořeňovský 3978e9653b
Add more documentation on contributing 2019-04-18 16:18:30 +02:00
Martin Hořeňovský c3c82f539c
Merge pull request #1336 from ax3l/topic-overrideVirtualRedundant 
Refactor: override implies virtual
 2019-04-18 14:10:24 +02:00
Ryan Pavlik edde6f4736 Fix typos identified by codespell. 
Self test baselines also modified accordingly, due to
one typo found in a string in test code.
 2019-04-10 09:42:11 +02:00
Martin Hořeňovský b9dd1936e5
v2.7.1 2019-04-08 13:38:00 +02:00
Robin Lindén 7be35af167
Use correct filename in CMake integration docs 2019-04-07 15:41:34 +02:00
Martin Hořeňovský 3816e99d0c
Add GENERATE_COPY and GENERATE_VAR capturing generator macros 2019-03-31 14:11:10 +02:00
Omer Ozarslan 54089c4c8c Deducing return type of map generator helper (#1576) 
* Deduce map return type implicitly

Giving the first template argument to map generator function to deduce
return type is now optional even if the return type is different from
the type generated by mapped generator.
 2019-03-24 15:44:22 +01:00
Tadeusz Puźniakowski a1cdff4f18 raspigcd - opensource-users 
Added raspigcd that uses Catch2 for tests
 2019-03-19 20:35:59 +01:00
Steve Hollasch 4611125801 generators.md: fix extraneous back tick in doc 2019-03-14 09:14:02 +01:00
Clare Macrae e509012e64 Update blog URL and fic typos in tutorial.md 2019-03-09 18:02:29 +01:00
Clare Macrae 448825db03 Readability improvements for assertions.md 2019-03-09 18:02:29 +01:00
Clare Macrae 0fff8e7791 Add ApprovalTests.cpp to list of open source users 2019-03-09 18:02:29 +01:00
Yurii Nakonechnyi 37a4e32319
Added override keyword near IntRange::describe() method 2019-03-09 15:05:27 +02:00
Martin Hořeňovský d633072794
v2.7.0 2019-03-07 21:44:57 +01:00
Omer Ozarslan 1701325caa Document unscoped info 2019-03-06 22:04:35 +01:00
Martin Hořeňovský 5bf6e47381
Add another example for generators 2019-02-26 12:52:21 +01:00
Martin Hořeňovský 693647c43f
Add ChunkGenerator 
This generator collects values from the underlying generator until it
has a specified amount of them, and then returns them in one "chunk".
In case the underlying generator does not have enough elements for
a specific chunk, the left-over elements are discarded.

Closes #1538
 2019-02-23 20:28:58 +01:00
Martin Hořeňovský 288387fa10
Cleanup: move things around 2019-02-23 17:16:28 +01:00
Rick de Water 165de9b072 Add RangeGenerator 2019-02-23 16:58:34 +01:00
Martin Hořeňovský 269303d9d9
Introduce random number (Integral and Float) generators 2019-02-20 00:09:15 +01:00
Matt Clarke 95f7712808
Missing hyphens and full-stops added 
The use of full-stops is inconsistent, so I have added them where there are none.
The other option was to remove them instead.
 2019-02-13 10:13:14 +01:00
Martin Hořeňovský dbbab8727c
v2.6.1 2019-02-12 19:58:12 +01:00
Martin Hořeňovský 5d4061af12
Update release process docs to include PGP-signing 2019-02-12 19:33:08 +01:00
Jozef Grajciar c03b23c84b Added Makimo to list of commercial users 
Closes #1528
 2019-02-04 20:04:48 +01:00
Martin Hořeňovský d75e9b3c0f
v2.6.0 2019-01-31 22:32:55 +01:00
Martin Hořeňovský 67308bb606
Add documentation for CATCH_CONFIG_ENABLE_OPTIONAL_STRINGMAKER 
Related to #1510
 2019-01-31 15:36:52 +01:00
Martin Hořeňovský 061f1f836a
Update documentation and examples for generators 2019-01-31 10:43:25 +01:00
Jozef Grajciar 8d5d54e529 Docs: note to INFO 2019-01-22 12:37:03 +01:00
Martin Hořeňovský 084b1d5fe6
Fix colourized output to file 
This change should be backwards compatible, but it would be better
to make the console colour API take an argument in the long term.

Fixes #1502
 2019-01-19 13:32:39 +01:00
Martin Hořeňovský 4109870435
Merge pull request #1484 from Lotterleben/extend_contributing 
contributing.md: Add build instructions
 2019-01-19 13:06:06 +01:00
Martin Hořeňovský 2988e9f6cf
Update contributing.md to reflect current test setup 2019-01-19 13:05:27 +01:00
Lotte Steenbrink bc02ada4b0 Add build instructions to contributing.md 2019-01-19 13:05:22 +01:00
Torfinn Berset 0387fb64ce Added Bloomlife to list of commercial users 2019-01-14 18:11:38 +01:00
NeroBurner 23f023f9ed cpp higlighting for test-cases-and-sections.md 
add c++ highlighting for the last two examples, all others already have highlighting
 2019-01-10 12:29:21 +01:00
Jozef Grajciar 5b4ffd3c93 Docs: added docs for TEMPLATE_PRODUCT_TEST_CASE 2018-12-10 08:24:08 +01:00
Martin Hořeňovský d0de666362
Merge pull request #1458 from ndusart/cppcodec 
Add cppcodec in opensource users
 2018-11-26 21:11:51 +01:00
Martin Hořeňovský 6ccd467094
v2.5.0 2018-11-26 20:50:38 +01:00
Martin Hořeňovský 16656c4c9e
Update the release process documentation 2018-11-26 20:41:14 +01:00
Nicolas Dusart 862955d657
add cppcodec in opensource users 2018-11-26 11:49:14 +01:00
Martin Hořeňovský df019cc113
Turn "deprecations" into "deprecations and planned changes" 
This captures the intent better, as some changes are indeed plain
deprecations leading to removal, but other changes can be viewed
as minor tune-ups instead.
 2018-11-24 18:04:56 +01:00
Martin Hořeňovský 59087f74d9
Fix CAPTURE macro for nontrivial uses 
The previous implemetation was just plain broken for most of
possible uses, the new one should work (even though it is ugly
as all hell, and should be improved ASAP).

Fixes #1436
 2018-11-21 16:48:09 +01:00
Martin Hořeňovský 77f29c2f1c
Add more deprecations 2018-11-17 21:13:56 +01:00
Martin Hořeňovský a9d5b7193d
Add note about release signing to release docs 2018-11-17 14:41:34 +01:00
Martin Hořeňovský 396e0951c8
Add ToC to "Test cases and sections" documentation 2018-11-17 11:09:15 +01:00
Martin Hořeňovský 68860ff129
Add deprecations documentation 2018-11-17 11:08:38 +01:00
Martin Hořeňovský 99b37a4c62
Merge pull request #1445 from thecppzoo/master 
operator<< works from the global namespace
 2018-11-17 10:36:37 +01:00
Martin Hořeňovský 1dccd26de7
Fix link in documentation 2018-11-17 10:21:46 +01:00
thecppzoo 3f3238edf0
operator<< works from the global namespace 
Since https://github.com/catchorg/Catch2/pull/1405 was merged and propagated to the single include declaring a user operator<< in the global namespace makes it available to Catch2 string converters.
 2018-11-16 16:45:13 -08:00
Martin Hořeňovský 00d4f5d3c6
Add documentation for templated tests 2018-11-16 21:21:30 +01:00
Antonio Borondo 87950d9cfa Fix Cute test framework URL 2018-11-05 19:38:37 +01:00
Martin Hořeňovský 03d122a35c v2.4.2 2018-10-26 21:14:16 +02:00
Martin Hořeňovský 1d9b506e39 Add documentation for some miscellaneous and less important macros 
Fixes #1367
 2018-10-26 20:50:32 +02:00
Stephane Del Pino 544c7d7cbf Add the optional variable OptionalCatchTestLauncher 
This variable is set to allow the use of the nice ParseAndAddCatchTests script
in the case where a launcher is needed to execute  the script.

This is introduced to allow to launch unit tests using mpi. In this case one can
write for instance
  set(OptionalCatchTestLauncher ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} ${NUMPROC})
before calling the ParseAndAddCatchTests function.
 2018-10-25 15:51:15 +02:00
Martin Hořeňovský 9e1bdca466 v2.4.1 2018-09-28 15:52:51 +02:00
Martin Moene 558bbe7d24 Add example for TeamCity reporter and refer to it 
Prevent warnings
- gnu: -Wcomment: multi-line comment
- clang: -Wweak-vtables 'class' has no out-of-line virtual method definitions; its vtable will be emitted in every translation unit
- clang: -Winconsistent-missing-override: 'method' overrides a member function but is not marked 'override'
- MSVC: C4702: unreachable code
 2018-09-27 23:20:02 +02:00
Martin Hořeňovský 4dd6e81d0f Update "Known limitations" section of documentation 
This fixes some wording that implies C++98 standard, updates
the recommended solution to looped SECTION macros and mentioned
the "last section failed, test needs to be rerun" problem.

Related to #1367
Related to #1384
Related to #1389
 2018-09-21 21:03:14 +02:00
Martin Hořeňovský 9e6d7bbf00 Add documentation for installing Catch from the repository 
This might prove helpful when the package managers either doesn't
have Catch at all, or provides it in obsolete version (Ubuntu 16.04,
I am looking at you).

Closes #1383
 2018-09-21 20:48:18 +02:00
Martin Hořeňovský dfb025cf08 Change wording of Approx documentation to be less misleading 
The "percentage" suggests that the expected epsilon can be in
[0, 100], but the expected values are in [0, 1]. The new wording
uses "coefficient", to make it clearer that we are talking about
values in [0, 1].

Closes #1388
 2018-09-21 20:04:56 +02:00
melak47 c638c57209 Add StringMaker for std::variant, std::monostate (#1380) 
The StringMaker is off by default and can be enabled by a new macro `CATCH_CONFIG_ENABLE_VARIANT_STRINGMAKER`, to avoid increasing the footprint of stringification machinery by default.
 2018-09-20 14:13:35 +02:00
melak47 a575536abe Add StringMaker for std::(w)string_view 
Fixes #1375
 2018-09-10 11:37:26 +02:00
Martin Hořeňovský 46e99e258f Fixup TOC script sluggification and documentation 2018-09-09 17:09:57 +02:00
Martin Moene a81c01d4f9 Updated documentation TOCs 2018-09-08 11:05:52 +02:00
Martin Hořeňovský 60b05b2041 v2.4.0 2018-09-04 11:59:15 +02:00
Martin Hořeňovský 232ea3c456 Add documentation for no-exception support 
Closes #703
Closes #1358
 2018-09-04 10:06:31 +02:00
Axel Huebl 7667a7d89c Docs: TABs to Spaces 
Replace TABs with four (4) spaces in code docs.
 2018-08-29 18:05:22 +02:00
George Fotopoulos 2067c8d3bd Update opensource-users.md 
Add "thor"
Update "forest" description
 2018-08-29 14:51:17 +02:00
Martin Hořeňovský 94121a5f6d Add a basic documentation for generators 2018-08-24 13:34:27 +02:00
Martin Hořeňovský 15cf3caace v2.3.0 2018-07-23 10:12:15 +02:00
Martin Hořeňovský 797d3b04df Reinstate CATCH_BUILD_TESTING CMake option 2018-07-22 18:01:42 +02:00
Martin Hořeňovský ce80358306 Document Approx's UDL support 2018-07-15 17:38:57 +02:00
Axel Huebl 5347ff9e5f
Refactor: override implies virtual 
If not used with `final`, override implies `virtual`.
Detected via CodeFactor score.

Another reference on SO:
  https://stackoverflow.com/questions/43466863/isnt-virtual-keyword-redundant-when-override-or-final-specifiers-are-used
 2018-07-12 14:27:06 +02:00
Unknown e21c6aa94d Fix the second Multiple-file example file link 
Previously it pointed to the first file as well.
 2018-07-09 15:47:03 +02:00
Martin Hořeňovský 7a59d5027f Link the example from `CATCH_CONFIG_NOSTDOUT` documentation 2018-07-08 13:58:44 +02:00
Martin Hořeňovský c8941cccb5 Add an example on providing streams with `CATCH_CONFIG_NOSTDOUT` 
Related to #1037
Closes #1290
 2018-07-08 13:38:42 +02:00
Martin Hořeňovský 5eeb6aa361 Update Approx documentation 
Fixes #1328
 2018-07-05 17:28:00 +02:00
Stephen McDowell ad120965cf fix link to single header version catch.hpp 2018-07-01 12:37:13 +02:00
Martin Hořeňovský f460a7d8f9 Fix documentation of CATCH_CONFIG_FAST_COMPILE 
Related to issue #1279
 2018-06-30 12:31:46 +02:00
Martin Hořeňovský ebf89000f1 Update thread safety documentation 
Closes #1302
 2018-06-28 22:35:42 +02:00
Martin Hořeňovský e69afb6252 Remove removed macros from documentation 2018-06-28 09:43:10 +02:00
Martin Hořeňovský bf221583b1 Update CMake and build documentation 2018-06-24 12:32:22 +02:00
Martin Hořeňovský c5301bf8bf Updated release process documentation to reflect vcpkg autoupdate 2018-06-11 22:44:14 +02:00
Martin Hořeňovský d2a130f243 v2.2.3 2018-06-06 23:19:06 +02:00
Cristian Morales Vega 7abd7db2c8 Fix minor typo in the documentation 2018-06-01 22:24:49 +02:00
Martin Hořeňovský df0b0e64e1 Make FALLBACK_STRINGIFIER documentation more explicit 
Related to #1024
 2018-05-14 21:03:07 +02:00
Martin Hořeňovský db570b7e24 Split list of examples into "done" and "planned". 
Closes #1282
 2018-05-09 22:49:04 +02:00
Martin Hořeňovský 0074926e5c Provide a polyfill over `std::to_string` 
Android apparently does not support `std::to_string`, so we add a
small polyfill over it. Right now only the ULP matcher uses it,
but we have had plans to use it in `StringMaker<int>` and friends,
as it performs a lot better than `std::stringstream` based
stringification on MSVC.

See #1280 for more details
 2018-05-09 21:47:42 +02:00
Palotás Boldizsár dd99a66cf4 Add documentation for `--use-colour` 
The documentation added is based on output from `-?` (help),
and comments to #590.
 2018-05-06 11:37:00 +02:00
Christian Berger 7f791fa08f Suggestion for adding libcluon that is also using Catch2 for testing 2018-04-30 16:02:41 +02:00
Martin Hořeňovský e92b9c07c3 Add an experimental new way of capturing stdout/stderr 
Unlike the relatively non-invasive old way of capturing stdout/stderr,
this new way is also able to capture output from C's stdlib functions
such as `printf`. This is done by redirecting stdout and stderr file
descriptors to a file, and then reading this file back.

This approach has two sizeable drawbacks:
1) Performance, obviously. Previously an installed capture made the
program run faster (as long as it was then discarded), because a call
to `std::cout` did not result in text output to the console. This new
capture method in fact forces disk IO. While it is likely that any
modern OS will keep this file in memory-cache and might never actually
issue the IO to the backing storage, it is still a possibility and
calls to the file system are not free.

2) Nonportability. While POSIX is usually assumed portable, and this
implementation relies only on a very common parts of it, it is no
longer standard C++ (or just plain C) and thus might not be available
on some obscure platforms. Different C libs might also implement the
relevant functions in a less-than-useful ways (e.g. MS's `tmpfile`
generates a temp file inside system folder, so it will not work
without elevated privileges and thus is useless).

These two drawbacks mean that, at least for now, the new capture is
opt-in. To opt-in, `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` needs to be
defined in the implementation file.

Closes #1243
 2018-04-29 22:25:49 +02:00
Barry 200d3ad824 Support for parenthesizing types with commas. 2018-04-20 15:11:09 +02:00
Martin Hořeňovský d2d8455b57 v2.2.2 2018-04-06 12:11:22 +02:00
Martin Hořeňovský 1ca8f43b01 Add PredicateMatcher that takes an arbitrary predicate functions 
Also adds `Predicate` helper function to create `PredicateMatcher`.
Because of limitations in type inference it needs to be explicitly
typed, like so
`Predicate<std::string>([](std::string const& str) { ... })`.
It also takes an optional second argument for description of the
predicate.

It is possible to infer the argument with sufficient TMP, see
https://stackoverflow.com/questions/43560492/how-to-extract-lambdas-return-type-and-variadic-parameters-pack-back-from-gener/43561563#43561563
but I don't think that the magic is worth introducing ATM.

Closes #1236
 2018-04-04 11:14:19 +02:00
Martin Hořeňovský 0a34cc201e v2.2.1 2018-03-11 12:04:28 +01:00
Martin Hořeňovský d14b7563c2 v2.2.0 2018-03-07 11:06:15 +01:00