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