Subject: CVS commit: pkgsrc/devel/catch2
From: Niclas Rosenvik
Date: 2024-01-15 10:33:46
Message id: 20240115093346.7D19BFA42@cvs.NetBSD.org

Log Message:
Update catch2 to version 3.5.1

Pkgsrc-changes:
Catch2 version 3 is API incompatible
with catch2 version 2, the header file names
have changed. Update BUILDLINK_API_DEPENDS
due to this. Catch2 users in pkgsrc will
be updated accordingly.
Install the pkg-config files under
lib/pkgconfig since Catch2 now installs
libraries in libs and the pkg-config
files uses them.
Catch2 is now compiled with C++17 so that
all features are available in the package.
Use cmake/build.mk instead of USE_CMAKE.

Changes from release notes:

3.5.1

Improvements
* Significantly improved performance of the CLI parsing.
  * This includes the cost of preparing the CLI parser,
    so Catch2's binaries start much faster.

Miscellaneous
* Added support for Bazel modules
* Added CMake option to disable the build reproducibility settings
* Added `log` library linking to the Meson build

3.5.0

Improvements
* Introduced `CATCH_CONFIG_PREFIX_MESSAGES` to prefix only logging
  macros
  * This means `INFO`, `UNSCOPED_INFO`, `WARN` and `CAPTURE`.
* Section hints in static analysis mode are now `const`
  * This prevents Clang-Tidy from complaining about
    `misc-const-correctness`.
* `from_range` generator supports C arrays and ranges that require ADL
* Stringification support for `std::optional` now also includes
  `std::nullopt`
* The Console reporter flushes output after writing benchmark runtime
  estimate.
  * This means that you can immediately see for how long the benchmark
    is expected to run.
* Added workaround to enable compilation with ICC 19.1
* Compiling Catch2 for XBox should work out of the box
  * Catch2 should automatically disable getenv when compiled for XBox.
* Compiling Catch2 with exceptions disabled no longer triggers
  `Wunused-function`
* `random` Generators for integral types are now reproducible across
   different platforms
  * Unlike `<random>`, Catch2's generators also support 1 byte integral
    types (`char`, `bool`, ...)
* `random` Generators for `float` and `double` are now reproducible
     across different platform
  * `long double` varies across different platforms too much to be
     reproducible
  * This guarantee applies only to platforms with IEEE 754 floats.

Fixes
* UDL declaration inside Catch2 are now strictly conforming to the
  standard
  * `operator "" _a` is UB, `operator ""_a` is fine. Seriously.
* Fixed `CAPTURE` tests failing to compile in C++23 mode
* Fixed missing include in `catch_message.hpp`
* Fixed `CHECK_ELSE` suppressing failure from uncaught exceptions

Miscellaneous
* The documentation for specifying which tests to run through commandline
  has been completely rewritten
* Fixed installation when building Catch2 with meson
* Fixed `catch_discover_tests` when using custom reporter and `PRE_TEST`
  discovery mode
* `catch_discover_tests` supports multi-config CMake generator in
  `PRE_TEST` discovery mode

3.4.0

Improvements
* `VectorEquals` supports elements that provide only `==` and not `!=`
* Catch2 supports compiling with IAR compiler
* Various small internal performance improvements
* Various small internal compilation time improvements
* XMLReporter now reports location info for INFO and WARN
  * This bumps up the xml format version to 3
* Documented that `SKIP` in generator constructor can be used to handle
  empty generator
* Added experimental static analysis support to `TEST_CASE` and `SECTION`
  macros
  * The two macros are redefined in a way that helps the SA tools reason
    about the possible paths through a test case with sections.
  * The support is controlled by the
    `CATCH_CONFIG_EXPERIMENTAL_STATIC_ANALYSIS_SUPPORT` option and
    autodetects clang-tidy and Coverity.
* `*_THROWS`, `*_THROWS_AS`, etc now suppress warning coming from
  `__attribute__((warn_unused_result))` on GCC
  * Unlike plain `[[nodiscard]]`, this warning is not silenced by
    void cast. WTF GCC?

Fixes
* Fixed `assertionStarting` events being sent after the expr is evaluated
* Errors in `TEST_CASE` tags are now reported nicely

Miscellaneous
* Bunch of improvements to `catch_discover_tests`
  * Added DISCOVERY_MODE option, so the discovery can happen either
    post build or pre-run.
  * Fixed handling of semicolons and backslashes in test names
* meson build can disable building tests
* meson build properly sets meson version 0.54.1 as the minimal supported
  version

3.3.2

