blob: 1e69eea5ded54c68837fbbced87c89d2d47db8e7 [file] [log] [blame] [view]
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +01001# 1.8.2
2
3
4### Improvements and minor changes
5* TAP reporter now behaves as if `-s` was always set
6 * This should be more consistent with the protocol desired behaviour.
7* Compact reporter now obeys `-d yes` argument (#780)
8 * The format is "XXX.123 s: <section-name>" (3 decimal places are always present).
9 * Before it did not report the durations at all.
10* XML reporter now behaves the same way as Console reporter in regards to `INFO`
11 * This means it reports `INFO` messages on success, if output on success (`-s`) is enabled.
12 * Previously it only reported `INFO` messages on failure.
13* `CAPTURE(expr)` now stringifies `expr` in the same way assertion macros do (#639)
14* Listeners are now finally [documented](event-listeners.md).
15 * 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.
16
17
18### Fixes:
19* Catch no longer attempts to reconstruct expression that led to a fatal error (#810)
20 * This fixes possible signal/SEH loop when processing expressions, where the signal was triggered by expression decomposition.
21* Fixed (C4265) missing virtual destructor warning in Matchers (#844)
22* `std::string`s are now taken by `const&` everywhere (#842).
23 * Previously some places were taking them by-value.
24* Catch should no longer change errno (#835).
25 * This was caused by libstdc++ bug that we now work around.
26* Catch now provides `FAIL_CHECK( ... )` macro (#765).
27 * Same as `FAIL( ... )`, but does not abort the test.
28* Functions like `fabs`, `tolower`, `memset`, `isalnum` are now used with `std::` qualification (#543).
29* Clara no longer assumes first argument (binary name) is always present (#729)
30 * If it is missing, empty string is used as default.
31* Clara no longer reads 1 character past argument string (#830)
Phil Nash06923172017-03-15 09:04:09 +000032* Regression in Objective-C bindings (Matchers) fixed (#854)
Martin Hořeňovský0c015aa2017-03-13 21:29:30 +010033
34
35### Other notes:
36* We have added VS 2013 and 2015 to our CI
37* Catch Classic (1.x.x) now contains its own, forked, version of Clara (the argument parser).
38
39
40
Phil Nash658b5f62017-03-01 16:06:48 +000041# 1.8.1
42
43### Fixes
44
45Cygwin issue with `gettimeofday` - `#define` was not early enough
46
Phil Nash0952b762017-02-28 14:19:09 +000047# 1.8.0
48
49### New features/ minor changes
50
51* Matchers have new, simpler (and documented) interface.
52 * Catch provides string and vector matchers.
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +010053 * For details see [Matchers documentation](matchers.md).
Phil Nash0952b762017-02-28 14:19:09 +000054* Changed console reporter test duration reporting format (#322)
55 * Old format: `Some simple comparisons between doubles completed in 0.000123s`
56 * New format: `xxx.123s: Some simple comparisons between doubles` _(There will always be exactly 3 decimal places)_
57* Added opt-in leak detection under MSVC + Windows (#439)
58 * Enable it by compiling Catch's main with `CATCH_CONFIG_WINDOWS_CRTDBG`
59* Introduced new compile-time flag, `CATCH_CONFIG_FAST_COMPILE`, trading features for compilation speed.
Martin Hořeňovskýaf1ed702017-03-03 15:03:23 +010060 * Moves debug breaks out of tests and into implementation, speeding up test compilation time (~10% on linux).
Phil Nash0952b762017-02-28 14:19:09 +000061 * _More changes are coming_
62* 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.
63 * 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 +000064 * For details see [documentation about integrating with build systems](build-systems.md).
Phil Nash0952b762017-02-28 14:19:09 +000065* XML reporter now reports filename as part of the `Section` and `TestCase` tags.
66* `Approx` now supports an optional margin of absolute error
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +010067 * It has also received [new documentation](assertions.md).
Phil Nash0952b762017-02-28 14:19:09 +000068
69### Fixes
70* Silenced C4312 ("conversion from int to 'ClassName *") warnings in the evaluate layer.
71* Fixed C4512 ("assignment operator could not be generated") warnings under VS2013.
72* Cygwin compatibility fixes
73 * Signal handling is no longer compiled by default.
74 * Usage of `gettimeofday` inside Catch should no longer cause compilation errors.
75* Improved `-Wparentheses` supression for gcc (#674)
76 * When compiled with gcc 4.8 or newer, the supression is localized to assertions only
77 * Otherwise it is supressed for the whole TU
78* Fixed test spec parser issue (with escapes in multiple names)
79
80### Other
81* Various documentation fixes and improvements
82
83
Phil Nashd08cee22017-02-13 16:15:42 +000084# 1.7.2
85
86### Fixes and minor improvements
87Xml:
88
89(technically the first two are breaking changes but are also fixes and arguably break few if any people)
90* C-escape control characters instead of XML encoding them (which requires XML 1.1)
91* Revert XML output to XML 1.0
92* Can provide stylesheet references by extending the XML reporter
93* Added description and tags attribites to XML Reporter
94* Tags are closed and the stream flushed more eagerly to avoid stdout interpolation
95
96
97Other:
98* `REQUIRE_THROWS_AS` now catches exception by `const&` and reports expected type
99* In `SECTION`s the file/ line is now of the `SECTION`. not the `TEST_CASE`
100* Added std:: qualification to some functions from C stdlib
101* Removed use of RTTI (`dynamic_cast`) that had crept back in
102* Silenced a few more warnings in different circumstances
103* Travis improvements
104
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100105# 1.7.1
106
107### Fixes:
108* Fixed inconsistency in defining `NOMINMAX` and `WIN32_LEAN_AND_MEAN` inside `catch.hpp`.
109* 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 +0100110 * For specifics, look into the [documentation](configuration.md).
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100111* Fixed compilation error under MinGW caused by improper compiler detection.
112* Fixed XML reporter sometimes leaving an empty output file when a test ends with signal/structured exception.
113* Fixed XML reporter not reporting captured stdout/stderr.
114* Fixed possible infinite recursion in Windows SEH.
115* Fixed possible compilation error caused by Catch's operator overloads being ambiguous in regards to user-defined templated operators.
116
Martin Hořeňovský7b8a27e2017-02-07 10:06:52 +0100117## 1.7.0
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100118
119### Features/ Changes:
120* Catch now runs significantly faster for passing tests
121 * Microbenchmark focused on Catch's overhead went from ~3.4s to ~0.7s.
122 * Real world test using [JSON for Modern C++](https://github.com/nlohmann/json)'s test suite went from ~6m 25s to ~4m 14s.
123* Catch can now run specific sections within test cases.
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +0100124 * 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 +0100125* Catch now supports SEH on Windows as well as signals on Linux.
126 * After receiving a signal, Catch reports failing assertion and then passes the signal onto the previous handler.
127* Approx can be used to compare values against strong typedefs (available in C++11 mode only).
128 * Strong typedefs mean types that are explicitly convertible to double.
129* CHECK macro no longer stops executing section if an exception happens.
130* Certain characters (space, tab, etc) are now pretty printed.
131 * This means that a `char c = ' '; REQUIRE(c == '\t');` would be printed as `' ' == '\t'`, instead of ` == 9`.
132
133### Fixes:
134* Text formatting no longer attempts to access out-of-bounds characters under certain conditions.
135* THROW family of assertions no longer trigger `-Wunused-value` on expressions containing explicit cast.
136* Breaking into debugger under OS X works again and no longer required `DEBUG` to be defined.
137* Compilation no longer breaks under certain compiler if a lambda is used inside assertion macro.
138
139### Other:
140* Catch's CMakeLists now defines install command.
141* Catch's CMakeLists now generates projects with warnings enabled.
142
143
Martin Hořeňovskýce37f482017-02-01 21:47:43 +0100144## 1.6.1
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100145
146### Features/ Changes:
147* Catch now supports breaking into debugger on Linux
148
149### Fixes:
150* Generators no longer leak memory (generators are still unsupported in general)
151* JUnit reporter now reports UTC timestamps, instead of "tbd"
152* `CHECK_THAT` macro is now properly defined as `CATCH_CHECK_THAT` when using `CATCH_` prefixed macros
153
154### Other:
155* Types with overloaded `&&` operator are no longer evaluated twice when used in an assertion macro.
156* The use of `__COUNTER__` is supressed when Catch is parsed by CLion
157 * This change is not active when compiling a binary
158* Approval tests can now be run on Windows
159* CMake will now warn if a file is present in the `include` folder but not is not enumerated as part of the project
160* Catch now defines `NOMINMAX` and `WIN32_LEAN_AND_MEAN` before including `windows.h`
Martin Hořeňovský95fc8d62017-03-13 21:31:26 +0100161 * This can be disabled if needed, see [documentation](configuration.md) for details.
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100162
163
Martin Hořeňovský9a566092017-01-20 12:49:59 +0100164## 1.6.0
Phil Nash3b2f2062017-01-11 16:43:56 +0000165
166### Cmake/ projects:
167* 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.
168
169### Features/ Changes:
Phil Nash1ff0acf2017-01-11 16:50:35 +0000170* Approx now supports `>=` and `<=`
171* Can now use `\` to escape chars in test names on command line
Phil Nash3b2f2062017-01-11 16:43:56 +0000172* Standardize C++11 feature toggles
173
174### Fixes:
175* Blue shell colour
Phil Nash1ff0acf2017-01-11 16:50:35 +0000176* Missing argument to `CATCH_CHECK_THROWS`
Phil Nash3b2f2062017-01-11 16:43:56 +0000177* Don't encode extended ASCII in XML
Phil Nashe6aa1f42017-01-11 17:14:28 +0000178* use `std::shuffle` on more compilers (fixes deprecation warning/error)
Phil Nash1ff0acf2017-01-11 16:50:35 +0000179* Use `__COUNTER__` more consistently (where available)
Phil Nash3b2f2062017-01-11 16:43:56 +0000180
181### Other:
182* Tweaks and changes to scripts - particularly for Approval test - to make them more portable
183
Phil Nash3b2f2062017-01-11 16:43:56 +0000184
Phil Nash0952b762017-02-28 14:19:09 +0000185# Older versions
186Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history
187
Phil Nash3b2f2062017-01-11 16:43:56 +0000188---
189
190[Home](Readme.md)