Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/src/catch2
diff options
context:
space:
mode:
authorMartin Hořeňovský2021-06-09 20:48:58 +0200
committerMartin Hořeňovský2021-08-07 15:16:11 +0200
commit0a3f511cfed071c9c4ad512341ae7569383922b7 (patch)
tree9bb28fd5a87cd1fffc96832fafeb244c6bef29a7 /src/catch2
parent9ef510b7694c7199a78d13a8cba8ddbdeac7cb16 (diff)
downloadcatch3-0a3f511cfed071c9c4ad512341ae7569383922b7.tar.gz
Fix inconsistencies in reporting benchmarking failures
With these changes, all these benchmarks ```cpp BENCHMARK("Empty benchmark") {}; BENCHMARK("Throwing benchmark") { throw "just a plain literal, bleh"; }; BENCHMARK("Asserting benchmark") { REQUIRE(1 == 2); }; BENCHMARK("FAIL'd benchmark") { FAIL("This benchmark only fails, nothing else"); }; ``` report the respective failure and mark the outer `TEST_CASE` as failed. Previously, the first two would not fail the `TEST_CASE`, and the latter two would break xml reporter's formatting, because `benchmarkFailed`, `benchmarkEnded` etc would not be be called properly in failure cases.
Diffstat (limited to 'src/catch2')
-rw-r--r--src/catch2/benchmark/catch_benchmark.hpp9
-rw-r--r--src/catch2/benchmark/detail/catch_complete_invoke.hpp9
-rw-r--r--src/catch2/benchmark/internal/catch_benchmark_combined_tu.cpp20
3 files changed, 8 insertions, 30 deletions
diff --git a/src/catch2/benchmark/catch_benchmark.hpp b/src/catch2/benchmark/catch_benchmark.hpp
index de41f0c0..7eb1a018 100644
--- a/src/catch2/benchmark/catch_benchmark.hpp
+++ b/src/catch2/benchmark/catch_benchmark.hpp
@@ -81,10 +81,13 @@ namespace Catch {
auto analysis = Detail::analyse(*cfg, env, samples.begin(), samples.end());
BenchmarkStats<FloatDuration<Clock>> stats{ info, analysis.samples, analysis.mean, analysis.standard_deviation, analysis.outliers, analysis.outlier_variance };
getResultCapture().benchmarkEnded(stats);
-
+ } CATCH_CATCH_ANON (TestFailureException) {
+ getResultCapture().benchmarkFailed("Benchmark failed due to failed assertion"_sr);
} CATCH_CATCH_ALL{
- if (translateActiveException() != Detail::benchmarkErrorMsg) // benchmark errors have been reported, otherwise rethrow.
- std::rethrow_exception(std::current_exception());
+ getResultCapture().benchmarkFailed(translateActiveException());
+ // We let the exception go further up so that the
+ // test case is marked as failed.
+ std::rethrow_exception(std::current_exception());
}
}
diff --git a/src/catch2/benchmark/detail/catch_complete_invoke.hpp b/src/catch2/benchmark/detail/catch_complete_invoke.hpp
index 8cb13211..d97e0056 100644
--- a/src/catch2/benchmark/detail/catch_complete_invoke.hpp
+++ b/src/catch2/benchmark/detail/catch_complete_invoke.hpp
@@ -10,6 +10,7 @@
#ifndef CATCH_COMPLETE_INVOKE_HPP_INCLUDED
#define CATCH_COMPLETE_INVOKE_HPP_INCLUDED
+#include <catch2/internal/catch_test_failure_exception.hpp>
#include <catch2/internal/catch_enforce.hpp>
#include <catch2/internal/catch_meta.hpp>
#include <catch2/interfaces/catch_interfaces_capture.hpp>
@@ -51,17 +52,11 @@ namespace Catch {
return CompleteInvoker<FunctionReturnType<Fun, Args...>>::invoke(std::forward<Fun>(fun), std::forward<Args>(args)...);
}
- extern const std::string benchmarkErrorMsg;
} // namespace Detail
template <typename Fun>
Detail::CompleteType_t<FunctionReturnType<Fun>> user_code(Fun&& fun) {
- CATCH_TRY{
- return Detail::complete_invoke(std::forward<Fun>(fun));
- } CATCH_CATCH_ALL{
- getResultCapture().benchmarkFailed(translateActiveException());
- CATCH_RUNTIME_ERROR(Detail::benchmarkErrorMsg);
- }
+ return Detail::complete_invoke(std::forward<Fun>(fun));
}
} // namespace Benchmark
} // namespace Catch
diff --git a/src/catch2/benchmark/internal/catch_benchmark_combined_tu.cpp b/src/catch2/benchmark/internal/catch_benchmark_combined_tu.cpp
index c7234966..ffbae696 100644
--- a/src/catch2/benchmark/internal/catch_benchmark_combined_tu.cpp
+++ b/src/catch2/benchmark/internal/catch_benchmark_combined_tu.cpp
@@ -47,26 +47,6 @@ namespace Catch {
} // namespace Catch
-////////////////////////////////////////////////
-// vvv formerly catch_complete_invoke.cpp vvv //
-////////////////////////////////////////////////
-
-#include <catch2/benchmark/detail/catch_complete_invoke.hpp>
-
-namespace Catch {
- namespace Benchmark {
- namespace Detail {
- CATCH_INTERNAL_START_WARNINGS_SUPPRESSION
- CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS
- const std::string benchmarkErrorMsg = "a benchmark failed to run successfully";
- CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION
- } // namespace Detail
- } // namespace Benchmark
-} // namespace Catch
-
-
-
-
/////////////////////////////////////////////////
// vvv formerly catch_run_for_at_least.cpp vvv //
/////////////////////////////////////////////////