blob: 5d82eeca661cca2bf3c90513b37a0f2c5e43e809 [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 Moenea81c01d2018-09-05 10:01:54 +02003# Release notes
4**Contents**<br>
5[2.4.0](#240)<br>
6[2.3.0](#230)<br>
7[2.2.3](#223)<br>
8[2.2.2](#222)<br>
9[2.2.1](#221)<br>
10[2.2.0](#220)<br>
11[2.1.2](#212)<br>
12[2.1.1](#211)<br>
13[2.1.0](#210)<br>
14[2.0.1](#201)<br>
15[Older versions](#older-versions)<br>
16[Even Older versions](#even-older-versions)<br>
17
18
Martin Hořeňovský60b05b22018-09-04 11:59:15 +020019# 2.4.0
20
21**This release brings two new experimental features, generator support
22and a `-fno-exceptions` support. Being experimental means that they
23will not be subject to the usual stability guarantees provided by semver.**
24
25## Improvements
26* Various small runtime performance improvements
27* `CAPTURE` macro is now variadic
28* Added `AND_GIVEN` macro (#1360)
29* Added experimental support for data generators
30 * See [their documentation](generators.md) for details
31* Added support for compiling and running Catch without exceptions
32 * Doing so limits the functionality somewhat
33 * Look [into the documentation](configuration.md#disablingexceptions) for details
34
35## Fixes
36* Suppressed `-Wnon-virtual-dtor` warnings in Matchers (#1357)
37* Suppressed `-Wunreachable-code` warnings in floating point matchers (#1350)
38
39## CMake
40* It is now possible to override which Python is used to run Catch's tests (#1365)
41* Catch now provides infrastructure for adding tests that check compile-time configuration
42* Catch no longer tries to install itself when used as a subproject (#1373)
43* Catch2ConfigVersion.cmake is now generated as arch-independent (#1368)
44 * This means that installing Catch from 32-bit machine and copying it to 64-bit one works
45 * This fixes conan installation of Catch
46
47
Martin Hořeňovský15cf3ca2018-07-23 10:12:15 +020048# 2.3.0
49
50**This release changes the include paths provided by our CMake and
51pkg-config integration. The proper include path for the single-header
52when using one of the above is now `<catch2/catch.hpp>`. This change
53also necessitated changes to paths inside the repository, so that the
54single-header version is now at `single_include/catch2/catch.hpp`, rather
55than `single_include/catch.hpp`.**
56
57
58
59## Fixes
60* Fixed Objective-C++ build
61* `-Wunused-variable` suppression no longer leaks from Catch's header under Clang
62* Implementation of the experimental new output capture can now be disabled (#1335)
63 * This allows building Catch2 on platforms that do not provide things like `dup` or `tmpfile`.
64* The JUnit and XML reporters will no longer skip over successful tests when running without `-s` (#1264, #1267, #1310)
65 * See improvements for more details
66
67## Improvements
68* pkg-config and CMake integration has been rewritten
69 * If you use them, the new include path is `#include <catch2/catch.hpp>`
70 * CMake installation now also installs scripts from `contrib/`
71 * For details see the [new documentation](cmake-integration.md#top)
72* Reporters now have a new customization point, `ReporterPreferences::shouldReportAllAssertions`
73 * When this is set to `false` and the tests are run without `-s`, passing assertions are not sent to the reporter.
74 * Defaults to `false`.
75* Added `DYNAMIC_SECTION`, a section variant that constructs its name using stream
76 * This means that you can do `DYNAMIC_SECTION("For X := " << x)`.
77
78
Martin Hořeňovskýd2a130f2018-06-06 23:16:06 +020079# 2.2.3
80
81**To fix some of the bugs, some behavior had to change in potentially breaking manner.**
82**This means that even though this is a patch release, it might not be a drop-in replacement.**
83
84## Fixes
85* Listeners are now called before reporter
86 * This was always documented to be the case, now it actually works that way
87* Catch's commandline will no longer accept multiple reporters
88 * This was done because multiple reporters never worked properly and broke things in non-obvious ways
89 * **This has potential to be a breaking change**
90* MinGW is now detected as Windows platform w/o SEH support (#1257)
91 * This means that Catch2 no longer tries to use POSIX signal handling when compiled with MinGW
92* Fixed potential UB in parsing tags using non-ASCII characters (#1266)
93 * Note that Catch2 still supports only ASCII test names/tags/etc
94* `TEST_CASE_METHOD` can now be used on classnames containing commas (#1245)
95 * You have to enclose the classname in extra set of parentheses
96* Fixed insufficient alt stack size for POSIX signal handling (#1225)
97* Fixed compilation error on Android due to missing `std::to_string` in C++11 mode (#1280)
98* Fixed the order of user-provided `FALLBACK_STRINGIFIER` in stringification machinery (#1024)
99 * It was intended to be replacement for built-in fallbacks, but it was used _after_ them.
100 * **This has potential to be a breaking change**
101* Fixed compilation error when a type has an `operator<<` with templated lhs (#1285, #1306)
102
103## Improvements
104* Added a new, experimental, output capture (#1243)
105 * This capture can also redirect output written via C apis, e.g. `printf`
106 * To opt-in, define `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` in the implementation file
107* Added a new fallback stringifier for classes derived from `std::exception`
108 * Both `StringMaker` specialization and `operator<<` overload are given priority
109
110## Miscellaneous
111* `contrib/` now contains dbg scripts that skip over Catch's internals (#904, #1283)
112 * `gdbinit` for gdb `lldbinit` for lldb
113* `CatchAddTests.cmake` no longer strips whitespace from tests (#1265, #1281)
114* Online documentation now describes `--use-colour` option (#1263)
115
116
Martin Hořeňovskýd2d84552018-04-06 12:11:22 +0200117# 2.2.2
118
119## Fixes
120* Fixed bug in `WithinAbs::match()` failing spuriously (#1228)
121* Fixed clang-tidy diagnostic about virtual call in destructor (#1226)
122* Reduced the number of GCC warnings suppression leaking out of the header (#1090, #1091)
123 * Only `-Wparentheses` should be leaking now
124* Added upper bound on the time benchmark timer calibration is allowed to take (#1237)
125 * On platforms where `std::chrono::high_resolution_clock`'s resolution is low, the calibration would appear stuck
126* Fixed compilation error when stringifying static arrays of `unsigned char`s (#1238)
127
128## Improvements
129* XML encoder now hex-encodes invalid UTF-8 sequences (#1207)
130 * This affects xml and junit reporters
131 * 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.
132* CLR objects (`T^`) can now be stringified (#1216)
133 * This affects code compiled as C++/CLI
134* Added `PredicateMatcher`, a matcher that takes an arbitrary predicate function (#1236)
135 * See [documentation for details](https://github.com/catchorg/Catch2/blob/master/docs/matchers.md)
136
137## Others
138* Modified CMake-installed pkg-config to allow `#include <catch.hpp>`(#1239)
139 * The plans to standardize on `#include <catch2/catch.hpp>` are still in effect
140
141
Martin Hořeňovský0a34cc22018-03-11 12:04:28 +0100142# 2.2.1
143
144## Fixes
145* Fixed compilation error when compiling Catch2 with `std=c++17` against libc++ (#1214)
146 * Clara (Catch2's CLI parsing library) used `std::optional` without including it explicitly
147* Fixed Catch2 return code always being 0 (#1215)
148 * In the words of STL, "We feel superbad about letting this in"
149
150
Martin Hořeňovskýd14b7562018-03-07 11:01:06 +0100151# 2.2.0
152
153## Fixes
154* Hidden tests are not listed by default when listing tests (#1175)
155 * This makes `catch_discover_tests` CMake script work better
156* Fixed regression that meant `<windows.h>` could potentially not be included properly (#1197)
157* Fixed installing `Catch2ConfigVersion.cmake` when Catch2 is a subproject.
158
159## Improvements
160* Added an option to warn (+ exit with error) when no tests were ran (#1158)
161 * Use as `-w NoTests`
162* Added provisional support for Emscripten (#1114)
163* [Added a way to override the fallback stringifier](https://github.com/catchorg/Catch2/blob/master/docs/configuration.md#fallback-stringifier) (#1024)
164 * This allows project's own stringification machinery to be easily reused for Catch
165* `Catch::Session::run()` now accepts `char const * const *`, allowing it to accept array of string literals (#1031, #1178)
166 * The embedded version of Clara was bumped to v1.1.3
167* Various minor performance improvements
168* Added support for DJGPP DOS crosscompiler (#1206)
169
170
Martin Hořeňovský7cbd0b52018-02-09 17:10:27 +0100171# 2.1.2
172
173## Fixes
174* Fixed compilation error with `-fno-rtti` (#1165)
175* Fixed NoAssertion warnings
176* `operator<<` is used before range-based stringification (#1172)
177* Fixed `-Wpedantic` warnings (extra semicolons and binary literals) (#1173)
178
179
180## Improvements
181* Added `CATCH_VERSION_{MAJOR,MINOR,PATCH}` macros (#1131)
182* Added `BrightYellow` colour for use in reporters (#979)
183 * It is also used by ConsoleReporter for reconstructed expressions
184
185## Other changes
186* Catch is now exported as a CMake package and linkable target (#1170)
187
Martin Hořeňovský62dae592018-01-26 16:06:07 +0100188# 2.1.1
189
190## Improvements
191* Static arrays are now properly stringified like ranges across MSVC/GCC/Clang
192* Embedded newer version of Clara -- v1.1.1
193 * This should fix some warnings dragged in from Clara
194* MSVC's CLR exceptions are supported
195
196
197## Fixes
198* Fixed compilation when comparison operators do not return bool (#1147)
199* Fixed CLR exceptions blowing up the executable during translation (#1138)
200
201
202## Other changes
203* Many CMake changes
204 * `NO_SELFTEST` option is deprecated, use `BUILD_TESTING` instead.
205 * Catch specific CMake options were prefixed with `CATCH_` for namespacing purposes
206 * Other changes to simplify Catch2's packaging
207
208
209
Martin Hořeňovskýcd76f572018-01-10 13:53:04 +0100210# 2.1.0
211
212## Improvements
213* Various performance improvements
214 * On top of the performance regression fixes
215* Experimental support for PCH was added (#1061)
216* `CATCH_CONFIG_EXTERNAL_INTERFACES` now brings in declarations of Console, Compact, XML and JUnit reporters
217* `MatcherBase` no longer has a pointless second template argument
218* Reduced the number of warning suppressions that leak into user's code
219 * Bugs in g++ 4.x and 5.x mean that some of them have to be left in
220
221
222## Fixes
223* Fixed performance regression from Catch classic
224 * One of the performance improvement patches for Catch classic was not applied to Catch2
225* Fixed platform detection for iOS (#1084)
226* Fixed compilation when `g++` is used together with `libc++` (#1110)
227* Fixed TeamCity reporter compilation with the single header version
228 * To fix the underlying issue we will be versioning reporters in single_include folder per release
229* The XML reporter will now report `WARN` messages even when not used with `-s`
230* Fixed compilation when `VectorContains` matcher was combined using `&&` (#1092)
231* Fixed test duration overflowing after 10 seconds (#1125, #1129)
232* Fixed `std::uncaught_exception` deprecation warning (#1124)
233
234
235## New features
236* New Matchers
237 * Regex matcher for strings, `Matches`.
238 * Set-equal matcher for vectors, `UnorderedEquals`
239 * Floating point matchers, `WithinAbs` and `WithinULP`.
240* Stringification now attempts to decompose all containers (#606)
241 * Containers are objects that respond to ADL `begin(T)` and `end(T)`.
242
243
244## Other changes
245* Reporters will now be versioned in the `single_include` folder to ensure their compatibility with the last released version
246
247
248
249
Phil Nashb119ebd2017-11-03 12:01:52 +0000250# 2.0.1
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200251
252## Breaking changes
253* Removed C++98 support
254* Removed legacy reporter support
255* Removed legacy generator support
256 * Generator support will come back later, reworked
257* Removed `Catch::toString` support
258 * The new stringification machinery uses `Catch::StringMaker` specializations first and `operator<<` overloads second.
259* Removed legacy `SCOPED_MSG` and `SCOPED_INFO` macros
Martin Hořeňovský053c29a2017-08-27 17:03:32 +0200260* Removed `INTERNAL_CATCH_REGISTER_REPORTER`
261 * `CATCH_REGISTER_REPORTER` should be used to register reporters
262* Removed legacy `[hide]` tag
263 * `[.]`, `[.foo]` and `[!hide]` are still supported
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200264* Output into debugger is now colourized
265* `*_THROWS_AS(expr, exception_type)` now unconditionally appends `const&` to the exception type.
266* `CATCH_CONFIG_FAST_COMPILE` now affects the `CHECK_` family of assertions as well as `REQUIRE_` family of assertions
267 * 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 +0200268* Removed deprecated matcher utility functions `Not`, `AllOf` and `AnyOf`.
269 * 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 +0200270* Removed support for non-const comparison operators
271 * Non-const comparison operators are an abomination that should not exist
272 * They were breaking support for comparing function to function pointer
Martin Hořeňovský79b405f2017-10-09 12:31:22 +0200273* `std::pair` and `std::tuple` are no longer stringified by default
274 * This is done to avoid dragging in `<tuple>` and `<utility>` headers in common path
275 * Their stringification can be enabled per-file via new configuration macros
Martin Hořeňovský31cc62e2017-11-01 22:25:17 +0100276* `Approx` is subtly different and hopefully behaves more as users would expect
277 * `Approx::scale` defaults to `0.0`
278 * `Approx::epsilon` no longer applies to the larger of the two compared values, but only to the `Approx`'s value
279 * `INFINITY == Approx(INFINITY)` returns true
280
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200281
282## Improvements
283* Reporters and Listeners can be defined in files different from the main file
284 * The file has to define `CATCH_CONFIG_EXTERNAL_INTERFACES` before including catch.hpp.
285* Errors that happen during set up before main are now caught and properly reported once main is entered
286 * If you are providing your own main, you can access and use these as well.
Phil Nash24e6d5f2017-11-09 11:09:17 +0100287* New assertion macros, *_THROWS_MATCHES(expr, exception_type, matcher) are provided
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200288 * As the arguments suggest, these allow you to assert that an expression throws desired type of exception and pass the exception to a matcher.
289* JUnit reporter no longer has significantly different output for test cases with and without sections
290* Most assertions now support expressions containing commas (ie `REQUIRE(foo() == std::vector<int>{1, 2, 3});`)
291* Catch now contains experimental micro benchmarking support
292 * See `projects/SelfTest/Benchmark.tests.cpp` for examples
293 * The support being experiment means that it can be changed without prior notice
294* Catch uses new CLI parsing library (Clara)
295 * Users can now easily add new command line options to the final executable
296 * This also leads to some changes in `Catch::Session` interface
Martin Hořeňovský053c29a2017-08-27 17:03:32 +0200297* All parts of matchers can be removed from a TU by defining `CATCH_CONFIG_DISABLE_MATCHERS`
298 * This can be used to somewhat speed up compilation times
299* An experimental implementation of `CATCH_CONFIG_DISABLE` has been added
Martin Hořeňovský13213fa2017-08-30 12:43:23 +0200300 * Inspired by Doctest's `DOCTEST_CONFIG_DISABLE`
Martin Hořeňovský053c29a2017-08-27 17:03:32 +0200301 * Useful for implementing tests in source files
302 * ie for functions in anonymous namespaces
Martin Hořeňovský13213fa2017-08-30 12:43:23 +0200303 * Removes all assertions
304 * Prevents `TEST_CASE` registrations
305 * Exception translators are not registered
306 * Reporters are not registered
307 * Listeners are not registered
Martin Hořeňovský80bbce82017-09-26 13:36:57 +0200308* Reporters/Listeners are now notified of fatal errors
309 * This means specific signals or structured exceptions
310 * The Reporter/Listener interface provides default, empty, implementation to preserve backward compatibility
Martin Hořeňovský79b405f2017-10-09 12:31:22 +0200311* Stringification of `std::chrono::duration` and `std::chrono::time_point` is now supported
312 * Needs to be enabled by a per-file compile time configuration option
Martin Hořeňovskýae210202017-10-31 15:17:21 +0100313* Add `pkg-config` support to CMake install command
314
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200315
316## Fixes
Martin Hořeňovský80bbce82017-09-26 13:36:57 +0200317* Don't use console colour if running in XCode
Phil Nashe9f07732017-09-19 17:36:20 +0100318* Explicit constructor in reporter base class
Martin Hořeňovský80bbce82017-09-26 13:36:57 +0200319* Swept out `-Wweak-vtables`, `-Wexit-time-destructors`, `-Wglobal-constructors` warnings
320* Compilation for Universal Windows Platform (UWP) is supported
321 * SEH handling and colorized output are disabled when compiling for UWP
Martin Hořeňovskýb80c5132017-10-01 17:03:06 +0200322* Implemented a workaround for `std::uncaught_exception` issues in libcxxrt
323 * These issues caused incorrect section traversals
324 * 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 +0100325* Suppressed C4061 warning under MSVC
326
Martin Hořeňovský49f59192017-08-18 20:15:00 +0200327
328## Internal changes
329* The development version now uses .cpp files instead of header files containing implementation.
330 * This makes partial rebuilds much faster during development
331* The expression decomposition layer has been rewritten
332* The evaluation layer has been rewritten
333* New library (TextFlow) is used for formatting text to output
334
335
Martin Moene66124d92017-08-28 22:20:33 +0200336# Older versions
337
Martin Hořeňovský24851df2017-12-03 14:19:02 +0100338## 1.11.x
339
340### 1.11.0
341
342#### Fixes
343* The original expression in `REQUIRE_FALSE( expr )` is now reporter properly as `!( expr )` (#1051)
344 * Previously the parentheses were missing and `x != y` would be expanded as `!x != x`
345* `Approx::Margin` is now inclusive (#952)
346 * Previously it was meant and documented as inclusive, but the check itself wasn't
347 * This means that `REQUIRE( 0.25f == Approx( 0.0f ).margin( 0.25f ) )` passes, instead of fails
348* `RandomNumberGenerator::result_type` is now unsigned (#1050)
349
350#### Improvements
351* `__JETBRAINS_IDE__` macro handling is now CLion version specific (#1017)
352 * When CLion 2017.3 or newer is detected, `__COUNTER__` is used instead of
353* TeamCity reporter now explicitly flushes output stream after each report (#1057)
354 * On some platforms, output from redirected streams would show up only after the tests finished running
355* `ParseAndAddCatchTests` now can add test files as dependency to CMake configuration
356 * This means you do not have to manually rerun CMake configuration step to detect new tests
357
358## 1.10.x
359
360### 1.10.0
361
362#### Fixes
363* Evaluation layer has been rewritten (backported from Catch 2)
364 * The new layer is much simpler and fixes some issues (#981)
365* Implemented workaround for VS 2017 raw string literal stringification bug (#995)
366* Fixed interaction between `[!shouldfail]` and `[!mayfail]` tags and sections
367 * Previously sections with failing assertions would be marked as failed, not failed-but-ok
368
369#### Improvements
370* Added [libidentify](https://github.com/janwilmans/LibIdentify) support
371* Added "wait-for-keypress" option
372
Martin Moene66124d92017-08-28 22:20:33 +0200373## 1.9.x
374
375### 1.9.6
376
377#### Improvements
Martin Hořeňovskýee67ac62017-06-27 12:21:48 +0200378* Catch's runtime overhead has been significantly decreased (#937, #939)
379* Added `--list-extra-info` cli option (#934).
380 * It lists all tests together with extra information, ie filename, line number and description.
381
382
383
Martin Moene66124d92017-08-28 22:20:33 +0200384### 1.9.5
Martin Hořeňovský017a63d2017-06-15 13:08:26 +0200385
Martin Moene66124d92017-08-28 22:20:33 +0200386#### Fixes
Martin Hořeňovský017a63d2017-06-15 13:08:26 +0200387* Truthy expressions are now reconstructed properly, not as booleans (#914)
388* 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)
389* Catch no longer fails to link when main is compiled as C++, but linked against Objective-C (#855)
390* Fixed incorrect gcc version detection when deciding to use `__COUNTER__` (#928)
391 * Previously any GCC with minor version less than 3 would be incorrectly classified as not supporting `__COUNTER__`.
392* Suppressed C4996 warning caused by upcoming updated to MSVC 2017, marking `std::uncaught_exception` as deprecated. (#927)
393
Martin Moene66124d92017-08-28 22:20:33 +0200394#### Improvements
Martin Hořeňovský017a63d2017-06-15 13:08:26 +0200395* CMake integration script now incorporates debug messages and registers tests in an improved way (#911)
396* Various documentation improvements
397
398
399
Martin Moene66124d92017-08-28 22:20:33 +0200400### 1.9.4
Martin Hořeňovský3dcc9232017-05-16 13:59:29 +0200401
Martin Moene66124d92017-08-28 22:20:33 +0200402#### Fixes
Martin Hořeňovský3dcc9232017-05-16 13:59:29 +0200403* `CATCH_FAIL` macro no longer causes compilation error without variadic macro support
404* `INFO` messages are no longer cleared after being reported once
405
Martin Moene66124d92017-08-28 22:20:33 +0200406#### Improvements and minor changes
Martin Hořeňovský3dcc9232017-05-16 13:59:29 +0200407* Catch now uses `wmain` when compiled under Windows and `UNICODE` is defined.
408 * Note that Catch still officially supports only ASCII
409
Martin Moene66124d92017-08-28 22:20:33 +0200410### 1.9.3
Phil Nasha0ada2e2017-04-25 14:23:06 +0000411
Martin Moene66124d92017-08-28 22:20:33 +0200412#### Fixes
Phil Nasha0ada2e2017-04-25 14:23:06 +0000413* Completed the fix for (lack of) uint64_t in earlier Visual Studios
414
Martin Moene66124d92017-08-28 22:20:33 +0200415### 1.9.2
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200416
Martin Moene66124d92017-08-28 22:20:33 +0200417#### Improvements and minor changes
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200418* All of `Approx`'s member functions now accept strong typedefs in C++11 mode (#888)
419 * Previously `Approx::scale`, `Approx::epsilon`, `Approx::margin` and `Approx::operator()` didn't.
420
421
Martin Moene66124d92017-08-28 22:20:33 +0200422#### Fixes
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200423* POSIX signals are now disabled by default under QNX (#889)
424 * QNX does not support current enough (2001) POSIX specification
425* JUnit no longer counts exceptions as failures if given test case is marked as ok to fail.
426* `Catch::Option` should now have its storage properly aligned.
427* Catch no longer attempts to define `uint64_t` on windows (#862)
428 * This was causing trouble when compiled under Cygwin
429
Martin Moene66124d92017-08-28 22:20:33 +0200430#### Other
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +0200431* Catch is now compiled under MSVC 2017 using `std:c++latest` (C++17 mode) in CI
432* We now provide cmake script that autoregisters Catch tests into ctest.
433 * See `contrib` folder.
434
435
Martin Moene66124d92017-08-28 22:20:33 +0200436### 1.9.1
Martin Hořeňovskýc6990cd2017-04-09 21:25:20 +0200437
Martin Moene66124d92017-08-28 22:20:33 +0200438#### Fixes
Martin Hořeňovskýc6990cd2017-04-09 21:25:20 +0200439* Unexpected exceptions are no longer ignored by default (#885, #887)
440
441
Martin Moene66124d92017-08-28 22:20:33 +0200442### 1.9.0
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200443
444
Martin Moene66124d92017-08-28 22:20:33 +0200445#### Improvements and minor changes
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200446* Catch no longer attempts to ensure the exception type passed by user in `REQUIRE_THROWS_AS` is a constant reference.
447 * It was causing trouble when `REQUIRE_THROWS_AS` was used inside templated functions
448 * This actually reverts changes made in v1.7.2
449* Catch's `Version` struct should no longer be double freed when multiple instances of Catch tests are loaded into single program (#858)
450 * It is now a static variable in an inline function instead of being an `extern`ed struct.
451* Attempt to register invalid tag or tag alias now throws instead of calling `exit()`.
452 * Because this happen before entering main, it still aborts execution
453 * Further improvements to this are coming
454* `CATCH_CONFIG_FAST_COMPILE` now speeds-up compilation of `REQUIRE*` assertions by further ~15%.
455 * The trade-off is disabling translation of unexpected exceptions into text.
456* When Catch is compiled using C++11, `Approx` is now constructible with anything that can be explicitly converted to `double`.
457* Captured messages are now printed on unexpected exceptions
458
Martin Moene66124d92017-08-28 22:20:33 +0200459#### Fixes:
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200460* Clang's `-Wexit-time-destructors` should be suppressed for Catch's internals
461* GCC's `-Wparentheses` is now suppressed for all TU's that include `catch.hpp`.
462 * 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.
463* You can now tell Catch to use C++11-based check when checking whether a type can be streamed to output.
464 * This fixes cases when an unstreamable type has streamable private base (#877)
465 * [Details can be found in documentation](configuration.md#catch_config_cpp11_stream_insertable_check)
466
467
Martin Moene66124d92017-08-28 22:20:33 +0200468#### Other notes:
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +0200469* We have added VS 2017 to our CI
470* Work on Catch 2 should start soon
471
472
473
Martin Moene66124d92017-08-28 22:20:33 +0200474## 1.8.x
475
476### 1.8.2
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100477
478
Martin Moene66124d92017-08-28 22:20:33 +0200479#### Improvements and minor changes
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100480* TAP reporter now behaves as if `-s` was always set
481 * This should be more consistent with the protocol desired behaviour.
482* Compact reporter now obeys `-d yes` argument (#780)
483 * The format is "XXX.123 s: <section-name>" (3 decimal places are always present).
484 * Before it did not report the durations at all.
485* XML reporter now behaves the same way as Console reporter in regards to `INFO`
486 * This means it reports `INFO` messages on success, if output on success (`-s`) is enabled.
487 * Previously it only reported `INFO` messages on failure.
488* `CAPTURE(expr)` now stringifies `expr` in the same way assertion macros do (#639)
Martin Moene6c09b452017-08-24 15:33:38 +0200489* Listeners are now finally [documented](event-listeners.md#top).
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100490 * 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.
491
492
Martin Moene66124d92017-08-28 22:20:33 +0200493#### Fixes:
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100494* Catch no longer attempts to reconstruct expression that led to a fatal error (#810)
495 * This fixes possible signal/SEH loop when processing expressions, where the signal was triggered by expression decomposition.
496* Fixed (C4265) missing virtual destructor warning in Matchers (#844)
497* `std::string`s are now taken by `const&` everywhere (#842).
498 * Previously some places were taking them by-value.
499* Catch should no longer change errno (#835).
500 * This was caused by libstdc++ bug that we now work around.
501* Catch now provides `FAIL_CHECK( ... )` macro (#765).
502 * Same as `FAIL( ... )`, but does not abort the test.
503* Functions like `fabs`, `tolower`, `memset`, `isalnum` are now used with `std::` qualification (#543).
504* Clara no longer assumes first argument (binary name) is always present (#729)
505 * If it is missing, empty string is used as default.
506* Clara no longer reads 1 character past argument string (#830)
Phil Nash06923172017-03-15 09:04:09 +0000507* Regression in Objective-C bindings (Matchers) fixed (#854)
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100508
509
Martin Moene66124d92017-08-28 22:20:33 +0200510#### Other notes:
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100511* We have added VS 2013 and 2015 to our CI
512* Catch Classic (1.x.x) now contains its own, forked, version of Clara (the argument parser).
513
514
515
Martin Moene66124d92017-08-28 22:20:33 +0200516### 1.8.1
Phil Nash658b5f62017-03-01 16:06:48 +0000517
Martin Moene66124d92017-08-28 22:20:33 +0200518#### Fixes
Phil Nash658b5f62017-03-01 16:06:48 +0000519
520Cygwin issue with `gettimeofday` - `#define` was not early enough
521
Martin Moene66124d92017-08-28 22:20:33 +0200522### 1.8.0
Phil Nash0952b762017-02-28 14:19:09 +0000523
Martin Moene66124d92017-08-28 22:20:33 +0200524#### New features/ minor changes
Phil Nash0952b762017-02-28 14:19:09 +0000525
526* Matchers have new, simpler (and documented) interface.
527 * Catch provides string and vector matchers.
Martin Moene6c09b452017-08-24 15:33:38 +0200528 * For details see [Matchers documentation](matchers.md#top).
Phil Nash0952b762017-02-28 14:19:09 +0000529* Changed console reporter test duration reporting format (#322)
530 * Old format: `Some simple comparisons between doubles completed in 0.000123s`
531 * New format: `xxx.123s: Some simple comparisons between doubles` _(There will always be exactly 3 decimal places)_
532* Added opt-in leak detection under MSVC + Windows (#439)
533 * Enable it by compiling Catch's main with `CATCH_CONFIG_WINDOWS_CRTDBG`
534* Introduced new compile-time flag, `CATCH_CONFIG_FAST_COMPILE`, trading features for compilation speed.
Martin Hořeňovskýaf1ed702017-03-03 15:03:23 +0100535 * Moves debug breaks out of tests and into implementation, speeding up test compilation time (~10% on linux).
Phil Nash0952b762017-02-28 14:19:09 +0000536 * _More changes are coming_
537* 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.
538 * 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 +0200539 * For details see [documentation about integrating with build systems](build-systems.md#top).
Phil Nash0952b762017-02-28 14:19:09 +0000540* XML reporter now reports filename as part of the `Section` and `TestCase` tags.
541* `Approx` now supports an optional margin of absolute error
Martin Moene6c09b452017-08-24 15:33:38 +0200542 * It has also received [new documentation](assertions.md#top).
Phil Nash0952b762017-02-28 14:19:09 +0000543
Martin Moene66124d92017-08-28 22:20:33 +0200544#### Fixes
Phil Nash0952b762017-02-28 14:19:09 +0000545* Silenced C4312 ("conversion from int to 'ClassName *") warnings in the evaluate layer.
546* Fixed C4512 ("assignment operator could not be generated") warnings under VS2013.
547* Cygwin compatibility fixes
548 * Signal handling is no longer compiled by default.
549 * Usage of `gettimeofday` inside Catch should no longer cause compilation errors.
Josh Sorefb1117552018-03-07 04:08:35 -0500550* Improved `-Wparentheses` suppression for gcc (#674)
551 * When compiled with gcc 4.8 or newer, the suppression is localized to assertions only
Phil Nash0952b762017-02-28 14:19:09 +0000552 * Otherwise it is supressed for the whole TU
553* Fixed test spec parser issue (with escapes in multiple names)
554
Martin Moene66124d92017-08-28 22:20:33 +0200555#### Other
Phil Nash0952b762017-02-28 14:19:09 +0000556* Various documentation fixes and improvements
557
558
Martin Moene66124d92017-08-28 22:20:33 +0200559## 1.7.x
Phil Nashd08cee22017-02-13 16:15:42 +0000560
Martin Moene66124d92017-08-28 22:20:33 +0200561### 1.7.2
562
563#### Fixes and minor improvements
Phil Nashd08cee22017-02-13 16:15:42 +0000564Xml:
565
566(technically the first two are breaking changes but are also fixes and arguably break few if any people)
567* C-escape control characters instead of XML encoding them (which requires XML 1.1)
568* Revert XML output to XML 1.0
569* Can provide stylesheet references by extending the XML reporter
Josh Sorefb1117552018-03-07 04:08:35 -0500570* Added description and tags attributes to XML Reporter
Phil Nashd08cee22017-02-13 16:15:42 +0000571* Tags are closed and the stream flushed more eagerly to avoid stdout interpolation
572
573
574Other:
575* `REQUIRE_THROWS_AS` now catches exception by `const&` and reports expected type
576* In `SECTION`s the file/ line is now of the `SECTION`. not the `TEST_CASE`
577* Added std:: qualification to some functions from C stdlib
578* Removed use of RTTI (`dynamic_cast`) that had crept back in
579* Silenced a few more warnings in different circumstances
580* Travis improvements
581
Martin Moene66124d92017-08-28 22:20:33 +0200582### 1.7.1
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100583
Martin Moene66124d92017-08-28 22:20:33 +0200584#### Fixes:
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100585* Fixed inconsistency in defining `NOMINMAX` and `WIN32_LEAN_AND_MEAN` inside `catch.hpp`.
586* 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 +0200587 * For specifics, look into the [documentation](configuration.md#top).
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100588* Fixed compilation error under MinGW caused by improper compiler detection.
589* Fixed XML reporter sometimes leaving an empty output file when a test ends with signal/structured exception.
590* Fixed XML reporter not reporting captured stdout/stderr.
591* Fixed possible infinite recursion in Windows SEH.
592* Fixed possible compilation error caused by Catch's operator overloads being ambiguous in regards to user-defined templated operators.
593
Martin Moene66124d92017-08-28 22:20:33 +0200594### 1.7.0
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100595
Martin Moene66124d92017-08-28 22:20:33 +0200596#### Features/ Changes:
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100597* Catch now runs significantly faster for passing tests
598 * Microbenchmark focused on Catch's overhead went from ~3.4s to ~0.7s.
599 * Real world test using [JSON for Modern C++](https://github.com/nlohmann/json)'s test suite went from ~6m 25s to ~4m 14s.
600* Catch can now run specific sections within test cases.
Martin Moene6c09b452017-08-24 15:33:38 +0200601 * 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 +0100602* Catch now supports SEH on Windows as well as signals on Linux.
603 * After receiving a signal, Catch reports failing assertion and then passes the signal onto the previous handler.
604* Approx can be used to compare values against strong typedefs (available in C++11 mode only).
605 * Strong typedefs mean types that are explicitly convertible to double.
606* CHECK macro no longer stops executing section if an exception happens.
607* Certain characters (space, tab, etc) are now pretty printed.
608 * This means that a `char c = ' '; REQUIRE(c == '\t');` would be printed as `' ' == '\t'`, instead of ` == 9`.
609
Martin Moene66124d92017-08-28 22:20:33 +0200610#### Fixes:
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100611* Text formatting no longer attempts to access out-of-bounds characters under certain conditions.
612* THROW family of assertions no longer trigger `-Wunused-value` on expressions containing explicit cast.
613* Breaking into debugger under OS X works again and no longer required `DEBUG` to be defined.
614* Compilation no longer breaks under certain compiler if a lambda is used inside assertion macro.
615
Martin Moene66124d92017-08-28 22:20:33 +0200616#### Other:
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100617* Catch's CMakeLists now defines install command.
618* Catch's CMakeLists now generates projects with warnings enabled.
619
620
Martin Moene66124d92017-08-28 22:20:33 +0200621## 1.6.x
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100622
Martin Moene66124d92017-08-28 22:20:33 +0200623### 1.6.1
624
625#### Features/ Changes:
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100626* Catch now supports breaking into debugger on Linux
627
Martin Moene66124d92017-08-28 22:20:33 +0200628#### Fixes:
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100629* Generators no longer leak memory (generators are still unsupported in general)
630* JUnit reporter now reports UTC timestamps, instead of "tbd"
631* `CHECK_THAT` macro is now properly defined as `CATCH_CHECK_THAT` when using `CATCH_` prefixed macros
632
Martin Moene66124d92017-08-28 22:20:33 +0200633#### Other:
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100634* Types with overloaded `&&` operator are no longer evaluated twice when used in an assertion macro.
635* The use of `__COUNTER__` is supressed when Catch is parsed by CLion
636 * This change is not active when compiling a binary
637* Approval tests can now be run on Windows
638* CMake will now warn if a file is present in the `include` folder but not is not enumerated as part of the project
639* Catch now defines `NOMINMAX` and `WIN32_LEAN_AND_MEAN` before including `windows.h`
Martin Moene6c09b452017-08-24 15:33:38 +0200640 * This can be disabled if needed, see [documentation](configuration.md#top) for details.
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100641
642
Martin Moene66124d92017-08-28 22:20:33 +0200643### 1.6.0
Phil Nash3b2f2062017-01-11 16:43:56 +0000644
Martin Moene66124d92017-08-28 22:20:33 +0200645#### Cmake/ projects:
Phil Nash3b2f2062017-01-11 16:43:56 +0000646* 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.
647
Martin Moene66124d92017-08-28 22:20:33 +0200648#### Features/ Changes:
Phil Nash1ff0acf2017-01-11 16:50:35 +0000649* Approx now supports `>=` and `<=`
650* Can now use `\` to escape chars in test names on command line
Phil Nash3b2f2062017-01-11 16:43:56 +0000651* Standardize C++11 feature toggles
652
Martin Moene66124d92017-08-28 22:20:33 +0200653#### Fixes:
Phil Nash3b2f2062017-01-11 16:43:56 +0000654* Blue shell colour
Phil Nash1ff0acf2017-01-11 16:50:35 +0000655* Missing argument to `CATCH_CHECK_THROWS`
Phil Nash3b2f2062017-01-11 16:43:56 +0000656* Don't encode extended ASCII in XML
Phil Nashe6aa1f42017-01-11 17:14:28 +0000657* use `std::shuffle` on more compilers (fixes deprecation warning/error)
Phil Nash1ff0acf2017-01-11 16:50:35 +0000658* Use `__COUNTER__` more consistently (where available)
Phil Nash3b2f2062017-01-11 16:43:56 +0000659
Martin Moene66124d92017-08-28 22:20:33 +0200660#### Other:
Phil Nash3b2f2062017-01-11 16:43:56 +0000661* Tweaks and changes to scripts - particularly for Approval test - to make them more portable
662
Phil Nash3b2f2062017-01-11 16:43:56 +0000663
Martin Moene66124d92017-08-28 22:20:33 +0200664# Even Older versions
Phil Nash0952b762017-02-28 14:19:09 +0000665Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history
666
Phil Nash3b2f2062017-01-11 16:43:56 +0000667---
668
Martin Moene6c09b452017-08-24 15:33:38 +0200669[Home](Readme.md#top)