blob: e5fa953175370f0b86a7c8997fde2a38dbed2a88 [file] [log] [blame] [view]
Martin Hořeňovský017a63d2017-06-15 13:08:26 +02001# 1.9.5
2
3### Fixes
4* Truthy expressions are now reconstructed properly, not as booleans (#914)
5* 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)
6* Catch no longer fails to link when main is compiled as C++, but linked against Objective-C (#855)
7* Fixed incorrect gcc version detection when deciding to use `__COUNTER__` (#928)
8 * Previously any GCC with minor version less than 3 would be incorrectly classified as not supporting `__COUNTER__`.
9* Suppressed C4996 warning caused by upcoming updated to MSVC 2017, marking `std::uncaught_exception` as deprecated. (#927)
10
11### Improvements
12* CMake integration script now incorporates debug messages and registers tests in an improved way (#911)
13* Various documentation improvements
14
15
16
Martin Hořeňovský3dcc9232017-05-16 13:59:29 +020017# 1.9.4
18
19### Fixes
20* `CATCH_FAIL` macro no longer causes compilation error without variadic macro support
21* `INFO` messages are no longer cleared after being reported once
22
23### Improvements and minor changes
24* Catch now uses `wmain` when compiled under Windows and `UNICODE` is defined.
25 * Note that Catch still officially supports only ASCII
26
Phil Nasha0ada2e2017-04-25 14:23:06 +000027# 1.9.3
28
29### Fixes
30* Completed the fix for (lack of) uint64_t in earlier Visual Studios
31
Martin Hořeňovskýfc7f0a02017-04-25 11:08:02 +020032# 1.9.2
33
34### Improvements and minor changes
35* All of `Approx`'s member functions now accept strong typedefs in C++11 mode (#888)
36 * Previously `Approx::scale`, `Approx::epsilon`, `Approx::margin` and `Approx::operator()` didn't.
37
38
39### Fixes
40* POSIX signals are now disabled by default under QNX (#889)
41 * QNX does not support current enough (2001) POSIX specification
42* JUnit no longer counts exceptions as failures if given test case is marked as ok to fail.
43* `Catch::Option` should now have its storage properly aligned.
44* Catch no longer attempts to define `uint64_t` on windows (#862)
45 * This was causing trouble when compiled under Cygwin
46
47### Other
48* Catch is now compiled under MSVC 2017 using `std:c++latest` (C++17 mode) in CI
49* We now provide cmake script that autoregisters Catch tests into ctest.
50 * See `contrib` folder.
51
52
Martin Hořeňovskýc6990cd2017-04-09 21:25:20 +020053# 1.9.1
54
55### Fixes
56* Unexpected exceptions are no longer ignored by default (#885, #887)
57
58
Martin Hořeňovský1b03c5a2017-04-07 22:56:36 +020059# 1.9.0
60
61
62### Improvements and minor changes
63* Catch no longer attempts to ensure the exception type passed by user in `REQUIRE_THROWS_AS` is a constant reference.
64 * It was causing trouble when `REQUIRE_THROWS_AS` was used inside templated functions
65 * This actually reverts changes made in v1.7.2
66* Catch's `Version` struct should no longer be double freed when multiple instances of Catch tests are loaded into single program (#858)
67 * It is now a static variable in an inline function instead of being an `extern`ed struct.
68* Attempt to register invalid tag or tag alias now throws instead of calling `exit()`.
69 * Because this happen before entering main, it still aborts execution
70 * Further improvements to this are coming
71* `CATCH_CONFIG_FAST_COMPILE` now speeds-up compilation of `REQUIRE*` assertions by further ~15%.
72 * The trade-off is disabling translation of unexpected exceptions into text.
73* When Catch is compiled using C++11, `Approx` is now constructible with anything that can be explicitly converted to `double`.
74* Captured messages are now printed on unexpected exceptions
75
76### Fixes:
77* Clang's `-Wexit-time-destructors` should be suppressed for Catch's internals
78* GCC's `-Wparentheses` is now suppressed for all TU's that include `catch.hpp`.
79 * 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.
80* You can now tell Catch to use C++11-based check when checking whether a type can be streamed to output.
81 * This fixes cases when an unstreamable type has streamable private base (#877)
82 * [Details can be found in documentation](configuration.md#catch_config_cpp11_stream_insertable_check)
83
84
85### Other notes:
86* We have added VS 2017 to our CI
87* Work on Catch 2 should start soon
88
89
90
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +010091# 1.8.2
92
93
94### Improvements and minor changes
95* TAP reporter now behaves as if `-s` was always set
96 * This should be more consistent with the protocol desired behaviour.
97* Compact reporter now obeys `-d yes` argument (#780)
98 * The format is "XXX.123 s: <section-name>" (3 decimal places are always present).
99 * Before it did not report the durations at all.
100* XML reporter now behaves the same way as Console reporter in regards to `INFO`
101 * This means it reports `INFO` messages on success, if output on success (`-s`) is enabled.
102 * Previously it only reported `INFO` messages on failure.
103* `CAPTURE(expr)` now stringifies `expr` in the same way assertion macros do (#639)
104* Listeners are now finally [documented](event-listeners.md).
105 * 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.
106
107
108### Fixes:
109* Catch no longer attempts to reconstruct expression that led to a fatal error (#810)
110 * This fixes possible signal/SEH loop when processing expressions, where the signal was triggered by expression decomposition.
111* Fixed (C4265) missing virtual destructor warning in Matchers (#844)
112* `std::string`s are now taken by `const&` everywhere (#842).
113 * Previously some places were taking them by-value.
114* Catch should no longer change errno (#835).
115 * This was caused by libstdc++ bug that we now work around.
116* Catch now provides `FAIL_CHECK( ... )` macro (#765).
117 * Same as `FAIL( ... )`, but does not abort the test.
118* Functions like `fabs`, `tolower`, `memset`, `isalnum` are now used with `std::` qualification (#543).
119* Clara no longer assumes first argument (binary name) is always present (#729)
120 * If it is missing, empty string is used as default.
121* Clara no longer reads 1 character past argument string (#830)
Phil Nash06923172017-03-15 09:04:09 +0000122* Regression in Objective-C bindings (Matchers) fixed (#854)
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +0100123
124
125### Other notes:
126* We have added VS 2013 and 2015 to our CI
127* Catch Classic (1.x.x) now contains its own, forked, version of Clara (the argument parser).
128
129
130
Phil Nash658b5f62017-03-01 16:06:48 +0000131# 1.8.1
132
133### Fixes
134
135Cygwin issue with `gettimeofday` - `#define` was not early enough
136
Phil Nash0952b762017-02-28 14:19:09 +0000137# 1.8.0
138
139### New features/ minor changes
140
141* Matchers have new, simpler (and documented) interface.
142 * Catch provides string and vector matchers.
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +0100143 * For details see [Matchers documentation](matchers.md).
Phil Nash0952b762017-02-28 14:19:09 +0000144* Changed console reporter test duration reporting format (#322)
145 * Old format: `Some simple comparisons between doubles completed in 0.000123s`
146 * New format: `xxx.123s: Some simple comparisons between doubles` _(There will always be exactly 3 decimal places)_
147* Added opt-in leak detection under MSVC + Windows (#439)
148 * Enable it by compiling Catch's main with `CATCH_CONFIG_WINDOWS_CRTDBG`
149* Introduced new compile-time flag, `CATCH_CONFIG_FAST_COMPILE`, trading features for compilation speed.
Martin Hořeňovskýaf1ed702017-03-03 15:03:23 +0100150 * Moves debug breaks out of tests and into implementation, speeding up test compilation time (~10% on linux).
Phil Nash0952b762017-02-28 14:19:09 +0000151 * _More changes are coming_
152* 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.
153 * These are not present in the default single-include header and need to be downloaded from GitHub separately.
Phil Nash417202b2017-03-01 08:22:38 +0000154 * For details see [documentation about integrating with build systems](build-systems.md).
Phil Nash0952b762017-02-28 14:19:09 +0000155* XML reporter now reports filename as part of the `Section` and `TestCase` tags.
156* `Approx` now supports an optional margin of absolute error
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +0100157 * It has also received [new documentation](assertions.md).
Phil Nash0952b762017-02-28 14:19:09 +0000158
159### Fixes
160* Silenced C4312 ("conversion from int to 'ClassName *") warnings in the evaluate layer.
161* Fixed C4512 ("assignment operator could not be generated") warnings under VS2013.
162* Cygwin compatibility fixes
163 * Signal handling is no longer compiled by default.
164 * Usage of `gettimeofday` inside Catch should no longer cause compilation errors.
165* Improved `-Wparentheses` supression for gcc (#674)
166 * When compiled with gcc 4.8 or newer, the supression is localized to assertions only
167 * Otherwise it is supressed for the whole TU
168* Fixed test spec parser issue (with escapes in multiple names)
169
170### Other
171* Various documentation fixes and improvements
172
173
Phil Nashd08cee22017-02-13 16:15:42 +0000174# 1.7.2
175
176### Fixes and minor improvements
177Xml:
178
179(technically the first two are breaking changes but are also fixes and arguably break few if any people)
180* C-escape control characters instead of XML encoding them (which requires XML 1.1)
181* Revert XML output to XML 1.0
182* Can provide stylesheet references by extending the XML reporter
183* Added description and tags attribites to XML Reporter
184* Tags are closed and the stream flushed more eagerly to avoid stdout interpolation
185
186
187Other:
188* `REQUIRE_THROWS_AS` now catches exception by `const&` and reports expected type
189* In `SECTION`s the file/ line is now of the `SECTION`. not the `TEST_CASE`
190* Added std:: qualification to some functions from C stdlib
191* Removed use of RTTI (`dynamic_cast`) that had crept back in
192* Silenced a few more warnings in different circumstances
193* Travis improvements
194
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100195# 1.7.1
196
197### Fixes:
198* Fixed inconsistency in defining `NOMINMAX` and `WIN32_LEAN_AND_MEAN` inside `catch.hpp`.
199* Fixed SEH-related compilation error under older MinGW compilers, by making Windows SEH handling opt-in for compilers other than MSVC.
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +0100200 * For specifics, look into the [documentation](configuration.md).
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100201* Fixed compilation error under MinGW caused by improper compiler detection.
202* Fixed XML reporter sometimes leaving an empty output file when a test ends with signal/structured exception.
203* Fixed XML reporter not reporting captured stdout/stderr.
204* Fixed possible infinite recursion in Windows SEH.
205* Fixed possible compilation error caused by Catch's operator overloads being ambiguous in regards to user-defined templated operators.
206
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100207## 1.7.0
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100208
209### Features/ Changes:
210* Catch now runs significantly faster for passing tests
211 * Microbenchmark focused on Catch's overhead went from ~3.4s to ~0.7s.
212 * Real world test using [JSON for Modern C++](https://github.com/nlohmann/json)'s test suite went from ~6m 25s to ~4m 14s.
213* Catch can now run specific sections within test cases.
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +0100214 * For now the support is only basic (no wildcards or tags), for details see the [documentation](command-line.md).
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100215* Catch now supports SEH on Windows as well as signals on Linux.
216 * After receiving a signal, Catch reports failing assertion and then passes the signal onto the previous handler.
217* Approx can be used to compare values against strong typedefs (available in C++11 mode only).
218 * Strong typedefs mean types that are explicitly convertible to double.
219* CHECK macro no longer stops executing section if an exception happens.
220* Certain characters (space, tab, etc) are now pretty printed.
221 * This means that a `char c = ' '; REQUIRE(c == '\t');` would be printed as `' ' == '\t'`, instead of ` == 9`.
222
223### Fixes:
224* Text formatting no longer attempts to access out-of-bounds characters under certain conditions.
225* THROW family of assertions no longer trigger `-Wunused-value` on expressions containing explicit cast.
226* Breaking into debugger under OS X works again and no longer required `DEBUG` to be defined.
227* Compilation no longer breaks under certain compiler if a lambda is used inside assertion macro.
228
229### Other:
230* Catch's CMakeLists now defines install command.
231* Catch's CMakeLists now generates projects with warnings enabled.
232
233
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100234## 1.6.1
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100235
236### Features/ Changes:
237* Catch now supports breaking into debugger on Linux
238
239### Fixes:
240* Generators no longer leak memory (generators are still unsupported in general)
241* JUnit reporter now reports UTC timestamps, instead of "tbd"
242* `CHECK_THAT` macro is now properly defined as `CATCH_CHECK_THAT` when using `CATCH_` prefixed macros
243
244### Other:
245* Types with overloaded `&&` operator are no longer evaluated twice when used in an assertion macro.
246* The use of `__COUNTER__` is supressed when Catch is parsed by CLion
247 * This change is not active when compiling a binary
248* Approval tests can now be run on Windows
249* CMake will now warn if a file is present in the `include` folder but not is not enumerated as part of the project
250* Catch now defines `NOMINMAX` and `WIN32_LEAN_AND_MEAN` before including `windows.h`
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +0100251 * This can be disabled if needed, see [documentation](configuration.md) for details.
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100252
253
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100254## 1.6.0
Phil Nash3b2f2062017-01-11 16:43:56 +0000255
256### Cmake/ projects:
257* 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.
258
259### Features/ Changes:
Phil Nash1ff0acf2017-01-11 16:50:35 +0000260* Approx now supports `>=` and `<=`
261* Can now use `\` to escape chars in test names on command line
Phil Nash3b2f2062017-01-11 16:43:56 +0000262* Standardize C++11 feature toggles
263
264### Fixes:
265* Blue shell colour
Phil Nash1ff0acf2017-01-11 16:50:35 +0000266* Missing argument to `CATCH_CHECK_THROWS`
Phil Nash3b2f2062017-01-11 16:43:56 +0000267* Don't encode extended ASCII in XML
Phil Nashe6aa1f42017-01-11 17:14:28 +0000268* use `std::shuffle` on more compilers (fixes deprecation warning/error)
Phil Nash1ff0acf2017-01-11 16:50:35 +0000269* Use `__COUNTER__` more consistently (where available)
Phil Nash3b2f2062017-01-11 16:43:56 +0000270
271### Other:
272* Tweaks and changes to scripts - particularly for Approval test - to make them more portable
273
Phil Nash3b2f2062017-01-11 16:43:56 +0000274
Phil Nash0952b762017-02-28 14:19:09 +0000275# Older versions
276Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history
277
Phil Nash3b2f2062017-01-11 16:43:56 +0000278---
279
280[Home](Readme.md)