blob: e40be99c09c81b5395b2fb8e8d952773ede91e45 [file] [log] [blame] [view]
Martin Moenee8225052017-08-24 15:21:36 +02001<a id="top"></a>
Martin Hořeňovskýcd76f572018-01-10 13:53:04 +01002
Martin Hořeňovský15cf3ca2018-07-23 10:12:15 +02003# 2.3.0
4
5**This release changes the include paths provided by our CMake and
6pkg-config integration. The proper include path for the single-header
7when using one of the above is now `<catch2/catch.hpp>`. This change
8also necessitated changes to paths inside the repository, so that the
9single-header version is now at `single_include/catch2/catch.hpp`, rather
10than `single_include/catch.hpp`.**
11
12
13
14## Fixes
15* Fixed Objective-C++ build
16* `-Wunused-variable` suppression no longer leaks from Catch's header under Clang
17* Implementation of the experimental new output capture can now be disabled (#1335)
18 * This allows building Catch2 on platforms that do not provide things like `dup` or `tmpfile`.
19* The JUnit and XML reporters will no longer skip over successful tests when running without `-s` (#1264, #1267, #1310)
20 * See improvements for more details
21
22## Improvements
23* pkg-config and CMake integration has been rewritten
24 * If you use them, the new include path is `#include <catch2/catch.hpp>`
25 * CMake installation now also installs scripts from `contrib/`
26 * For details see the [new documentation](cmake-integration.md#top)
27* Reporters now have a new customization point, `ReporterPreferences::shouldReportAllAssertions`
28 * When this is set to `false` and the tests are run without `-s`, passing assertions are not sent to the reporter.
29 * Defaults to `false`.
30* Added `DYNAMIC_SECTION`, a section variant that constructs its name using stream
31 * This means that you can do `DYNAMIC_SECTION("For X := " << x)`.
32
33
Martin Hořeňovskýd2a130f2018-06-06 23:16:06 +020034# 2.2.3
35
36**To fix some of the bugs, some behavior had to change in potentially breaking manner.**
37**This means that even though this is a patch release, it might not be a drop-in replacement.**
38
39## Fixes
40* Listeners are now called before reporter
41 * This was always documented to be the case, now it actually works that way
42* Catch's commandline will no longer accept multiple reporters
43 * This was done because multiple reporters never worked properly and broke things in non-obvious ways
44 * **This has potential to be a breaking change**
45* MinGW is now detected as Windows platform w/o SEH support (#1257)
46 * This means that Catch2 no longer tries to use POSIX signal handling when compiled with MinGW
47* Fixed potential UB in parsing tags using non-ASCII characters (#1266)
48 * Note that Catch2 still supports only ASCII test names/tags/etc
49* `TEST_CASE_METHOD` can now be used on classnames containing commas (#1245)
50 * You have to enclose the classname in extra set of parentheses
51* Fixed insufficient alt stack size for POSIX signal handling (#1225)
52* Fixed compilation error on Android due to missing `std::to_string` in C++11 mode (#1280)
53* Fixed the order of user-provided `FALLBACK_STRINGIFIER` in stringification machinery (#1024)
54 * It was intended to be replacement for built-in fallbacks, but it was used _after_ them.
55 * **This has potential to be a breaking change**
56* Fixed compilation error when a type has an `operator<<` with templated lhs (#1285, #1306)
57
58## Improvements
59* Added a new, experimental, output capture (#1243)
60 * This capture can also redirect output written via C apis, e.g. `printf`
61 * To opt-in, define `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` in the implementation file
62* Added a new fallback stringifier for classes derived from `std::exception`
63 * Both `StringMaker` specialization and `operator<<` overload are given priority
64
65## Miscellaneous
66* `contrib/` now contains dbg scripts that skip over Catch's internals (#904, #1283)
67 * `gdbinit` for gdb `lldbinit` for lldb
68* `CatchAddTests.cmake` no longer strips whitespace from tests (#1265, #1281)
69* Online documentation now describes `--use-colour` option (#1263)
70
71
Martin Hořeňovskýd2d84552018-04-06 12:11:22 +020072# 2.2.2
73
74## Fixes
75* Fixed bug in `WithinAbs::match()` failing spuriously (#1228)
76* Fixed clang-tidy diagnostic about virtual call in destructor (#1226)
77* Reduced the number of GCC warnings suppression leaking out of the header (#1090, #1091)
78 * Only `-Wparentheses` should be leaking now
79* Added upper bound on the time benchmark timer calibration is allowed to take (#1237)
80 * On platforms where `std::chrono::high_resolution_clock`'s resolution is low, the calibration would appear stuck
81* Fixed compilation error when stringifying static arrays of `unsigned char`s (#1238)
82
83## Improvements
84* XML encoder now hex-encodes invalid UTF-8 sequences (#1207)
85 * This affects xml and junit reporters
86 * Some invalid UTF-8 parts are left as is, e.g. surrogate pairs. This is because certain extensions of UTF-8 allow them, such as WTF-8.
87* CLR objects (`T^`) can now be stringified (#1216)
88 * This affects code compiled as C++/CLI
89* Added `PredicateMatcher`, a matcher that takes an arbitrary predicate function (#1236)
90 * See [documentation for details](https://github.com/catchorg/Catch2/blob/master/docs/matchers.md)
91
92## Others
93* Modified CMake-installed pkg-config to allow `#include <catch.hpp>`(#1239)
94 * The plans to standardize on `#include <catch2/catch.hpp>` are still in effect
95
96
Martin Hořeňovský0a34cc22018-03-11 12:04:28 +010097# 2.2.1
98
99## Fixes
100* Fixed compilation error when compiling Catch2 with `std=c++17` against libc++ (#1214)
101 * Clara (Catch2's CLI parsing library) used `std::optional` without including it explicitly
102* Fixed Catch2 return code always being 0 (#1215)
103 * In the words of STL, "We feel superbad about letting this in"
104
105
Martin Hořeňovskýd14b7562018-03-07 11:01:06 +0100106# 2.2.0
107
108## Fixes
109* Hidden tests are not listed by default when listing tests (#1175)
110 * This makes `catch_discover_tests` CMake script work better
111* Fixed regression that meant `<windows.h>` could potentially not be included properly (#1197)
112* Fixed installing `Catch2ConfigVersion.cmake` when Catch2 is a subproject.
113
114## Improvements
115* Added an option to warn (+ exit with error) when no tests were ran (#1158)
116 * Use as `-w NoTests`
117* Added provisional support for Emscripten (#1114)
118* [Added a way to override the fallback stringifier](https://github.com/catchorg/Catch2/blob/master/docs/configuration.md#fallback-stringifier) (#1024)
119 * This allows project's own stringification machinery to be easily reused for Catch
120* `Catch::Session::run()` now accepts `char const * const *`, allowing it to accept array of string literals (#1031, #1178)
121 * The embedded version of Clara was bumped to v1.1.3
122* Various minor performance improvements
123* Added support for DJGPP DOS crosscompiler (#1206)
124
125
Martin Hořeňovský7cbd0b52018-02-09 17:10:27 +0100126# 2.1.2
127
128## Fixes
129* Fixed compilation error with `-fno-rtti` (#1165)
130* Fixed NoAssertion warnings
131* `operator<<` is used before range-based stringification (#1172)
132* Fixed `-Wpedantic` warnings (extra semicolons and binary literals) (#1173)
133
134
135## Improvements
136* Added `CATCH_VERSION_{MAJOR,MINOR,PATCH}` macros (#1131)
137* Added `BrightYellow` colour for use in reporters (#979)
138 * It is also used by ConsoleReporter for reconstructed expressions
139
140## Other changes
141* Catch is now exported as a CMake package and linkable target (#1170)
142
Martin Hořeňovský62dae592018-01-26 16:06:07 +0100143# 2.1.1
144
145## Improvements
146* Static arrays are now properly stringified like ranges across MSVC/GCC/Clang
147* Embedded newer version of Clara -- v1.1.1
148 * This should fix some warnings dragged in from Clara
149* MSVC's CLR exceptions are supported
150
151
152## Fixes
153* Fixed compilation when comparison operators do not return bool (#1147)
154* Fixed CLR exceptions blowing up the executable during translation (#1138)
155
156
157## Other changes
158* Many CMake changes
159 * `NO_SELFTEST` option is deprecated, use `BUILD_TESTING` instead.
160 * Catch specific CMake options were prefixed with `CATCH_` for namespacing purposes
161 * Other changes to simplify Catch2's packaging
162
163
164
Martin Hořeňovskýcd76f572018-01-10 13:53:04 +0100165# 2.1.0
166
167## Improvements
168* Various performance improvements
169 * On top of the performance regression fixes
170* Experimental support for PCH was added (#1061)
171* `CATCH_CONFIG_EXTERNAL_INTERFACES` now brings in declarations of Console, Compact, XML and JUnit reporters
172* `MatcherBase` no longer has a pointless second template argument
173* Reduced the number of warning suppressions that leak into user's code
174 * Bugs in g++ 4.x and 5.x mean that some of them have to be left in
175
176
177## Fixes
178* Fixed performance regression from Catch classic
179 * One of the performance improvement patches for Catch classic was not applied to Catch2
180* Fixed platform detection for iOS (#1084)
181* Fixed compilation when `g++` is used together with `libc++` (#1110)
182* Fixed TeamCity reporter compilation with the single header version
183 * To fix the underlying issue we will be versioning reporters in single_include folder per release
184* The XML reporter will now report `WARN` messages even when not used with `-s`
185* Fixed compilation when `VectorContains` matcher was combined using `&&` (#1092)
186* Fixed test duration overflowing after 10 seconds (#1125, #1129)
187* Fixed `std::uncaught_exception` deprecation warning (#1124)
188
189
190## New features
191* New Matchers
192 * Regex matcher for strings, `Matches`.
193 * Set-equal matcher for vectors, `UnorderedEquals`
194 * Floating point matchers, `WithinAbs` and `WithinULP`.
195* Stringification now attempts to decompose all containers (#606)
196 * Containers are objects that respond to ADL `begin(T)` and `end(T)`.
197
198
199## Other changes
200* Reporters will now be versioned in the `single_include` folder to ensure their compatibility with the last released version
201
202
203
204
Phil Nashb119ebd2017-11-03 12:01:52 +0000205# 2.0.1
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200206
207## Breaking changes
208* Removed C++98 support
209* Removed legacy reporter support
210* Removed legacy generator support
211 * Generator support will come back later, reworked
212* Removed `Catch::toString` support
213 * The new stringification machinery uses `Catch::StringMaker` specializations first and `operator<<` overloads second.
214* Removed legacy `SCOPED_MSG` and `SCOPED_INFO` macros
Martin Hořeňovský053c29a2017-08-27 17:03:32 +0200215* Removed `INTERNAL_CATCH_REGISTER_REPORTER`
216 * `CATCH_REGISTER_REPORTER` should be used to register reporters
217* Removed legacy `[hide]` tag
218 * `[.]`, `[.foo]` and `[!hide]` are still supported
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200219* Output into debugger is now colourized
220* `*_THROWS_AS(expr, exception_type)` now unconditionally appends `const&` to the exception type.
221* `CATCH_CONFIG_FAST_COMPILE` now affects the `CHECK_` family of assertions as well as `REQUIRE_` family of assertions
222 * This is most noticeable in `CHECK(throws())`, which would previously report failure, properly stringify the exception and continue. Now it will report failure and stop executing current section.
Martin Hořeňovskýa4df0b22017-08-30 19:16:25 +0200223* Removed deprecated matcher utility functions `Not`, `AllOf` and `AnyOf`.
224 * They are superseded by operators `!`, `&&` and `||`, which are natural and do not have limited arity
Martin Hořeňovský80bbce82017-09-26 13:36:57 +0200225* Removed support for non-const comparison operators
226 * Non-const comparison operators are an abomination that should not exist
227 * They were breaking support for comparing function to function pointer
Martin Hořeňovský79b405f2017-10-09 12:31:22 +0200228* `std::pair` and `std::tuple` are no longer stringified by default
229 * This is done to avoid dragging in `<tuple>` and `<utility>` headers in common path
230 * Their stringification can be enabled per-file via new configuration macros
Martin Hořeňovský31cc62e2017-11-01 22:25:17 +0100231* `Approx` is subtly different and hopefully behaves more as users would expect
232 * `Approx::scale` defaults to `0.0`
233 * `Approx::epsilon` no longer applies to the larger of the two compared values, but only to the `Approx`'s value
234 * `INFINITY == Approx(INFINITY)` returns true
235
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200236
237## Improvements
238* Reporters and Listeners can be defined in files different from the main file
239 * The file has to define `CATCH_CONFIG_EXTERNAL_INTERFACES` before including catch.hpp.
240* Errors that happen during set up before main are now caught and properly reported once main is entered
241 * If you are providing your own main, you can access and use these as well.
Phil Nash24e6d5f2017-11-09 11:09:17 +0100242* New assertion macros, *_THROWS_MATCHES(expr, exception_type, matcher) are provided
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200243 * As the arguments suggest, these allow you to assert that an expression throws desired type of exception and pass the exception to a matcher.
244* JUnit reporter no longer has significantly different output for test cases with and without sections
245* Most assertions now support expressions containing commas (ie `REQUIRE(foo() == std::vector<int>{1, 2, 3});`)
246* Catch now contains experimental micro benchmarking support
247 * See `projects/SelfTest/Benchmark.tests.cpp` for examples
248 * The support being experiment means that it can be changed without prior notice
249* Catch uses new CLI parsing library (Clara)
250 * Users can now easily add new command line options to the final executable
251 * This also leads to some changes in `Catch::Session` interface
Martin Hořeňovský053c29a2017-08-27 17:03:32 +0200252* All parts of matchers can be removed from a TU by defining `CATCH_CONFIG_DISABLE_MATCHERS`
253 * This can be used to somewhat speed up compilation times
254* An experimental implementation of `CATCH_CONFIG_DISABLE` has been added
Martin Hořeňovský13213fa2017-08-30 12:43:23 +0200255 * Inspired by Doctest's `DOCTEST_CONFIG_DISABLE`
Martin Hořeňovský053c29a2017-08-27 17:03:32 +0200256 * Useful for implementing tests in source files
257 * ie for functions in anonymous namespaces
Martin Hořeňovský13213fa2017-08-30 12:43:23 +0200258 * Removes all assertions
259 * Prevents `TEST_CASE` registrations
260 * Exception translators are not registered
261 * Reporters are not registered
262 * Listeners are not registered
Martin Hořeňovský80bbce82017-09-26 13:36:57 +0200263* Reporters/Listeners are now notified of fatal errors
264 * This means specific signals or structured exceptions
265 * The Reporter/Listener interface provides default, empty, implementation to preserve backward compatibility
Martin Hořeňovský79b405f2017-10-09 12:31:22 +0200266* Stringification of `std::chrono::duration` and `std::chrono::time_point` is now supported
267 * Needs to be enabled by a per-file compile time configuration option
Martin Hořeňovskýae210202017-10-31 15:17:21 +0100268* Add `pkg-config` support to CMake install command
269
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200270
271## Fixes
Martin Hořeňovský80bbce82017-09-26 13:36:57 +0200272* Don't use console colour if running in XCode
Phil Nashe9f07732017-09-19 17:36:20 +0100273* Explicit constructor in reporter base class
Martin Hořeňovský80bbce82017-09-26 13:36:57 +0200274* Swept out `-Wweak-vtables`, `-Wexit-time-destructors`, `-Wglobal-constructors` warnings
275* Compilation for Universal Windows Platform (UWP) is supported
276 * SEH handling and colorized output are disabled when compiling for UWP
Martin Hořeňovskýb80c5132017-10-01 17:03:06 +0200277* Implemented a workaround for `std::uncaught_exception` issues in libcxxrt
278 * These issues caused incorrect section traversals
279 * The workaround is only partial, user's test can still trigger the issue by using `throw;` to rethrow an exception
Martin Hořeňovskýae210202017-10-31 15:17:21 +0100280* Suppressed C4061 warning under MSVC
281
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200282
283## Internal changes
284* The development version now uses .cpp files instead of header files containing implementation.
285 * This makes partial rebuilds much faster during development
286* The expression decomposition layer has been rewritten
287* The evaluation layer has been rewritten
288* New library (TextFlow) is used for formatting text to output
289
290
Martin Moene66124d92017-08-28 22:20:33 +0200291# Older versions
292
Martin Hořeňovský24851df2017-12-03 14:19:02 +0100293## 1.11.x
294
295### 1.11.0
296
297#### Fixes
298* The original expression in `REQUIRE_FALSE( expr )` is now reporter properly as `!( expr )` (#1051)
299 * Previously the parentheses were missing and `x != y` would be expanded as `!x != x`
300* `Approx::Margin` is now inclusive (#952)
301 * Previously it was meant and documented as inclusive, but the check itself wasn't
302 * This means that `REQUIRE( 0.25f == Approx( 0.0f ).margin( 0.25f ) )` passes, instead of fails
303* `RandomNumberGenerator::result_type` is now unsigned (#1050)
304
305#### Improvements
306* `__JETBRAINS_IDE__` macro handling is now CLion version specific (#1017)
307 * When CLion 2017.3 or newer is detected, `__COUNTER__` is used instead of
308* TeamCity reporter now explicitly flushes output stream after each report (#1057)
309 * On some platforms, output from redirected streams would show up only after the tests finished running
310* `ParseAndAddCatchTests` now can add test files as dependency to CMake configuration
311 * This means you do not have to manually rerun CMake configuration step to detect new tests
312
313## 1.10.x
314
315### 1.10.0
316
317#### Fixes
318* Evaluation layer has been rewritten (backported from Catch 2)
319 * The new layer is much simpler and fixes some issues (#981)
320* Implemented workaround for VS 2017 raw string literal stringification bug (#995)
321* Fixed interaction between `[!shouldfail]` and `[!mayfail]` tags and sections
322 * Previously sections with failing assertions would be marked as failed, not failed-but-ok
323
324#### Improvements
325* Added [libidentify](https://github.com/janwilmans/LibIdentify) support
326* Added "wait-for-keypress" option
327
Martin Moene66124d92017-08-28 22:20:33 +0200328## 1.9.x
329
330### 1.9.6
331
332#### Improvements
Martin Hořeňovskýee67ac62017-06-27 12:21:48 +0200333* Catch's runtime overhead has been significantly decreased (#937, #939)
334* Added `--list-extra-info` cli option (#934).
335 * It lists all tests together with extra information, ie filename, line number and description.
336
337
338
Martin Moene66124d92017-08-28 22:20:33 +0200339### 1.9.5
Martin Hořeňovský017a63d2017-06-15 13:08:26 +0200340
Martin Moene66124d92017-08-28 22:20:33 +0200341#### Fixes
Martin Hořeňovský017a63d2017-06-15 13:08:26 +0200342* Truthy expressions are now reconstructed properly, not as booleans (#914)
343* Various warnings are no longer erroneously suppressed in test files (files that include `catch.hpp`, but do not define `CATCH_CONFIG_MAIN` or `CATCH_CONFIG_RUNNER`) (#871)
344* Catch no longer fails to link when main is compiled as C++, but linked against Objective-C (#855)
345* Fixed incorrect gcc version detection when deciding to use `__COUNTER__` (#928)
346 * Previously any GCC with minor version less than 3 would be incorrectly classified as not supporting `__COUNTER__`.
347* Suppressed C4996 warning caused by upcoming updated to MSVC 2017, marking `std::uncaught_exception` as deprecated. (#927)
348
Martin Moene66124d92017-08-28 22:20:33 +0200349#### Improvements
Martin Hořeňovský017a63d2017-06-15 13:08:26 +0200350* CMake integration script now incorporates debug messages and registers tests in an improved way (#911)
351* Various documentation improvements
352
353
354
Martin Moene66124d92017-08-28 22:20:33 +0200355### 1.9.4
Martin Hořeňovský3dcc9232017-05-16 13:59:29 +0200356
Martin Moene66124d92017-08-28 22:20:33 +0200357#### Fixes
Martin Hořeňovský3dcc9232017-05-16 13:59:29 +0200358* `CATCH_FAIL` macro no longer causes compilation error without variadic macro support
359* `INFO` messages are no longer cleared after being reported once
360
Martin Moene66124d92017-08-28 22:20:33 +0200361#### Improvements and minor changes
Martin Hořeňovský3dcc9232017-05-16 13:59:29 +0200362* Catch now uses `wmain` when compiled under Windows and `UNICODE` is defined.
363 * Note that Catch still officially supports only ASCII
364
Martin Moene66124d92017-08-28 22:20:33 +0200365### 1.9.3
Phil Nasha0ada2e2017-04-25 14:23:06 +0000366
Martin Moene66124d92017-08-28 22:20:33 +0200367#### Fixes
Phil Nasha0ada2e2017-04-25 14:23:06 +0000368* Completed the fix for (lack of) uint64_t in earlier Visual Studios
369
Martin Moene66124d92017-08-28 22:20:33 +0200370### 1.9.2
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200371
Martin Moene66124d92017-08-28 22:20:33 +0200372#### Improvements and minor changes
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200373* All of `Approx`'s member functions now accept strong typedefs in C++11 mode (#888)
374 * Previously `Approx::scale`, `Approx::epsilon`, `Approx::margin` and `Approx::operator()` didn't.
375
376
Martin Moene66124d92017-08-28 22:20:33 +0200377#### Fixes
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200378* POSIX signals are now disabled by default under QNX (#889)
379 * QNX does not support current enough (2001) POSIX specification
380* JUnit no longer counts exceptions as failures if given test case is marked as ok to fail.
381* `Catch::Option` should now have its storage properly aligned.
382* Catch no longer attempts to define `uint64_t` on windows (#862)
383 * This was causing trouble when compiled under Cygwin
384
Martin Moene66124d92017-08-28 22:20:33 +0200385#### Other
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200386* Catch is now compiled under MSVC 2017 using `std:c++latest` (C++17 mode) in CI
387* We now provide cmake script that autoregisters Catch tests into ctest.
388 * See `contrib` folder.
389
390
Martin Moene66124d92017-08-28 22:20:33 +0200391### 1.9.1
Martin Hořeňovskýc6990cd2017-04-09 21:25:20 +0200392
Martin Moene66124d92017-08-28 22:20:33 +0200393#### Fixes
Martin Hořeňovskýc6990cd2017-04-09 21:25:20 +0200394* Unexpected exceptions are no longer ignored by default (#885, #887)
395
396
Martin Moene66124d92017-08-28 22:20:33 +0200397### 1.9.0
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200398
399
Martin Moene66124d92017-08-28 22:20:33 +0200400#### Improvements and minor changes
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200401* Catch no longer attempts to ensure the exception type passed by user in `REQUIRE_THROWS_AS` is a constant reference.
402 * It was causing trouble when `REQUIRE_THROWS_AS` was used inside templated functions
403 * This actually reverts changes made in v1.7.2
404* Catch's `Version` struct should no longer be double freed when multiple instances of Catch tests are loaded into single program (#858)
405 * It is now a static variable in an inline function instead of being an `extern`ed struct.
406* Attempt to register invalid tag or tag alias now throws instead of calling `exit()`.
407 * Because this happen before entering main, it still aborts execution
408 * Further improvements to this are coming
409* `CATCH_CONFIG_FAST_COMPILE` now speeds-up compilation of `REQUIRE*` assertions by further ~15%.
410 * The trade-off is disabling translation of unexpected exceptions into text.
411* When Catch is compiled using C++11, `Approx` is now constructible with anything that can be explicitly converted to `double`.
412* Captured messages are now printed on unexpected exceptions
413
Martin Moene66124d92017-08-28 22:20:33 +0200414#### Fixes:
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200415* Clang's `-Wexit-time-destructors` should be suppressed for Catch's internals
416* GCC's `-Wparentheses` is now suppressed for all TU's that include `catch.hpp`.
417 * This is functionally a revert of changes made in 1.8.0, where we tried using `_Pragma` based suppression. This should have kept the suppression local to Catch's assertions, but bugs in GCC's handling of `_Pragma`s in C++ mode meant that it did not always work.
418* You can now tell Catch to use C++11-based check when checking whether a type can be streamed to output.
419 * This fixes cases when an unstreamable type has streamable private base (#877)
420 * [Details can be found in documentation](configuration.md#catch_config_cpp11_stream_insertable_check)
421
422
Martin Moene66124d92017-08-28 22:20:33 +0200423#### Other notes:
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200424* We have added VS 2017 to our CI
425* Work on Catch 2 should start soon
426
427
428
Martin Moene66124d92017-08-28 22:20:33 +0200429## 1.8.x
430
431### 1.8.2
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100432
433
Martin Moene66124d92017-08-28 22:20:33 +0200434#### Improvements and minor changes
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100435* TAP reporter now behaves as if `-s` was always set
436 * This should be more consistent with the protocol desired behaviour.
437* Compact reporter now obeys `-d yes` argument (#780)
438 * The format is "XXX.123 s: <section-name>" (3 decimal places are always present).
439 * Before it did not report the durations at all.
440* XML reporter now behaves the same way as Console reporter in regards to `INFO`
441 * This means it reports `INFO` messages on success, if output on success (`-s`) is enabled.
442 * Previously it only reported `INFO` messages on failure.
443* `CAPTURE(expr)` now stringifies `expr` in the same way assertion macros do (#639)
Martin Moene6c09b452017-08-24 15:33:38 +0200444* Listeners are now finally [documented](event-listeners.md#top).
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100445 * Listeners provide a way to hook into events generated by running your tests, including start and end of run, every test case, every section and every assertion.
446
447
Martin Moene66124d92017-08-28 22:20:33 +0200448#### Fixes:
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100449* Catch no longer attempts to reconstruct expression that led to a fatal error (#810)
450 * This fixes possible signal/SEH loop when processing expressions, where the signal was triggered by expression decomposition.
451* Fixed (C4265) missing virtual destructor warning in Matchers (#844)
452* `std::string`s are now taken by `const&` everywhere (#842).
453 * Previously some places were taking them by-value.
454* Catch should no longer change errno (#835).
455 * This was caused by libstdc++ bug that we now work around.
456* Catch now provides `FAIL_CHECK( ... )` macro (#765).
457 * Same as `FAIL( ... )`, but does not abort the test.
458* Functions like `fabs`, `tolower`, `memset`, `isalnum` are now used with `std::` qualification (#543).
459* Clara no longer assumes first argument (binary name) is always present (#729)
460 * If it is missing, empty string is used as default.
461* Clara no longer reads 1 character past argument string (#830)
Phil Nash06923172017-03-15 09:04:09 +0000462* Regression in Objective-C bindings (Matchers) fixed (#854)
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100463
464
Martin Moene66124d92017-08-28 22:20:33 +0200465#### Other notes:
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100466* We have added VS 2013 and 2015 to our CI
467* Catch Classic (1.x.x) now contains its own, forked, version of Clara (the argument parser).
468
469
470
Martin Moene66124d92017-08-28 22:20:33 +0200471### 1.8.1
Phil Nash658b5f62017-03-01 16:06:48 +0000472
Martin Moene66124d92017-08-28 22:20:33 +0200473#### Fixes
Phil Nash658b5f62017-03-01 16:06:48 +0000474
475Cygwin issue with `gettimeofday` - `#define` was not early enough
476
Martin Moene66124d92017-08-28 22:20:33 +0200477### 1.8.0
Phil Nash0952b762017-02-28 14:19:09 +0000478
Martin Moene66124d92017-08-28 22:20:33 +0200479#### New features/ minor changes
Phil Nash0952b762017-02-28 14:19:09 +0000480
481* Matchers have new, simpler (and documented) interface.
482 * Catch provides string and vector matchers.
Martin Moene6c09b452017-08-24 15:33:38 +0200483 * For details see [Matchers documentation](matchers.md#top).
Phil Nash0952b762017-02-28 14:19:09 +0000484* Changed console reporter test duration reporting format (#322)
485 * Old format: `Some simple comparisons between doubles completed in 0.000123s`
486 * New format: `xxx.123s: Some simple comparisons between doubles` _(There will always be exactly 3 decimal places)_
487* Added opt-in leak detection under MSVC + Windows (#439)
488 * Enable it by compiling Catch's main with `CATCH_CONFIG_WINDOWS_CRTDBG`
489* Introduced new compile-time flag, `CATCH_CONFIG_FAST_COMPILE`, trading features for compilation speed.
Martin Hořeňovskýaf1ed702017-03-03 15:03:23 +0100490 * Moves debug breaks out of tests and into implementation, speeding up test compilation time (~10% on linux).
Phil Nash0952b762017-02-28 14:19:09 +0000491 * _More changes are coming_
492* Added [TAP (Test Anything Protocol)](https://testanything.org/) and [Automake](https://www.gnu.org/software/automake/manual/html_node/Log-files-generation-and-test-results-recording.html#Log-files-generation-and-test-results-recording) reporters.
493 * These are not present in the default single-include header and need to be downloaded from GitHub separately.
Martin Moene6c09b452017-08-24 15:33:38 +0200494 * For details see [documentation about integrating with build systems](build-systems.md#top).
Phil Nash0952b762017-02-28 14:19:09 +0000495* XML reporter now reports filename as part of the `Section` and `TestCase` tags.
496* `Approx` now supports an optional margin of absolute error
Martin Moene6c09b452017-08-24 15:33:38 +0200497 * It has also received [new documentation](assertions.md#top).
Phil Nash0952b762017-02-28 14:19:09 +0000498
Martin Moene66124d92017-08-28 22:20:33 +0200499#### Fixes
Phil Nash0952b762017-02-28 14:19:09 +0000500* Silenced C4312 ("conversion from int to 'ClassName *") warnings in the evaluate layer.
501* Fixed C4512 ("assignment operator could not be generated") warnings under VS2013.
502* Cygwin compatibility fixes
503 * Signal handling is no longer compiled by default.
504 * Usage of `gettimeofday` inside Catch should no longer cause compilation errors.
Josh Sorefb1117552018-03-07 04:08:35 -0500505* Improved `-Wparentheses` suppression for gcc (#674)
506 * When compiled with gcc 4.8 or newer, the suppression is localized to assertions only
Phil Nash0952b762017-02-28 14:19:09 +0000507 * Otherwise it is supressed for the whole TU
508* Fixed test spec parser issue (with escapes in multiple names)
509
Martin Moene66124d92017-08-28 22:20:33 +0200510#### Other
Phil Nash0952b762017-02-28 14:19:09 +0000511* Various documentation fixes and improvements
512
513
Martin Moene66124d92017-08-28 22:20:33 +0200514## 1.7.x
Phil Nashd08cee22017-02-13 16:15:42 +0000515
Martin Moene66124d92017-08-28 22:20:33 +0200516### 1.7.2
517
518#### Fixes and minor improvements
Phil Nashd08cee22017-02-13 16:15:42 +0000519Xml:
520
521(technically the first two are breaking changes but are also fixes and arguably break few if any people)
522* C-escape control characters instead of XML encoding them (which requires XML 1.1)
523* Revert XML output to XML 1.0
524* Can provide stylesheet references by extending the XML reporter
Josh Sorefb1117552018-03-07 04:08:35 -0500525* Added description and tags attributes to XML Reporter
Phil Nashd08cee22017-02-13 16:15:42 +0000526* Tags are closed and the stream flushed more eagerly to avoid stdout interpolation
527
528
529Other:
530* `REQUIRE_THROWS_AS` now catches exception by `const&` and reports expected type
531* In `SECTION`s the file/ line is now of the `SECTION`. not the `TEST_CASE`
532* Added std:: qualification to some functions from C stdlib
533* Removed use of RTTI (`dynamic_cast`) that had crept back in
534* Silenced a few more warnings in different circumstances
535* Travis improvements
536
Martin Moene66124d92017-08-28 22:20:33 +0200537### 1.7.1
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100538
Martin Moene66124d92017-08-28 22:20:33 +0200539#### Fixes:
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100540* Fixed inconsistency in defining `NOMINMAX` and `WIN32_LEAN_AND_MEAN` inside `catch.hpp`.
541* Fixed SEH-related compilation error under older MinGW compilers, by making Windows SEH handling opt-in for compilers other than MSVC.
Martin Moene6c09b452017-08-24 15:33:38 +0200542 * For specifics, look into the [documentation](configuration.md#top).
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100543* Fixed compilation error under MinGW caused by improper compiler detection.
544* Fixed XML reporter sometimes leaving an empty output file when a test ends with signal/structured exception.
545* Fixed XML reporter not reporting captured stdout/stderr.
546* Fixed possible infinite recursion in Windows SEH.
547* Fixed possible compilation error caused by Catch's operator overloads being ambiguous in regards to user-defined templated operators.
548
Martin Moene66124d92017-08-28 22:20:33 +0200549### 1.7.0
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100550
Martin Moene66124d92017-08-28 22:20:33 +0200551#### Features/ Changes:
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100552* Catch now runs significantly faster for passing tests
553 * Microbenchmark focused on Catch's overhead went from ~3.4s to ~0.7s.
554 * Real world test using [JSON for Modern C++](https://github.com/nlohmann/json)'s test suite went from ~6m 25s to ~4m 14s.
555* Catch can now run specific sections within test cases.
Martin Moene6c09b452017-08-24 15:33:38 +0200556 * For now the support is only basic (no wildcards or tags), for details see the [documentation](command-line.md#top).
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100557* Catch now supports SEH on Windows as well as signals on Linux.
558 * After receiving a signal, Catch reports failing assertion and then passes the signal onto the previous handler.
559* Approx can be used to compare values against strong typedefs (available in C++11 mode only).
560 * Strong typedefs mean types that are explicitly convertible to double.
561* CHECK macro no longer stops executing section if an exception happens.
562* Certain characters (space, tab, etc) are now pretty printed.
563 * This means that a `char c = ' '; REQUIRE(c == '\t');` would be printed as `' ' == '\t'`, instead of ` == 9`.
564
Martin Moene66124d92017-08-28 22:20:33 +0200565#### Fixes:
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100566* Text formatting no longer attempts to access out-of-bounds characters under certain conditions.
567* THROW family of assertions no longer trigger `-Wunused-value` on expressions containing explicit cast.
568* Breaking into debugger under OS X works again and no longer required `DEBUG` to be defined.
569* Compilation no longer breaks under certain compiler if a lambda is used inside assertion macro.
570
Martin Moene66124d92017-08-28 22:20:33 +0200571#### Other:
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100572* Catch's CMakeLists now defines install command.
573* Catch's CMakeLists now generates projects with warnings enabled.
574
575
Martin Moene66124d92017-08-28 22:20:33 +0200576## 1.6.x
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100577
Martin Moene66124d92017-08-28 22:20:33 +0200578### 1.6.1
579
580#### Features/ Changes:
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100581* Catch now supports breaking into debugger on Linux
582
Martin Moene66124d92017-08-28 22:20:33 +0200583#### Fixes:
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100584* Generators no longer leak memory (generators are still unsupported in general)
585* JUnit reporter now reports UTC timestamps, instead of "tbd"
586* `CHECK_THAT` macro is now properly defined as `CATCH_CHECK_THAT` when using `CATCH_` prefixed macros
587
Martin Moene66124d92017-08-28 22:20:33 +0200588#### Other:
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100589* Types with overloaded `&&` operator are no longer evaluated twice when used in an assertion macro.
590* The use of `__COUNTER__` is supressed when Catch is parsed by CLion
591 * This change is not active when compiling a binary
592* Approval tests can now be run on Windows
593* CMake will now warn if a file is present in the `include` folder but not is not enumerated as part of the project
594* Catch now defines `NOMINMAX` and `WIN32_LEAN_AND_MEAN` before including `windows.h`
Martin Moene6c09b452017-08-24 15:33:38 +0200595 * This can be disabled if needed, see [documentation](configuration.md#top) for details.
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100596
597
Martin Moene66124d92017-08-28 22:20:33 +0200598### 1.6.0
Phil Nash3b2f2062017-01-11 16:43:56 +0000599
Martin Moene66124d92017-08-28 22:20:33 +0200600#### Cmake/ projects:
Phil Nash3b2f2062017-01-11 16:43:56 +0000601* Moved CMakeLists.txt to root, made it friendlier for CLion and generating XCode and VS projects, and removed the manually maintained XCode and VS projects.
602
Martin Moene66124d92017-08-28 22:20:33 +0200603#### Features/ Changes:
Phil Nash1ff0acf2017-01-11 16:50:35 +0000604* Approx now supports `>=` and `<=`
605* Can now use `\` to escape chars in test names on command line
Phil Nash3b2f2062017-01-11 16:43:56 +0000606* Standardize C++11 feature toggles
607
Martin Moene66124d92017-08-28 22:20:33 +0200608#### Fixes:
Phil Nash3b2f2062017-01-11 16:43:56 +0000609* Blue shell colour
Phil Nash1ff0acf2017-01-11 16:50:35 +0000610* Missing argument to `CATCH_CHECK_THROWS`
Phil Nash3b2f2062017-01-11 16:43:56 +0000611* Don't encode extended ASCII in XML
Phil Nashe6aa1f42017-01-11 17:14:28 +0000612* use `std::shuffle` on more compilers (fixes deprecation warning/error)
Phil Nash1ff0acf2017-01-11 16:50:35 +0000613* Use `__COUNTER__` more consistently (where available)
Phil Nash3b2f2062017-01-11 16:43:56 +0000614
Martin Moene66124d92017-08-28 22:20:33 +0200615#### Other:
Phil Nash3b2f2062017-01-11 16:43:56 +0000616* Tweaks and changes to scripts - particularly for Approval test - to make them more portable
617
Phil Nash3b2f2062017-01-11 16:43:56 +0000618
Martin Moene66124d92017-08-28 22:20:33 +0200619# Even Older versions
Phil Nash0952b762017-02-28 14:19:09 +0000620Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history
621
Phil Nash3b2f2062017-01-11 16:43:56 +0000622---
623
Martin Moene6c09b452017-08-24 15:33:38 +0200624[Home](Readme.md#top)