Release notes
These are the releases of Progmasoft Catch3. Its compatibility engine is based on Catch2 3.16.1; Catch2's own history is in its release notes.
Contents
0.4.0
0.3.0.2
0.3.0.1
0.3.0
0.2.0
0.1.0
0.4.0
Released 2026-11-15.
Versions of Catch3 have three numbers again from this release on:
MAJOR.MINOR.PATCH, as Semantic Versioning writes them.
The Catch3 runner
--coverage=DIRruns every test in a process of its own and keeps what each one reached:DIR/coverage.jsonmaps every test to the lines it ran, andDIR/coverage.lcovis the run combined. It reads LLVM source-based coverage (Clang) and gcov (GCC). See Per-test coverage.- Workers and the processes the runner starts no longer inherit the variables
whose names look like secrets (
TOKEN,SECRET,PASSWORDand the like).--pass-env=NAME, which can be repeated, or"pass-env"in the project configuration hands one to the tests that need it. See Environment variables.
Tools
- The repository tools are C++17 and run through Bazel:
//tools:check,//tools:amalgamate,//tools:version,//tools:release_notes,//tools:repo_infoand//tools:third_party. They replace the Python scripts of earlier releases.
0.3.0.2
Released 2026-11-01.
Mocks
<Progmasoft/Catch3/Mock.hpp>adds mocks of virtual interfaces and of free functions behind a seam:CATCH3_MOCK_METHOD,CATCH3_EXPECT_CALL,SequenceandScopedSeam. Expectations check call counts, arguments and order, and failures go through the same assertions as the rest of a test. See Mocking.
0.3.0.1
Released 2026-11-01.
Versions of Catch3 have four numbers from this release on.
The Catch3 runner
--import=FILEreads the reports of other test frameworks instead of running tests: JUnit, xUnit, TRX, TAP, CTRF, Catch3's own, and a small JSON Lines format for anything else. Their tests get the history, flaky detection, quarantine, analytics and reports of a run.
0.3.0
Released 2026-11-01.
Tags of Catch3 are catch3-<version> from this release on.
Language and license
Catch3 is C++17, and its headers work in C++17 and later. Progmasoft-authored files move to the Progmasoft Linking Exception, Version 2.0; Catch2-derived code keeps the Boost Software License.
The Catch3 runner
Catch3 keeps Catch2's API for writing tests and replaces its session, command line and reporters with a runner of its own:
- Tests run in parallel worker processes; a crash, an exit or a hang ends one test, not the run.
- Failures are retried alone to tell deterministic, flaky and order-dependent failures apart; the test that leaves state behind is found by bisection.
- A history of verdicts and durations drives quarantine, learned time limits, predictive ordering, incremental runs, replay and analytics.
- Tests are selected by change, by past failure or by prediction, and sharded by a stable hash or by recorded duration.
- Tags declare serial and isolated tests, shared resources, dependencies, time limits and retries.
- Every failure gets a category, a signature, an analysis and a replay command.
- Reports are console, JUnit XML, JSON and a Chrome trace;
--list=jsonis a versioned discovery format. - Every test gets a temporary directory of its own.
- A project keeps its options in a
catch3.json, found up to the root of the repository; the command line wins over it, and--config=FILEand--no-configchoose another file or none. - JSON is read and written with yyjson
and JUnit XML is written with pugixml,
both MIT and vendored in
third_party/. They are compiled into Catch3's own translation units with internal linkage or a renamed namespace, so a project that links its own copy of either library is not affected. The amalgamated sources include them from a third file,extras/catch_amalgamated_third_party.hpp.
Breaking changes
- Catch3 has its own build and header names, so that it is never mistaken
for Catch2 and both can be used in one project:
- CMake:
find_package(Catch3)withCatch3::Catch3andCatch3::Catch3WithMain, optionsCATCH3_*, and the scriptsCatch3.cmake(catch3_discover_tests) andCatch3ShardTests.cmake(catch3_add_sharded_tests). TheProgmasoft::Catch3target is gone: its code is part ofCatch3::Catch3. - Bazel
//:catch3and//:catch3_main, Mesoncatch3andcatch3-with-main, pkg-configcatch3.pcandcatch3-with-main.pc. - Headers moved from
catch2/toProgmasoft/Catch3/with Progmasoft names:<catch2/catch_test_macros.hpp>is<Progmasoft/Catch3/TestMacros.hpp>,<catch2/matchers/catch_matchers_string.hpp>is<Progmasoft/Catch3/Matchers/String.hpp>, and so on. Test bodies do not change: the macros and theCatch::namespace keep their names. ParseAndAddCatchTests.cmake, deprecated upstream, was removed.
- CMake:
- Catch2's command line, reporters,
CATCH_REGISTER_REPORTERand listing were removed; see the command line and reports. Listeners keep working. - C++17 is the minimum, for the library and for the code that uses it.
- The results model in
Progmasoft/Catch3/Results.hppwas rewritten around tests and attempts. - Conan packaging was dropped.
Fixes
- The property engine's example database can be written by several processes at once.
0.2.0
Released 2026-09-24.
- Snapshot comparison and update APIs.
- Framework-neutral test result summaries and deterministic JUnit XML.
- The Progmasoft additions are a static library in every supported build system.
0.1.0
Released 2026-09-24.
- The first release: a deterministic property-testing API next to the Catch2-compatible engine.
- Bazel module metadata, and CMake, Meson, Xmake and Premake builds.