diff options
| author | Leitwolf11 | 2026-10-23 23:25:41 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-10-23 23:25:41 +0300 |
| commit | 93d4e7dbebab867e0a7f59fc25308460a7a76280 (patch) | |
| tree | 54c568a3063d49e21f039b6d38f40f51be7991f0 /src/Progmasoft/Runner/History.cpp | |
| parent | 83c6fc3ac13abe83fa39f7b5f8559ccaf4412233 (diff) | |
| download | catch3-93d4e7dbebab867e0a7f59fc25308460a7a76280.tar.gz | |
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.
Diffstat (limited to 'src/Progmasoft/Runner/History.cpp')
| -rw-r--r-- | src/Progmasoft/Runner/History.cpp | 486 |
1 files changed, 486 insertions, 0 deletions
diff --git a/src/Progmasoft/Runner/History.cpp b/src/Progmasoft/Runner/History.cpp new file mode 100644 index 00000000..83208ea0 --- /dev/null +++ b/src/Progmasoft/Runner/History.cpp @@ -0,0 +1,486 @@ +// Copyright (c) 2026 Progmasoft. +// SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-1.1 +#include "History.hpp" + +#include "Files.hpp" + +#include <algorithm> +#include <cmath> +#include <system_error> + +namespace Progmasoft::Catch3::Runner +{ + namespace + { + constexpr int kHistoryVersion = 1; + constexpr std::size_t kRecordsPerTest = 50; + constexpr std::size_t kRunsKept = 100; + + /// Runs that did not finish on their own say nothing about how long + /// the test takes. + bool + HasDuration(Outcome outcome) + { + return outcome == Outcome::kPassed || outcome == Outcome::kFailed || + outcome == Outcome::kFailedAsExpected || + outcome == Outcome::kSkipped; + } + + bool + Counts(Outcome outcome) + { + return outcome != Outcome::kNotRun && outcome != Outcome::kBlocked && + outcome != Outcome::kUpToDate; + } + + JsonValue + RecordToJson(const TestRecord &record) + { + JsonValue value = JsonValue::Object(); + value.Set("run", record.run); + value.Set("outcome", OutcomeName(record.outcome)); + if (record.category != FailureCategory::kNone) + { + value.Set("category", CategoryName(record.category)); + } + value.Set("duration", record.durationMicroseconds); + value.Set("attempts", record.attempts); + if (record.flaky) + { + value.Set("flaky", true); + } + if (!record.signature.empty()) + { + value.Set("signature", record.signature); + } + if (!record.fingerprint.empty()) + { + value.Set("fingerprint", record.fingerprint); + } + return value; + } + + TestRecord + RecordFromJson(const JsonValue &value) + { + TestRecord record; + record.run = value["run"].AsInteger(); + record.outcome = OutcomeFromName(value["outcome"].AsString()) + .value_or(Outcome::kNotRun); + record.category = CategoryFromName(value["category"].AsString()) + .value_or(FailureCategory::kNone); + record.durationMicroseconds = value["duration"].AsInteger(); + record.attempts = + static_cast<std::size_t>(value["attempts"].AsUnsigned()); + record.flaky = value["flaky"].AsBoolean(); + record.signature = value["signature"].AsString(); + record.fingerprint = value["fingerprint"].AsString(); + return record; + } + } // namespace + + const TestRecord * + TestHistory::Last() const noexcept + { + for (auto record = records.rbegin(); record != records.rend(); + ++record) + { + if (Counts(record->outcome)) + { + return &*record; + } + } + return nullptr; + } + + std::optional<std::int64_t> + TestHistory::DurationPercentile(double fraction) const + { + std::vector<std::int64_t> durations; + for (auto record = records.rbegin(); + record != records.rend() && durations.size() < 20; + ++record) + { + if (HasDuration(record->outcome)) + { + durations.push_back(record->durationMicroseconds); + } + } + if (durations.empty()) + { + return std::nullopt; + } + std::sort(durations.begin(), durations.end()); + const auto position = static_cast<std::size_t>( + std::ceil(fraction * static_cast<double>(durations.size()))); + return durations[std::min(durations.size() - 1, + position == 0 ? 0 : position - 1)]; + } + + double + TestHistory::FailureProbability() const + { + // A beta prior worth one run: a test without history fails with + // probability 0.3, a common share for new code. + double failures = 0.3; + double total = 1.0; + double weight = 1.0; + std::size_t seen = 0; + for (auto record = records.rbegin(); + record != records.rend() && seen < 30; + ++record) + { + if (!Counts(record->outcome)) + { + continue; + } + ++seen; + const bool failed = IsFailure(record->outcome) || record->flaky; + failures += failed ? weight : 0.0; + total += weight; + weight *= 0.8; + } + double probability = failures / total; + if (const TestRecord *last = Last(); + last != nullptr && IsFailure(last->outcome)) + { + // What failed last time most often fails again. + probability = std::max(probability, 0.7); + } + return probability; + } + + std::size_t + TestHistory::FlakyEvents(std::size_t window) const + { + std::size_t events = 0; + std::size_t seen = 0; + const TestRecord *newer = nullptr; + for (auto record = records.rbegin(); + record != records.rend() && seen < window; + ++record) + { + if (!Counts(record->outcome)) + { + continue; + } + ++seen; + if (record->flaky) + { + ++events; + } + else if (newer != nullptr && !newer->flaky && + !record->fingerprint.empty() && + record->fingerprint == newer->fingerprint && + IsFailure(record->outcome) != IsFailure(newer->outcome)) + { + // The verdict changed while nothing the test depends on did. + ++events; + } + newer = &*record; + } + return events; + } + + std::size_t + TestHistory::PassStreak() const + { + std::size_t streak = 0; + for (auto record = records.rbegin(); record != records.rend(); + ++record) + { + if (!Counts(record->outcome)) + { + continue; + } + if (record->outcome != Outcome::kPassed || record->flaky) + { + break; + } + ++streak; + } + return streak; + } + + std::filesystem::path + HistoryFile(const std::filesystem::path &directory, + const std::string &binaryName) + { + std::string name; + for (const char character : binaryName) + { + const bool safe = (character >= 'a' && character <= 'z') || + (character >= 'A' && character <= 'Z') || + (character >= '0' && character <= '9') || + character == '-' || character == '_' || + character == '.'; + name.push_back(safe ? character : '_'); + } + return directory / (name + ".history.json"); + } + + std::string + History::KeyOf(const TestResult &test) + { + if (!test.id.empty()) + { + return test.id; + } + return test.className.empty() ? test.name + : test.className + "::" + test.name; + } + + const TestHistory * + History::Find(const std::string &key) const + { + const auto found = tests_.find(key); + return found == tests_.end() ? nullptr : &found->second; + } + + Expected<History> + History::Load(const std::filesystem::path &file) + { + std::error_code error; + if (!std::filesystem::exists(file, error)) + { + return History{}; + } + auto text = ReadFile(file); + if (!text) + { + return text.GetError(); + } + auto json = ParseJson(*text); + if (!json) + { + return json.GetError().Context(file.string()); + } + return FromJson(*json); + } + + Expected<History> + History::Commit(const std::filesystem::path &file, + const RunResult &run, + const RunRecord &record, + const std::map<std::string, std::string> &fingerprints, + const QuarantinePolicy &policy) + { + const FileLock lock{file, std::chrono::seconds(10)}; + auto history = Load(file); + if (!history) + { + // A damaged file is set aside rather than lost. + std::error_code error; + std::filesystem::rename( + file, file.string() + ".damaged-" + UniqueName(), error); + history = History{}; + } + history->Apply(run, record, fingerprints, policy); + if (auto status = WriteFileAtomically( + file, history->ToJson().ToPrettyString()); + !status) + { + return status.GetError(); + } + return history; + } + + void + History::Apply(const RunResult &run, + RunRecord record, + const std::map<std::string, std::string> &fingerprints, + const QuarantinePolicy &policy) + { + record.id = nextRun_++; + runs_.push_back(record); + if (runs_.size() > kRunsKept) + { + runs_.erase(runs_.begin(), + runs_.begin() + + static_cast<std::ptrdiff_t>(runs_.size() - + kRunsKept)); + } + for (const auto &test : run.tests) + { + if (test.outcome == Outcome::kNotRun) + { + continue; + } + const std::string key = KeyOf(test); + TestHistory &history = tests_[key]; + TestRecord result; + result.run = record.id; + result.outcome = test.outcome; + result.category = test.category; + result.durationMicroseconds = + test.attempts.empty() ? 0 + : test.attempts.back().durationMicroseconds; + result.attempts = test.attempts.size(); + result.flaky = test.flaky; + result.signature = test.signature; + if (const auto found = fingerprints.find(key); + found != fingerprints.end()) + { + result.fingerprint = found->second; + } + history.records.push_back(result); + if (history.records.size() > kRecordsPerTest) + { + history.records.erase(history.records.begin()); + } + const auto failed = std::find_if( + test.attempts.begin(), test.attempts.end(), [](const Attempt &attempt) { + return IsFailure(attempt.outcome); + }); + if ((IsFailure(test.outcome) || test.flaky) && + failed != test.attempts.end()) + { + // The first failure, as it happened: a flaky failure is + // worth replaying too. + ReplayRecord replay; + replay.run = record.id; + replay.seed = failed->seed; + replay.precededBy = failed->precededBy; + replay.freshProcess = failed->freshProcess; + history.lastFailure = replay; + } + else if (test.outcome == Outcome::kPassed) + { + history.lastFailure.reset(); + } + // Quarantine: in after repeated flakiness, out after a streak of + // clean passes. + if (!history.quarantine && + history.FlakyEvents(policy.window) >= policy.flakyEventsToEnter) + { + history.quarantine = QuarantineRecord{ + record.id, + std::to_string(history.FlakyEvents(policy.window)) + + " flaky results in the last " + + std::to_string(policy.window) + " runs"}; + } + else if (history.quarantine && + history.PassStreak() >= policy.passesToLeave) + { + history.quarantine.reset(); + } + } + } + + JsonValue + History::ToJson() const + { + JsonValue value = JsonValue::Object(); + value.Set("format", "catch3-history"); + value.Set("version", kHistoryVersion); + value.Set("nextRun", nextRun_); + JsonValue runs = JsonValue::Array(); + for (const auto &run : runs_) + { + JsonValue item = JsonValue::Object(); + item.Set("id", run.id); + item.Set("time", run.unixMilliseconds); + item.Set("commit", run.commit); + item.Set("binary", run.binaryFingerprint); + item.Set("seed", run.seed); + item.Set("tests", run.tests); + item.Set("failed", run.failed); + item.Set("wall", run.wallMicroseconds); + runs.Append(std::move(item)); + } + value.Set("runs", std::move(runs)); + JsonValue tests = JsonValue::Object(); + for (const auto &[key, history] : tests_) + { + JsonValue item = JsonValue::Object(); + JsonValue records = JsonValue::Array(); + for (const auto &record : history.records) + { + records.Append(RecordToJson(record)); + } + item.Set("results", std::move(records)); + if (history.quarantine) + { + JsonValue quarantine = JsonValue::Object(); + quarantine.Set("since", history.quarantine->since); + quarantine.Set("reason", history.quarantine->reason); + item.Set("quarantine", std::move(quarantine)); + } + if (history.lastFailure) + { + JsonValue replay = JsonValue::Object(); + replay.Set("run", history.lastFailure->run); + replay.Set("seed", history.lastFailure->seed); + JsonValue preceding = JsonValue::Array(); + for (const auto &name : history.lastFailure->precededBy) + { + preceding.Append(name); + } + replay.Set("precededBy", std::move(preceding)); + replay.Set("freshProcess", history.lastFailure->freshProcess); + item.Set("lastFailure", std::move(replay)); + } + tests.Set(key, std::move(item)); + } + value.Set("tests", std::move(tests)); + return value; + } + + Expected<History> + History::FromJson(const JsonValue &value) + { + if (value["format"].AsString() != "catch3-history") + { + return Error{"not a Catch3 history"}; + } + if (value["version"].AsInteger() > kHistoryVersion) + { + return Error{"the history was written by a newer Catch3"}; + } + History history; + history.nextRun_ = std::max<std::int64_t>(1, value["nextRun"].AsInteger()); + for (const auto &item : value["runs"].Items()) + { + RunRecord run; + run.id = item["id"].AsInteger(); + run.unixMilliseconds = item["time"].AsInteger(); + run.commit = item["commit"].AsString(); + run.binaryFingerprint = item["binary"].AsString(); + run.seed = static_cast<std::uint32_t>(item["seed"].AsUnsigned()); + run.tests = static_cast<std::size_t>(item["tests"].AsUnsigned()); + run.failed = static_cast<std::size_t>(item["failed"].AsUnsigned()); + run.wallMicroseconds = item["wall"].AsInteger(); + history.runs_.push_back(run); + } + for (const auto &[key, item] : value["tests"].Members()) + { + TestHistory test; + for (const auto &record : item["results"].Items()) + { + test.records.push_back(RecordFromJson(record)); + } + if (item["quarantine"].IsObject()) + { + test.quarantine = QuarantineRecord{ + item["quarantine"]["since"].AsInteger(), + item["quarantine"]["reason"].AsString()}; + } + if (item["lastFailure"].IsObject()) + { + const JsonValue &failure = item["lastFailure"]; + ReplayRecord replay; + replay.run = failure["run"].AsInteger(); + replay.seed = + static_cast<std::uint32_t>(failure["seed"].AsUnsigned()); + for (const auto &name : failure["precededBy"].Items()) + { + replay.precededBy.push_back(name.AsString()); + } + replay.freshProcess = failure["freshProcess"].AsBoolean(); + test.lastFailure = replay; + } + history.tests_.emplace(key, std::move(test)); + } + return history; + } +} // namespace Progmasoft::Catch3::Runner |