1 <a id="top"></a> 2 3 # Release notes 4 **Contents**<br> 5 [2.7.0](#270)<br> 6 [2.6.1](#261)<br> 7 [2.6.0](#260)<br> 8 [2.5.0](#250)<br> 9 [2.4.2](#242)<br> 10 [2.4.1](#241)<br> 11 [2.4.0](#240)<br> 12 [2.3.0](#230)<br> 13 [2.2.3](#223)<br> 14 [2.2.2](#222)<br> 15 [2.2.1](#221)<br> 16 [2.2.0](#220)<br> 17 [2.1.2](#212)<br> 18 [2.1.1](#211)<br> 19 [2.1.0](#210)<br> 20 [2.0.1](#201)<br> 21 [Older versions](#older-versions)<br> 22 [Even Older versions](#even-older-versions)<br> 23 24 ## 2.7.0 25 26 ### Improvements 27 * `TEMPLATE_PRODUCT_TEST_CASE` now uses the resulting type in the name, instead of the serial number (#1544) 28 * Catch2's single header is now strictly ASCII (#1542) 29 * Added generator for random integral/floating point types 30 * The types are inferred within the `random` helper 31 * Added back RangeGenerator (#1526) 32 * RangeGenerator returns elements within a certain range 33 * Added ChunkGenerator generic transform (#1538) 34 * A ChunkGenerator returns the elements from different generator in chunks of n elements 35 * Added `UNSCOPED_INFO` (#415, #983, #1522) 36 * This is a variant of `INFO` that lives until next assertion/end of the test case. 37 38 39 ### Fixes 40 * All calls to C stdlib functions are now `std::` qualified (#1541) 41 * Code brought in from Clara was also updated. 42 * Running tests will no longer open the specified output file twice (#1545) 43 * This would cause trouble when the file was not a file, but rather a named pipe 44 * Fixes the CLion/Resharper integration with Catch 45 * Fixed `-Wunreachable-code` occuring with (old) ccache+cmake+clang combination (#1540) 46 * Fixed `-Wdefaulted-function-deleted` warning with Clang 8 (#1537) 47 * Catch2's type traits and helpers are now properly namespaced inside `Catch::` (#1548) 48 * Fixed std{out,err} redirection for failing test (#1514, #1525) 49 * Somehow, this bug has been present for well over a year before it was reported 50 51 52 ### Contrib 53 * `ParseAndAddCatchTests` now properly escapes commas in the test name 54 55 56 57 ## 2.6.1 58 59 ### Improvements 60 * The JUnit reporter now also reports random seed (#1520, #1521) 61 62 ### Fixes 63 * The TAP reporter now formats comments with test name properly (#1529) 64 * `CATCH_REQUIRE_THROWS`'s internals were unified with `REQUIRE_THROWS` (#1536) 65 * This fixes a potential `-Wunused-value` warning when used 66 * Fixed a potential segfault when using any of the `--list-*` options (#1533, #1534) 67 68 69 ## 2.6.0 70 71 **With this release the data generator feature is now fully supported.** 72 73 74 ### Improvements 75 * Added `TEMPLATE_PRODUCT_TEST_CASE` (#1454, #1468) 76 * This allows you to easily test various type combinations, see documentation for details 77 * The error message for `&&` and `||` inside assertions has been improved (#1273, #1480) 78 * The error message for chained comparisons inside assertions has been improved (#1481) 79 * Added `StringMaker` specialization for `std::optional` (#1510) 80 * The generator interface has been redone once again (#1516) 81 * It is no longer considered experimental and is fully supported 82 * The new interface supports "Input" generators 83 * The generator documentation has been fully updated 84 * We also added 2 generator examples 85 86 87 ### Fixes 88 * Fixed `-Wredundant-move` on newer Clang (#1474) 89 * Removed unreachable mentions `std::current_exception`, `std::rethrow_exception` in no-exceptions mode (#1462) 90 * This should fix compilation with IAR 91 * Fixed missing `<type_traits>` include (#1494) 92 * Fixed various static analysis warnings 93 * Unrestored stream state in `XmlWriter` (#1489) 94 * Potential division by zero in `estimateClockResolution` (#1490) 95 * Uninitialized member in `RunContext` (#1491) 96 * `SourceLineInfo` move ops are now marked `noexcept` 97 * `CATCH_BREAK_INTO_DEBUGGER` is now always a function 98 * Fix double run of a test case if user asks for a specific section (#1394, #1492) 99 * ANSI colour code output now respects `-o` flag and writes to the file as well (#1502) 100 * Fixed detection of `std::variant` support for compilers other than Clang (#1511) 101 102 103 ### Contrib 104 * `ParseAndAddCatchTests` has learned how to use `DISABLED` CTest property (#1452) 105 * `ParseAndAddCatchTests` now works when there is a whitspace before the test name (#1493) 106 107 108 ### Miscellaneous 109 * We added new issue templates for reporting issues on GitHub 110 * `contributing.md` has been updated to reflect the current test status (#1484) 111 112 113 114 ## 2.5.0 115 116 ### Improvements 117 * Added support for templated tests via `TEMPLATE_TEST_CASE` (#1437) 118 119 120 ### Fixes 121 * Fixed compilation of `PredicateMatcher<const char*>` by removing partial specialization of `MatcherMethod<T*>` 122 * Listeners now implicitly support any verbosity (#1426) 123 * Fixed compilation with Embarcadero builder by introducing `Catch::isnan` polyfill (#1438) 124 * Fixed `CAPTURE` asserting for non-trivial captures (#1436, #1448) 125 126 127 ### Miscellaneous 128 * We should now be providing first party Conan support via https://bintray.com/catchorg/Catch2 (#1443) 129 * Added new section "deprecations and planned changes" to the documentation 130 * It contains summary of what is deprecated and might change with next major version 131 * From this release forward, the released headers should be pgp signed (#430) 132 * KeyID `E29C 46F3 B8A7 5028 6079 3B7D ECC9 C20E 314B 2360` 133 * or https://codingnest.com/files/horenmar-publickey.asc 134 135 136 ## 2.4.2 137 138 ### Improvements 139 * XmlReporter now also outputs the RNG seed that was used in a run (#1404) 140 * `Catch::Session::applyCommandLine` now also accepts `wchar_t` arguments. 141 * However, Catch2 still does not support unicode. 142 * Added `STATIC_REQUIRE` macro (#1356, #1362) 143 * Catch2's singleton's are now cleaned up even if tests are run (#1411) 144 * This is mostly useful as a FP prevention for users who define their own main. 145 * Specifying an invalid reporter via `-r` is now reported sooner (#1351, #1422) 146 147 148 ### Fixes 149 * Stringification no longer assumes that `char` is signed (#1399, #1407) 150 * This caused a `Wtautological-compare` warning. 151 * SFINAE for `operator<<` no longer sees different overload set than the actual insertion (#1403) 152 153 154 ### Contrib 155 * `catch_discover_tests` correctly adds tests with comma in name (#1327, #1409) 156 * Added a new customization point in how the tests are launched to `catch_discover_tests` 157 158 159 ## 2.4.1 160 161 ### Improvements 162 * Added a StringMaker for `std::(w)string_view` (#1375, #1376) 163 * Added a StringMaker for `std::variant` (#1380) 164 * This one is disabled by default to avoid increased compile-time drag 165 * Added detection for cygwin environment without `std::to_string` (#1396, #1397) 166 167 ### Fixes 168 * `UnorderedEqualsMatcher` will no longer accept erroneously accept 169 vectors that share suffix, but are not permutation of the desired vector 170 * Abort after (`-x N`) can no longer be overshot by nested `REQUIRES` and 171 subsequently ignored (#1391, #1392) 172 173 174 ## 2.4.0 175 176 **This release brings two new experimental features, generator support 177 and a `-fno-exceptions` support. Being experimental means that they 178 will not be subject to the usual stability guarantees provided by semver.** 179 180 ### Improvements 181 * Various small runtime performance improvements 182 * `CAPTURE` macro is now variadic 183 * Added `AND_GIVEN` macro (#1360) 184 * Added experimental support for data generators 185 * See [their documentation](generators.md) for details 186 * Added support for compiling and running Catch without exceptions 187 * Doing so limits the functionality somewhat 188 * Look [into the documentation](configuration.md#disablingexceptions) for details 189 190 ### Fixes 191 * Suppressed `-Wnon-virtual-dtor` warnings in Matchers (#1357) 192 * Suppressed `-Wunreachable-code` warnings in floating point matchers (#1350) 193 194 ### CMake 195 * It is now possible to override which Python is used to run Catch's tests (#1365) 196 * Catch now provides infrastructure for adding tests that check compile-time configuration 197 * Catch no longer tries to install itself when used as a subproject (#1373) 198 * Catch2ConfigVersion.cmake is now generated as arch-independent (#1368) 199 * This means that installing Catch from 32-bit machine and copying it to 64-bit one works 200 * This fixes conan installation of Catch 201 202 203 ## 2.3.0 204 205 **This release changes the include paths provided by our CMake and 206 pkg-config integration. The proper include path for the single-header 207 when using one of the above is now `<catch2/catch.hpp>`. This change 208 also necessitated changes to paths inside the repository, so that the 209 single-header version is now at `single_include/catch2/catch.hpp`, rather 210 than `single_include/catch.hpp`.** 211 212 213 214 ### Fixes 215 * Fixed Objective-C++ build 216 * `-Wunused-variable` suppression no longer leaks from Catch's header under Clang 217 * Implementation of the experimental new output capture can now be disabled (#1335) 218 * This allows building Catch2 on platforms that do not provide things like `dup` or `tmpfile`. 219 * The JUnit and XML reporters will no longer skip over successful tests when running without `-s` (#1264, #1267, #1310) 220 * See improvements for more details 221 222 ### Improvements 223 * pkg-config and CMake integration has been rewritten 224 * If you use them, the new include path is `#include <catch2/catch.hpp>` 225 * CMake installation now also installs scripts from `contrib/` 226 * For details see the [new documentation](cmake-integration.md#top) 227 * Reporters now have a new customization point, `ReporterPreferences::shouldReportAllAssertions` 228 * When this is set to `false` and the tests are run without `-s`, passing assertions are not sent to the reporter. 229 * Defaults to `false`. 230 * Added `DYNAMIC_SECTION`, a section variant that constructs its name using stream 231 * This means that you can do `DYNAMIC_SECTION("For X := " << x)`. 232 233 234 ## 2.2.3 235 236 **To fix some of the bugs, some behavior had to change in potentially breaking manner.** 237 **This means that even though this is a patch release, it might not be a drop-in replacement.** 238 239 ### Fixes 240 * Listeners are now called before reporter 241 * This was always documented to be the case, now it actually works that way 242 * Catch's commandline will no longer accept multiple reporters 243 * This was done because multiple reporters never worked properly and broke things in non-obvious ways 244 * **This has potential to be a breaking change** 245 * MinGW is now detected as Windows platform w/o SEH support (#1257) 246 * This means that Catch2 no longer tries to use POSIX signal handling when compiled with MinGW 247 * Fixed potential UB in parsing tags using non-ASCII characters (#1266) 248 * Note that Catch2 still supports only ASCII test names/tags/etc 249 * `TEST_CASE_METHOD` can now be used on classnames containing commas (#1245) 250 * You have to enclose the classname in extra set of parentheses 251 * Fixed insufficient alt stack size for POSIX signal handling (#1225) 252 * Fixed compilation error on Android due to missing `std::to_string` in C++11 mode (#1280) 253 * Fixed the order of user-provided `FALLBACK_STRINGIFIER` in stringification machinery (#1024) 254 * It was intended to be replacement for built-in fallbacks, but it was used _after_ them. 255 * **This has potential to be a breaking change** 256 * Fixed compilation error when a type has an `operator<<` with templated lhs (#1285, #1306) 257 258 ### Improvements 259 * Added a new, experimental, output capture (#1243) 260 * This capture can also redirect output written via C apis, e.g. `printf` 261 * To opt-in, define `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` in the implementation file 262 * Added a new fallback stringifier for classes derived from `std::exception` 263 * Both `StringMaker` specialization and `operator<<` overload are given priority 264 265 ### Miscellaneous 266 * `contrib/` now contains dbg scripts that skip over Catch's internals (#904, #1283) 267 * `gdbinit` for gdb `lldbinit` for lldb 268 * `CatchAddTests.cmake` no longer strips whitespace from tests (#1265, #1281) 269 * Online documentation now describes `--use-colour` option (#1263) 270 271 272 ## 2.2.2 273 274 ### Fixes 275 * Fixed bug in `WithinAbs::match()` failing spuriously (#1228) 276 * Fixed clang-tidy diagnostic about virtual call in destructor (#1226) 277 * Reduced the number of GCC warnings suppression leaking out of the header (#1090, #1091) 278 * Only `-Wparentheses` should be leaking now 279 * Added upper bound on the time benchmark timer calibration is allowed to take (#1237) 280 * On platforms where `std::chrono::high_resolution_clock`'s resolution is low, the calibration would appear stuck 281 * Fixed compilation error when stringifying static arrays of `unsigned char`s (#1238) 282 283 ### Improvements 284 * XML encoder now hex-encodes invalid UTF-8 sequences (#1207) 285 * This affects xml and junit reporters 286 * 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. 287 * CLR objects (`T^`) can now be stringified (#1216) 288 * This affects code compiled as C++/CLI 289 * Added `PredicateMatcher`, a matcher that takes an arbitrary predicate function (#1236) 290 * See [documentation for details](https://github.com/catchorg/Catch2/blob/master/docs/matchers.md) 291 292 ### Others 293 * Modified CMake-installed pkg-config to allow `#include <catch.hpp>`(#1239) 294 * The plans to standardize on `#include <catch2/catch.hpp>` are still in effect 295 296 297 ## 2.2.1 298 299 ### Fixes 300 * Fixed compilation error when compiling Catch2 with `std=c++17` against libc++ (#1214) 301 * Clara (Catch2's CLI parsing library) used `std::optional` without including it explicitly 302 * Fixed Catch2 return code always being 0 (#1215) 303 * In the words of STL, "We feel superbad about letting this in" 304 305 306 ## 2.2.0 307 308 ### Fixes 309 * Hidden tests are not listed by default when listing tests (#1175) 310 * This makes `catch_discover_tests` CMake script work better 311 * Fixed regression that meant `<windows.h>` could potentially not be included properly (#1197) 312 * Fixed installing `Catch2ConfigVersion.cmake` when Catch2 is a subproject. 313 314 ### Improvements 315 * Added an option to warn (+ exit with error) when no tests were ran (#1158) 316 * Use as `-w NoTests` 317 * Added provisional support for Emscripten (#1114) 318 * [Added a way to override the fallback stringifier](https://github.com/catchorg/Catch2/blob/master/docs/configuration.md#fallback-stringifier) (#1024) 319 * This allows project's own stringification machinery to be easily reused for Catch 320 * `Catch::Session::run()` now accepts `char const * const *`, allowing it to accept array of string literals (#1031, #1178) 321 * The embedded version of Clara was bumped to v1.1.3 322 * Various minor performance improvements 323 * Added support for DJGPP DOS crosscompiler (#1206) 324 325 326 ## 2.1.2 327 328 ### Fixes 329 * Fixed compilation error with `-fno-rtti` (#1165) 330 * Fixed NoAssertion warnings 331 * `operator<<` is used before range-based stringification (#1172) 332 * Fixed `-Wpedantic` warnings (extra semicolons and binary literals) (#1173) 333 334 335 ### Improvements 336 * Added `CATCH_VERSION_{MAJOR,MINOR,PATCH}` macros (#1131) 337 * Added `BrightYellow` colour for use in reporters (#979) 338 * It is also used by ConsoleReporter for reconstructed expressions 339 340 ### Other changes 341 * Catch is now exported as a CMake package and linkable target (#1170) 342 343 ## 2.1.1 344 345 ### Improvements 346 * Static arrays are now properly stringified like ranges across MSVC/GCC/Clang 347 * Embedded newer version of Clara -- v1.1.1 348 * This should fix some warnings dragged in from Clara 349 * MSVC's CLR exceptions are supported 350 351 352 ### Fixes 353 * Fixed compilation when comparison operators do not return bool (#1147) 354 * Fixed CLR exceptions blowing up the executable during translation (#1138) 355 356 357 ### Other changes 358 * Many CMake changes 359 * `NO_SELFTEST` option is deprecated, use `BUILD_TESTING` instead. 360 * Catch specific CMake options were prefixed with `CATCH_` for namespacing purposes 361 * Other changes to simplify Catch2's packaging 362 363 364 365 ## 2.1.0 366 367 ### Improvements 368 * Various performance improvements 369 * On top of the performance regression fixes 370 * Experimental support for PCH was added (#1061) 371 * `CATCH_CONFIG_EXTERNAL_INTERFACES` now brings in declarations of Console, Compact, XML and JUnit reporters 372 * `MatcherBase` no longer has a pointless second template argument 373 * Reduced the number of warning suppressions that leak into user's code 374 * Bugs in g++ 4.x and 5.x mean that some of them have to be left in 375 376 377 ### Fixes 378 * Fixed performance regression from Catch classic 379 * One of the performance improvement patches for Catch classic was not applied to Catch2 380 * Fixed platform detection for iOS (#1084) 381 * Fixed compilation when `g++` is used together with `libc++` (#1110) 382 * Fixed TeamCity reporter compilation with the single header version 383 * To fix the underlying issue we will be versioning reporters in single_include folder per release 384 * The XML reporter will now report `WARN` messages even when not used with `-s` 385 * Fixed compilation when `VectorContains` matcher was combined using `&&` (#1092) 386 * Fixed test duration overflowing after 10 seconds (#1125, #1129) 387 * Fixed `std::uncaught_exception` deprecation warning (#1124) 388 389 390 ### New features 391 * New Matchers 392 * Regex matcher for strings, `Matches`. 393 * Set-equal matcher for vectors, `UnorderedEquals` 394 * Floating point matchers, `WithinAbs` and `WithinULP`. 395 * Stringification now attempts to decompose all containers (#606) 396 * Containers are objects that respond to ADL `begin(T)` and `end(T)`. 397 398 399 ### Other changes 400 * Reporters will now be versioned in the `single_include` folder to ensure their compatibility with the last released version 401 402 403 404 405 ## 2.0.1 406 407 ### Breaking changes 408 * Removed C++98 support 409 * Removed legacy reporter support 410 * Removed legacy generator support 411 * Generator support will come back later, reworked 412 * Removed `Catch::toString` support 413 * The new stringification machinery uses `Catch::StringMaker` specializations first and `operator<<` overloads second. 414 * Removed legacy `SCOPED_MSG` and `SCOPED_INFO` macros 415 * Removed `INTERNAL_CATCH_REGISTER_REPORTER` 416 * `CATCH_REGISTER_REPORTER` should be used to register reporters 417 * Removed legacy `[hide]` tag 418 * `[.]`, `[.foo]` and `[!hide]` are still supported 419 * Output into debugger is now colourized 420 * `*_THROWS_AS(expr, exception_type)` now unconditionally appends `const&` to the exception type. 421 * `CATCH_CONFIG_FAST_COMPILE` now affects the `CHECK_` family of assertions as well as `REQUIRE_` family of assertions 422 * 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. 423 * Removed deprecated matcher utility functions `Not`, `AllOf` and `AnyOf`. 424 * They are superseded by operators `!`, `&&` and `||`, which are natural and do not have limited arity 425 * Removed support for non-const comparison operators 426 * Non-const comparison operators are an abomination that should not exist 427 * They were breaking support for comparing function to function pointer 428 * `std::pair` and `std::tuple` are no longer stringified by default 429 * This is done to avoid dragging in `<tuple>` and `<utility>` headers in common path 430 * Their stringification can be enabled per-file via new configuration macros 431 * `Approx` is subtly different and hopefully behaves more as users would expect 432 * `Approx::scale` defaults to `0.0` 433 * `Approx::epsilon` no longer applies to the larger of the two compared values, but only to the `Approx`'s value 434 * `INFINITY == Approx(INFINITY)` returns true 435 436 437 ### Improvements 438 * Reporters and Listeners can be defined in files different from the main file 439 * The file has to define `CATCH_CONFIG_EXTERNAL_INTERFACES` before including catch.hpp. 440 * Errors that happen during set up before main are now caught and properly reported once main is entered 441 * If you are providing your own main, you can access and use these as well. 442 * New assertion macros, *_THROWS_MATCHES(expr, exception_type, matcher) are provided 443 * As the arguments suggest, these allow you to assert that an expression throws desired type of exception and pass the exception to a matcher. 444 * JUnit reporter no longer has significantly different output for test cases with and without sections 445 * Most assertions now support expressions containing commas (ie `REQUIRE(foo() == std::vector<int>{1, 2, 3});`) 446 * Catch now contains experimental micro benchmarking support 447 * See `projects/SelfTest/Benchmark.tests.cpp` for examples 448 * The support being experiment means that it can be changed without prior notice 449 * Catch uses new CLI parsing library (Clara) 450 * Users can now easily add new command line options to the final executable 451 * This also leads to some changes in `Catch::Session` interface 452 * All parts of matchers can be removed from a TU by defining `CATCH_CONFIG_DISABLE_MATCHERS` 453 * This can be used to somewhat speed up compilation times 454 * An experimental implementation of `CATCH_CONFIG_DISABLE` has been added 455 * Inspired by Doctest's `DOCTEST_CONFIG_DISABLE` 456 * Useful for implementing tests in source files 457 * ie for functions in anonymous namespaces 458 * Removes all assertions 459 * Prevents `TEST_CASE` registrations 460 * Exception translators are not registered 461 * Reporters are not registered 462 * Listeners are not registered 463 * Reporters/Listeners are now notified of fatal errors 464 * This means specific signals or structured exceptions 465 * The Reporter/Listener interface provides default, empty, implementation to preserve backward compatibility 466 * Stringification of `std::chrono::duration` and `std::chrono::time_point` is now supported 467 * Needs to be enabled by a per-file compile time configuration option 468 * Add `pkg-config` support to CMake install command 469 470 471 ### Fixes 472 * Don't use console colour if running in XCode 473 * Explicit constructor in reporter base class 474 * Swept out `-Wweak-vtables`, `-Wexit-time-destructors`, `-Wglobal-constructors` warnings 475 * Compilation for Universal Windows Platform (UWP) is supported 476 * SEH handling and colorized output are disabled when compiling for UWP 477 * Implemented a workaround for `std::uncaught_exception` issues in libcxxrt 478 * These issues caused incorrect section traversals 479 * The workaround is only partial, user's test can still trigger the issue by using `throw;` to rethrow an exception 480 * Suppressed C4061 warning under MSVC 481 482 483 ### Internal changes 484 * The development version now uses .cpp files instead of header files containing implementation. 485 * This makes partial rebuilds much faster during development 486 * The expression decomposition layer has been rewritten 487 * The evaluation layer has been rewritten 488 * New library (TextFlow) is used for formatting text to output 489 490 491 ## Older versions 492 493 ### 1.12.x 494 495 #### 1.12.2 496 ##### Fixes 497 * Fixed missing <cassert> include 498 499 #### 1.12.1 500 501 ##### Fixes 502 * Fixed deprecation warning in `ScopedMessage::~ScopedMessage` 503 * All uses of `min` or `max` identifiers are now wrapped in parentheses 504 * This avoids problems when Windows headers define `min` and `max` macros 505 506 #### 1.12.0 507 508 ##### Fixes 509 * Fixed compilation for strict C++98 mode (ie not gnu++98) and older compilers (#1103) 510 * `INFO` messages are included in the `xml` reporter output even without `-s` specified. 511 512 513 ### 1.11.x 514 515 #### 1.11.0 516 517 ##### Fixes 518 * The original expression in `REQUIRE_FALSE( expr )` is now reporter properly as `!( expr )` (#1051) 519 * Previously the parentheses were missing and `x != y` would be expanded as `!x != x` 520 * `Approx::Margin` is now inclusive (#952) 521 * Previously it was meant and documented as inclusive, but the check itself wasn't 522 * This means that `REQUIRE( 0.25f == Approx( 0.0f ).margin( 0.25f ) )` passes, instead of fails 523 * `RandomNumberGenerator::result_type` is now unsigned (#1050) 524 525 ##### Improvements 526 * `__JETBRAINS_IDE__` macro handling is now CLion version specific (#1017) 527 * When CLion 2017.3 or newer is detected, `__COUNTER__` is used instead of 528 * TeamCity reporter now explicitly flushes output stream after each report (#1057) 529 * On some platforms, output from redirected streams would show up only after the tests finished running 530 * `ParseAndAddCatchTests` now can add test files as dependency to CMake configuration 531 * This means you do not have to manually rerun CMake configuration step to detect new tests 532 533 ### 1.10.x 534 535 #### 1.10.0 536 537 ##### Fixes 538 * Evaluation layer has been rewritten (backported from Catch 2) 539 * The new layer is much simpler and fixes some issues (#981) 540 * Implemented workaround for VS 2017 raw string literal stringification bug (#995) 541 * Fixed interaction between `[!shouldfail]` and `[!mayfail]` tags and sections 542 * Previously sections with failing assertions would be marked as failed, not failed-but-ok 543 544 ##### Improvements 545 * Added [libidentify](https://github.com/janwilmans/LibIdentify) support 546 * Added "wait-for-keypress" option 547 548 ### 1.9.x 549 550 #### 1.9.6 551 552 ##### Improvements 553 * Catch's runtime overhead has been significantly decreased (#937, #939) 554 * Added `--list-extra-info` cli option (#934). 555 * It lists all tests together with extra information, ie filename, line number and description. 556 557 558 559 #### 1.9.5 560 561 ##### Fixes 562 * Truthy expressions are now reconstructed properly, not as booleans (#914) 563 * 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) 564 * Catch no longer fails to link when main is compiled as C++, but linked against Objective-C (#855) 565 * Fixed incorrect gcc version detection when deciding to use `__COUNTER__` (#928) 566 * Previously any GCC with minor version less than 3 would be incorrectly classified as not supporting `__COUNTER__`. 567 * Suppressed C4996 warning caused by upcoming updated to MSVC 2017, marking `std::uncaught_exception` as deprecated. (#927) 568 569 ##### Improvements 570 * CMake integration script now incorporates debug messages and registers tests in an improved way (#911) 571 * Various documentation improvements 572 573 574 575 #### 1.9.4 576 577 ##### Fixes 578 * `CATCH_FAIL` macro no longer causes compilation error without variadic macro support 579 * `INFO` messages are no longer cleared after being reported once 580 581 ##### Improvements and minor changes 582 * Catch now uses `wmain` when compiled under Windows and `UNICODE` is defined. 583 * Note that Catch still officially supports only ASCII 584 585 #### 1.9.3 586 587 ##### Fixes 588 * Completed the fix for (lack of) uint64_t in earlier Visual Studios 589 590 #### 1.9.2 591 592 ##### Improvements and minor changes 593 * All of `Approx`'s member functions now accept strong typedefs in C++11 mode (#888) 594 * Previously `Approx::scale`, `Approx::epsilon`, `Approx::margin` and `Approx::operator()` didn't. 595 596 597 ##### Fixes 598 * POSIX signals are now disabled by default under QNX (#889) 599 * QNX does not support current enough (2001) POSIX specification 600 * JUnit no longer counts exceptions as failures if given test case is marked as ok to fail. 601 * `Catch::Option` should now have its storage properly aligned. 602 * Catch no longer attempts to define `uint64_t` on windows (#862) 603 * This was causing trouble when compiled under Cygwin 604 605 ##### Other 606 * Catch is now compiled under MSVC 2017 using `std:c++latest` (C++17 mode) in CI 607 * We now provide cmake script that autoregisters Catch tests into ctest. 608 * See `contrib` folder. 609 610 611 #### 1.9.1 612 613 ##### Fixes 614 * Unexpected exceptions are no longer ignored by default (#885, #887) 615 616 617 #### 1.9.0 618 619 620 ##### Improvements and minor changes 621 * Catch no longer attempts to ensure the exception type passed by user in `REQUIRE_THROWS_AS` is a constant reference. 622 * It was causing trouble when `REQUIRE_THROWS_AS` was used inside templated functions 623 * This actually reverts changes made in v1.7.2 624 * Catch's `Version` struct should no longer be double freed when multiple instances of Catch tests are loaded into single program (#858) 625 * It is now a static variable in an inline function instead of being an `extern`ed struct. 626 * Attempt to register invalid tag or tag alias now throws instead of calling `exit()`. 627 * Because this happen before entering main, it still aborts execution 628 * Further improvements to this are coming 629 * `CATCH_CONFIG_FAST_COMPILE` now speeds-up compilation of `REQUIRE*` assertions by further ~15%. 630 * The trade-off is disabling translation of unexpected exceptions into text. 631 * When Catch is compiled using C++11, `Approx` is now constructible with anything that can be explicitly converted to `double`. 632 * Captured messages are now printed on unexpected exceptions 633 634 ##### Fixes: 635 * Clang's `-Wexit-time-destructors` should be suppressed for Catch's internals 636 * GCC's `-Wparentheses` is now suppressed for all TU's that include `catch.hpp`. 637 * 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. 638 * You can now tell Catch to use C++11-based check when checking whether a type can be streamed to output. 639 * This fixes cases when an unstreamable type has streamable private base (#877) 640 * [Details can be found in documentation](configuration.md#catch_config_cpp11_stream_insertable_check) 641 642 643 ##### Other notes: 644 * We have added VS 2017 to our CI 645 * Work on Catch 2 should start soon 646 647 648 649 ### 1.8.x 650 651 #### 1.8.2 652 653 654 ##### Improvements and minor changes 655 * TAP reporter now behaves as if `-s` was always set 656 * This should be more consistent with the protocol desired behaviour. 657 * Compact reporter now obeys `-d yes` argument (#780) 658 * The format is "XXX.123 s: <section-name>" (3 decimal places are always present). 659 * Before it did not report the durations at all. 660 * XML reporter now behaves the same way as Console reporter in regards to `INFO` 661 * This means it reports `INFO` messages on success, if output on success (`-s`) is enabled. 662 * Previously it only reported `INFO` messages on failure. 663 * `CAPTURE(expr)` now stringifies `expr` in the same way assertion macros do (#639) 664 * Listeners are now finally [documented](event-listeners.md#top). 665 * 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. 666 667 668 ##### Fixes: 669 * Catch no longer attempts to reconstruct expression that led to a fatal error (#810) 670 * This fixes possible signal/SEH loop when processing expressions, where the signal was triggered by expression decomposition. 671 * Fixed (C4265) missing virtual destructor warning in Matchers (#844) 672 * `std::string`s are now taken by `const&` everywhere (#842). 673 * Previously some places were taking them by-value. 674 * Catch should no longer change errno (#835). 675 * This was caused by libstdc++ bug that we now work around. 676 * Catch now provides `FAIL_CHECK( ... )` macro (#765). 677 * Same as `FAIL( ... )`, but does not abort the test. 678 * Functions like `fabs`, `tolower`, `memset`, `isalnum` are now used with `std::` qualification (#543). 679 * Clara no longer assumes first argument (binary name) is always present (#729) 680 * If it is missing, empty string is used as default. 681 * Clara no longer reads 1 character past argument string (#830) 682 * Regression in Objective-C bindings (Matchers) fixed (#854) 683 684 685 ##### Other notes: 686 * We have added VS 2013 and 2015 to our CI 687 * Catch Classic (1.x.x) now contains its own, forked, version of Clara (the argument parser). 688 689 690 691 #### 1.8.1 692 693 ##### Fixes 694 695 Cygwin issue with `gettimeofday` - `#define` was not early enough 696 697 #### 1.8.0 698 699 ##### New features/ minor changes 700 701 * Matchers have new, simpler (and documented) interface. 702 * Catch provides string and vector matchers. 703 * For details see [Matchers documentation](matchers.md#top). 704 * Changed console reporter test duration reporting format (#322) 705 * Old format: `Some simple comparisons between doubles completed in 0.000123s` 706 * New format: `xxx.123s: Some simple comparisons between doubles` _(There will always be exactly 3 decimal places)_ 707 * Added opt-in leak detection under MSVC + Windows (#439) 708 * Enable it by compiling Catch's main with `CATCH_CONFIG_WINDOWS_CRTDBG` 709 * Introduced new compile-time flag, `CATCH_CONFIG_FAST_COMPILE`, trading features for compilation speed. 710 * Moves debug breaks out of tests and into implementation, speeding up test compilation time (~10% on linux). 711 * _More changes are coming_ 712 * 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. 713 * These are not present in the default single-include header and need to be downloaded from GitHub separately. 714 * For details see [documentation about integrating with build systems](build-systems.md#top). 715 * XML reporter now reports filename as part of the `Section` and `TestCase` tags. 716 * `Approx` now supports an optional margin of absolute error 717 * It has also received [new documentation](assertions.md#top). 718 719 ##### Fixes 720 * Silenced C4312 ("conversion from int to 'ClassName *") warnings in the evaluate layer. 721 * Fixed C4512 ("assignment operator could not be generated") warnings under VS2013. 722 * Cygwin compatibility fixes 723 * Signal handling is no longer compiled by default. 724 * Usage of `gettimeofday` inside Catch should no longer cause compilation errors. 725 * Improved `-Wparentheses` suppression for gcc (#674) 726 * When compiled with gcc 4.8 or newer, the suppression is localized to assertions only 727 * Otherwise it is supressed for the whole TU 728 * Fixed test spec parser issue (with escapes in multiple names) 729 730 ##### Other 731 * Various documentation fixes and improvements 732 733 734 ### 1.7.x 735 736 #### 1.7.2 737 738 ##### Fixes and minor improvements 739 Xml: 740 741 (technically the first two are breaking changes but are also fixes and arguably break few if any people) 742 * C-escape control characters instead of XML encoding them (which requires XML 1.1) 743 * Revert XML output to XML 1.0 744 * Can provide stylesheet references by extending the XML reporter 745 * Added description and tags attributes to XML Reporter 746 * Tags are closed and the stream flushed more eagerly to avoid stdout interpolation 747 748 749 Other: 750 * `REQUIRE_THROWS_AS` now catches exception by `const&` and reports expected type 751 * In `SECTION`s the file/ line is now of the `SECTION`. not the `TEST_CASE` 752 * Added std:: qualification to some functions from C stdlib 753 * Removed use of RTTI (`dynamic_cast`) that had crept back in 754 * Silenced a few more warnings in different circumstances 755 * Travis improvements 756 757 #### 1.7.1 758 759 ##### Fixes: 760 * Fixed inconsistency in defining `NOMINMAX` and `WIN32_LEAN_AND_MEAN` inside `catch.hpp`. 761 * Fixed SEH-related compilation error under older MinGW compilers, by making Windows SEH handling opt-in for compilers other than MSVC. 762 * For specifics, look into the [documentation](configuration.md#top). 763 * Fixed compilation error under MinGW caused by improper compiler detection. 764 * Fixed XML reporter sometimes leaving an empty output file when a test ends with signal/structured exception. 765 * Fixed XML reporter not reporting captured stdout/stderr. 766 * Fixed possible infinite recursion in Windows SEH. 767 * Fixed possible compilation error caused by Catch's operator overloads being ambiguous in regards to user-defined templated operators. 768 769 #### 1.7.0 770 771 ##### Features/ Changes: 772 * Catch now runs significantly faster for passing tests 773 * Microbenchmark focused on Catch's overhead went from ~3.4s to ~0.7s. 774 * Real world test using [JSON for Modern C++](https://github.com/nlohmann/json)'s test suite went from ~6m 25s to ~4m 14s. 775 * Catch can now run specific sections within test cases. 776 * For now the support is only basic (no wildcards or tags), for details see the [documentation](command-line.md#top). 777 * Catch now supports SEH on Windows as well as signals on Linux. 778 * After receiving a signal, Catch reports failing assertion and then passes the signal onto the previous handler. 779 * Approx can be used to compare values against strong typedefs (available in C++11 mode only). 780 * Strong typedefs mean types that are explicitly convertible to double. 781 * CHECK macro no longer stops executing section if an exception happens. 782 * Certain characters (space, tab, etc) are now pretty printed. 783 * This means that a `char c = ' '; REQUIRE(c == '\t');` would be printed as `' ' == '\t'`, instead of ` == 9`. 784 785 ##### Fixes: 786 * Text formatting no longer attempts to access out-of-bounds characters under certain conditions. 787 * THROW family of assertions no longer trigger `-Wunused-value` on expressions containing explicit cast. 788 * Breaking into debugger under OS X works again and no longer required `DEBUG` to be defined. 789 * Compilation no longer breaks under certain compiler if a lambda is used inside assertion macro. 790 791 ##### Other: 792 * Catch's CMakeLists now defines install command. 793 * Catch's CMakeLists now generates projects with warnings enabled. 794 795 796 ### 1.6.x 797 798 #### 1.6.1 799 800 ##### Features/ Changes: 801 * Catch now supports breaking into debugger on Linux 802 803 ##### Fixes: 804 * Generators no longer leak memory (generators are still unsupported in general) 805 * JUnit reporter now reports UTC timestamps, instead of "tbd" 806 * `CHECK_THAT` macro is now properly defined as `CATCH_CHECK_THAT` when using `CATCH_` prefixed macros 807 808 ##### Other: 809 * Types with overloaded `&&` operator are no longer evaluated twice when used in an assertion macro. 810 * The use of `__COUNTER__` is supressed when Catch is parsed by CLion 811 * This change is not active when compiling a binary 812 * Approval tests can now be run on Windows 813 * CMake will now warn if a file is present in the `include` folder but not is not enumerated as part of the project 814 * Catch now defines `NOMINMAX` and `WIN32_LEAN_AND_MEAN` before including `windows.h` 815 * This can be disabled if needed, see [documentation](configuration.md#top) for details. 816 817 818 #### 1.6.0 819 820 ##### Cmake/ projects: 821 * 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. 822 823 ##### Features/ Changes: 824 * Approx now supports `>=` and `<=` 825 * Can now use `\` to escape chars in test names on command line 826 * Standardize C++11 feature toggles 827 828 ##### Fixes: 829 * Blue shell colour 830 * Missing argument to `CATCH_CHECK_THROWS` 831 * Don't encode extended ASCII in XML 832 * use `std::shuffle` on more compilers (fixes deprecation warning/error) 833 * Use `__COUNTER__` more consistently (where available) 834 835 ##### Other: 836 * Tweaks and changes to scripts - particularly for Approval test - to make them more portable 837 838 839 ## Even Older versions 840 Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history 841 842 --- 843 844 [Home](Readme.md#top) 845