Improvements
* Further reduced allocations
  * The compact, console, TAP and XML reporters perform less allocations
    in various cases
  * Removed 1 allocation per entered `SECTION`/`TEST_CASE`.
  * Removed 2 allocations per test case exit, if stdout/stderr is captured
* Improved performance
  * Section tracking is 10%-25% faster than in v3.3.0
  * Assertion handling is 5%-10% faster than in v3.3.0
  * Test case registration is 1%-2% faster than in v3.3.0
  * Tiny speedup for registering listeners
  * Tiny speedup for `CAPTURE`, `TEST_CASE_METHOD`, `METHOD_AS_TEST_CASE`,
    and `TEMPLATE_LIST_TEST_*` macros.
* `Contains`, `RangeEquals` and `UnorderedRangeEquals` matchers now support
   ranges with iterator + sentinel pair
* Added `IsNaN` matcher
  * Unlike `REQUIRE(isnan(x))`, `REQUIRE_THAT(x, IsNaN())`
    shows you the value of `x`.
* Suppressed `declared_but_not_referenced` warning for NVHPC (#2637)

Fixes
* Fixed performance regression in section tracking introduced in v3.3.1
  * Extreme cases would cause the tracking to run about 4x slower
    than in 3.3.0

3.3.1

Improvements
* Reduced allocations and improved performance
  * The exact improvements are dependent on your usage of Catch2.
  * For example running Catch2's SelfTest binary performs 8k less
    allocations.
  * The main improvement comes from smarter handling of `SECTION`s,
    especially sibling `SECTION`s

3.3.0

Improvements

* Added `MessageMatches` exception matcher
* Added `RangeEquals` and `UnorderedRangeEquals` generic range matchers
* Added `SKIP` macro for skipping tests from within the test body
  * All built-in reporters have been extended to handle it properly,
    whether your custom reporter needs changes depends on how it was
    written
  * `skipTest` reporter event **is unrelated** to this, and has been
    deprecated since it has practically no uses
* Restored support for PPC Macs in the break-into-debugger functionality
* Made our warning suppression compatible with CUDA toolkit pre 11.5
* Cleaned out some static analysis complaints

Fixes

* Fixed macro redefinition warning when NVCC was reporting as MSVC
* Fixed throws in generator constructor causing the whole binary to abort
  * Now it just fails the test
* Fixed missing transitive include with libstdc++13

3.2.1

Improvements
* Fix the reworked decomposer to work with older (pre 9) GCC versions
  * **This required more significant changes to properly support C++20,
      there might be bugs.**

3.2.0

Improvements
* Catch2 now compiles on PlayStation
* Added `CATCH_CONFIG_GETENV` compile-time toggle
  * This toggle guards whether Catch2 calls `std::getenv`
    when reading env variables
* Added support for more Bazel test environment variables
  * `TESTBRIDGE_TEST_ONLY` is now supported (#2490)
  * Sharding variables, `TEST_SHARD_INDEX`, `TEST_TOTAL_SHARDS`,
    `TEST_SHARD_STATUS_FILE`, are now all supported
* Bunch of small tweaks and improvements in reporters
  * The TAP and SonarQube reporters output the used test filters
  * The XML reporter now also reports the version of its output format
  * The compact reporter now uses the same summary output as the
    console reporter
* Added support for asserting on types that can only be compared with
  literal 0
  * A canonical example is C++20's `std::*_ordering` types, which cannot
    be compared with an `int` variable, only `0`
  * The support extends to any type with this property, not just the
    ones in stdlib
  * This change imposes 2-3% slowdown on compiling files that are heavy
    on `REQUIRE` and friends
  * **This required significant rewrite of decomposition,
      there might be bugs**
* Simplified internals of matcher related macros
  * This provides about ~2% speed up compiling files that are heavy on
    `REQUIRE_THAT` and friends

Fixes
* Cleaned out some warnings and static analysis issues
  * Suppressed `-Wcomma` warning rarely occurring in templated test cases
  * Constified implementation details in `INFO`
  * Made `MatcherGenericBase` copy constructor const
* Fixed serialization of test filters so the output roundtrips
  * This means that e.g. `./tests/SelfTest "aaa bbb", [approx]` outputs
    `Filters: "aaa bbb",[approx]`

Miscellaneous
* Catch2's build no longer leaks `-ffile-prefix-map` setting  to dependees

3.1.1

Improvements
* Added `Catch::getSeed` function that user code can call to retrieve
  current rng-seed
* Better detection of compiler support for `-ffile-prefix-map`
* Catch2's shared libraries now have `SOVERSION` set

Fixes
* Fixed compilation on Universal Windows Platform
* Fixed compilation on VxWorks
* Fixed compilation on Cygwin
* Remove unused variable in reporter registration
* Fixed some symbol visibility issues with dynamic library on Windows
* Suppressed `-Wuseless-cast` warnings in `REQUIRE_THROWS*` macros
  * This was triggered when the potentially throwing expression
    evaluates to `void`
* Fixed "warning: storage class is not first" with `nvc++`
* Fixed handling of `DL_PATHS` argument to `catch_discover_tests` on MacOS
* Suppressed `*-avoid-c-arrays` clang-tidy warning in `TEMPLATE_TEST_CASE`

Miscellaneous
* Fixed CMake install step for Catch2 build as dynamic library
* Raised minimum CMake version to 3.10
  * Expect the minimum CMake version to increase once more in
    next few releases.
* Added support for building Catch2 with Meson

3.1.0

Improvements
* Improved suppression of `-Wparentheses` for older GCCs
  * Turns out that even GCC 9 does not properly handle
    `_Pragma`s in the C++ frontend.
* Added type constraints onto `random` generator
  * These constraints copy what the standard says for
    the underlying `std::uniform_int_distribution`
* Suppressed -Wunused-variable from nvcc
* Suppressed -Wunused-variable from MinGW
* Added All/Any/NoneTrue range matchers
  * These check that all/any/none of boolean values in a range are true.
* The JUnit reporter now normalizes classnames from C++ namespaces to
  Java-like namespaces
  * This provides better support for other JUnit based tools.
* The Bazel support now understands `BAZEL_TEST` environment variable
  * The `CATCH_CONFIG_BAZEL_SUPPORT` configuration option is also
    still supported.
* Returned support for compiling Catch2 with GCC 5
  * This required removing inherited constructors from Catch2's internals.
  * I recommend updating to a newer GCC anyway.
* `catch_discover_tests` now has a new options for setting library
  load path(s) when running the Catch2 binary

Fixes
* Fixed crash when listing listeners without any registered listeners
* Fixed nvcc compilation error in constructor benchmarking helper
* Catch2's CMakeList supports pre-3.12 CMake again
  * The gain from requiring CMake 3.12 was very minor,
    but y'all should really update to newer CMake

Miscellaneous
* Fixed SelfTest build on MinGW
* The in-repo conan recipe exports the CMake helper
* Added experimental CMake script to showcase using test case
  sharding together with CTest
  * Compared to `catch_discover_tests`, it supports very limited number
    of options and customization
* Added documentation page on best practices when running Catch2 tests
* Catch2 can be built as a dynamic library
  * Note that Catch2 does not have visibility annotations,
    and you are responsible for ensuring correct visibility built
    into the resulting library.

3.0.1

Catch2 now uses statically compiled library as its distribution model.
This also means that to get all of Catch2's functionality in a test file,
you have to include multiple headers.

(Potentially) Breaking changes
* Catch2 now uses statically compiled library as its distribution model
  * Including `catch.hpp` no longer works
* Catch2 now uses C++14 as the minimum support language version
* `ANON_TEST_CASE` has been removed, use `TEST_CASE` with no arguments
  instead
* `--list*` commands no longer have non-zero return code
* `--list-test-names-only` has been removed
  * You should use verbosity-modifiers for `--list-tests` instead
* `--list*` commands are now piped through the reporters
  * The top-level reporter interface provides default implementation
    that works just as the old one
  * XmlReporter outputs a machine-parseable XML
* `TEST_CASE` description support has been removed
  * If the second argument has text outside tags, the text will be ignored.
* Hidden test cases are no longer included just because they don't match an
  exclusion tag
  * Previously, a `TEST_CASE("A", "[.foo]")` would be \ 
included by asking for
    `~[bar]`.
* `PredicateMatcher` is no longer type erased.
  * This means that the type of the provided predicate is part of the
    `PredicateMatcher`'s type
* `SectionInfo` no longer contains section description as a member
  * You can still write `SECTION("ShortName", "Long and wordy \ 
description")`,
    but the description is thrown away
  * The description type now must be a `const char*` or be implicitly
    convertible to it
* The `[!hide]` tag has been removed.
  * Use `[.]` or `[.foo]` instead.
* Lvalues of composed matchers cannot be composed further
* Uses of `REGISTER_TEST_CASE` macro need to be followed by a
  semicolon
  * This does not change `TEST_CASE` and friends in any way
* `IStreamingReporter::IsMulti` member function was removed
  * This is _very_ unlikely to actually affect anyone, as it was
    default-implemented in the interface, and only used internally
* Various classes not designed for user-extension have been made
  final
  * `ListeningReporter` is now `final`
  * Concrete Matchers (e.g. `UnorderedEquals` vector matcher) are
    now `final`
  * All Generators are now `final`
* Matcher namespacing has been redone
  * Matcher types are no longer in deeply nested namespaces
  * Matcher factory functions are no longer brought into `Catch`
    namespace
  * This means that all public-facing matcher-related functionality
    is now in `Catch::Matchers` namespace
* Defining `CATCH_CONFIG_MAIN` will no longer create main in that TU.
  * Link with `libCatch2Main.a`, or the proper CMake/pkg-config target
  * If you want to write custom main, include `catch2/catch_session.hpp`
* `CATCH_CONFIG_EXTERNAL_INTERFACES` has been removed.
  * You should instead include the appropriate headers as needed.
* `CATCH_CONFIG_IMPL` has been removed.
  * The implementation is now compiled into a static library.
* Event Listener interface has changed
  * `TestEventListenerBase` was renamed to `EventListenerBase`
  * `EventListenerBase` now directly derives from `IStreamingReporter`,
    instead of deriving from `StreamingReporterBase`
* `GENERATE` decays its arguments
  * This means that `str` in `auto str = GENERATE("aa", \ 
"bb", "cc");`
    is inferred to `char const*` rather than `const char[2]`.
* `--list-*` flags write their output to file specified by the `-o` flag
* Many changes to reporter interfaces
  * With the exception of the XmlReporter, the outputs of first party
    reporters should remain the same
  * New pair of events were added
  * One obsolete event was removed
  * The base class has been renamed
  * The built-in reporter class hierarchy has been redone
* Catch2 generates a random seed if one hasn't been specified by the user
* The short flag for `--list-tests`, `-l`, has been removed.
  * This is not a commonly used flag and does not need to use up valuable
    single-letter space.
* The short flag for `--list-tags`, `-t`, has been removed.
  * This is not a commonly used flag and does not need to use up valuable
    single-letter space.
* The `--colour` option has been replaced with `--colour-mode` option

Fixes
* The `INFO` macro no longer contains superfluous semicolon
* The `--list*` family of command line flags now return 0 on success
* Various ways of failing a benchmark are now counted and reporter
  properly
* The ULP matcher now handles comparing numbers with different signs
  properly
* Universal ADL-found operators should no longer break decomposition
* Reporter selection is properly case-insensitive
  * Previously it forced lower cased name, which would fail for reporters
    with upper case characters in name
* The cumulative reporter base stores benchmark results alongside
  assertion results
* Catch2's SE handling should no longer interferes with ASan on Windows
* Fixed Windows console colour handling for tests that redirect stdout
* Fixed issue with the `random` generators returning the same value
  over and over again

Other changes
* `CATCH_CONFIG_DISABLE_MATCHERS` no longer exists.
  * If you do not want to use Matchers in a TU, do not include their header.
* `CATCH_CONFIG_ENABLE_CHRONO_STRINGMAKER` no longer exists.
  * `StringMaker` specializations for `<chrono>` are always provided
* Catch2's CMake now provides 2 targets, `Catch2` and `Catch2WithMain`.
  * `Catch2` is the statically compiled implementation by itself
  * `Catch2WithMain` also links in the default main
* Catch2's pkg-config integration also provides 2 packages
  * `catch2` is the statically compiled implementation by itself
  * `catch2-with-main` also links in the default main
* Passing invalid test specifications passed to Catch2 are now
  reported before tests are run, and are a hard error.
* Running 0 tests (e.g. due to empty binary,
  or test spec not matching anything) returns non-0 exit code
  * Flag `--allow-running-no-tests` overrides this behaviour.
  * `NoTests` warning has been removed because it is fully subsumed
     by this change.
* Catch2's compile-time configuration options (`CATCH_CONFIG_FOO`)
  can be set through
  CMake options of the same name
  * They use the same semantics as C++ defines, including the
    `CATCH_CONFIG_NO_FOO` overrides,
    * `-DCATCH_CONFIG_DEFAULT_REPORTER=compact` changes default
      reporter to "compact"
    * `-DCATCH_CONFIG_NO_ANDROID_LOGWRITE=ON` forces android
      logwrite to off
    * `-DCATCH_CONFIG_ANDROID_LOGWRITE=OFF` does nothing
      (the define will not exist)

Files:
RevisionActionfile
1.2modifypkgsrc/devel/catch2/DESCR
1.14modifypkgsrc/devel/catch2/Makefile
1.2modifypkgsrc/devel/catch2/PLIST
1.3modifypkgsrc/devel/catch2/buildlink3.mk
1.14modifypkgsrc/devel/catch2/distinfo