Replace Catch2's runner with the Catch3 runner

Catch3 keeps Catch2's API for writing tests (test cases, sections,
assertions, matchers, generators, listeners, benchmarks) and replaces its
session, command line and reporters with a runner of its own.

The runner starts the test binary again as worker processes that take the
next test when they are free. A crash, an exit or a hang ends one test, not
the run. On top of that it adds:

- retries that tell deterministic, flaky and order-dependent failures
  apart, and a bisection that names the test leaving state behind;
- a history of verdicts and durations, kept under a file lock, that drives
  automatic quarantine, adaptive time limits, predictive ordering,
  incremental runs, failure replay and analytics;
- selection by change, past failure or prediction, dependency closure,
  and sharding by a stable hash or by recorded durations;
- tags for serial and isolated tests, shared resources, dependencies,
  time limits and retries;
- a failure category, a signature, an analysis and a replay command for
  every failure;
- console, JUnit XML (with flakyFailure and rerunFailure), JSON and Chrome
  trace reports, and a versioned discovery listing (--list=json);
- a temporary directory per test (TMPDIR, TMP, TEMP and
  TestTemporaryDirectory());
- Bazel's test environment: XML output file, test filter, sharding, seed,
  premature exit file and undeclared outputs.

The command line is parsed by a hand-written, typed parser. Catch::Session
remains as a thin facade over the runner for custom main functions.

The result model in Progmasoft/Catch3/Results.hpp was rewritten around
tests and attempts, and the JUnit writer now writes it. The property
engine's example database is updated under a file lock with an atomic
rename, so parallel workers can write it at the same time.

Removed: Clara, the command-line and reporter-spec parsers, every reporter
and CATCH_REGISTER_REPORTER, listing, text flow, console colour and width,
the JSON and XML writers, sharding in the test registry, approval tests and
their baselines, Conan packaging, and the unused third_party/clara.hpp.
Listeners keep working; reporters' list and skip events are gone.

The Catch2 library is now compiled as C++20; code that includes only
Catch2's headers still needs C++14. Duplicate test cases are still refused
at start-up. Version 0.3.0.

ExtraTests now turn exceptions off for clang-cl with MSVC-style options,
which -fno-exceptions did not do.

1 files changed, 53 insertions, 1 deletions

diff --git a/tools/scripts/generateAmalgamatedFiles.py b/tools/scripts/generateAmalgamatedFiles.py
index e3e86aab..5fed3358 100755
--- a/tools/scripts/generateAmalgamatedFiles.py
+++ b/tools/scripts/generateAmalgamatedFiles.py
@@ -44,6 +44,10 @@ file_header = '''\
 //  ----------------------------------------------------------
 //  This file is an amalgamation of multiple different files.
 //  You probably shouldn't edit it directly.
+//
+//  The parts that come from src/Progmasoft, the Catch3 runner, keep
+//  their own copyright and license lines (MPL-2.0 WITH
+//  AdditionRef-Progmasoft-Exception-1.1). The runner needs C++20.
 //  ----------------------------------------------------------
 '''
 
@@ -68,6 +72,9 @@ def concatenate_file(out, filename: str, expand_headers: bool) -> int:
             if line in copyright_lines:
                 continue
             m = internal_include_parser.match(line)
+            # The runner's headers are expanded at the start of the .cpp file.
+            if not m and not expand_headers and progmasoft_include_parser.match(line):
+                continue
             # anything that isn't a Catch2 header can just be copied to
             # the resulting file
             if not m:
@@ -112,16 +119,61 @@ def generate_header():
         print('Concatenated {} headers'.format(concatenate_file(header, starting_header, True)))
         header.write('#endif // CATCH_AMALGAMATED_HPP_INCLUDED\n')
 
+# The runner's files include each other as <Progmasoft/...> or, inside one
+# directory, as "Name.hpp".
+progmasoft_include_parser = re.compile(r'\s*#include (?:<(Progmasoft/[^>]+)>|"([A-Za-z/]+\.hpp)").*')
+concatenated_runner_headers = set()
+
+
+def concatenate_runner_file(out, filename: str, expand_headers: bool):
+    """Copies a file of the runner, expanding the runner's headers it
+    includes once, or dropping those includes from the .cpp files."""
+    directory = os.path.dirname(filename)
+    with open(filename, mode='r', encoding='utf-8') as input:
+        for line in input:
+            if line.strip() == '#pragma once':
+                continue
+            # Catch2's own headers are all in the amalgamated header.
+            if internal_include_parser.match(line):
+                continue
+            m = progmasoft_include_parser.match(line)
+            if not m:
+                out.write(line)
+                continue
+            if m.group(1):
+                header = os.path.normpath(os.path.join(root_path, m.group(1)))
+            else:
+                header = os.path.normpath(os.path.join(directory, m.group(2)))
+            if not expand_headers or header in concatenated_runner_headers:
+                continue
+            concatenated_runner_headers.add(header)
+            concatenate_runner_file(out, header, True)
+
+
 def generate_cpp():
     from glob import glob
     cpp_files = sorted(glob(os.path.join(root_path, 'catch2', '**/*.cpp'), recursive=True))
+    runner_headers = sorted(glob(os.path.join(root_path, 'Progmasoft', 'Runner', '*.hpp'))) + [
+        os.path.join(root_path, 'Progmasoft', 'Catch3', name)
+        for name in ('Results.hpp', 'Runner.hpp', 'Version.hpp', 'XmlWriter.hpp')]
+    runner_files = [os.path.join(root_path, 'Progmasoft', 'Results.cpp'),
+                    os.path.join(root_path, 'Progmasoft', 'XmlWriter.cpp')] + \
+        sorted(glob(os.path.join(root_path, 'Progmasoft', 'Runner', '*.cpp')))
     with open(output_cpp, mode='w', encoding='utf-8') as cpp:
         cpp.write(formatted_file_header(Version()))
         cpp.write('\n#include "catch_amalgamated.hpp"\n')
         concatenate_file(cpp, os.path.join(root_path, 'catch2/internal/catch_windows_h_proxy.hpp'), False)
+        # The runner's headers come first: Catch::Session reaches the runner.
+        for header in runner_headers:
+            header = os.path.normpath(header)
+            if header not in concatenated_runner_headers:
+                concatenated_runner_headers.add(header)
+                concatenate_runner_file(cpp, header, True)
         for file in cpp_files:
             concatenate_file(cpp, file, False)
-    print('Concatenated {} cpp files'.format(len(cpp_files)))
+        for file in runner_files:
+            concatenate_runner_file(cpp, file, False)
+    print('Concatenated {} cpp files'.format(len(cpp_files) + len(runner_files)))
 
 if __name__ == "__main__":
     generate_header()