From 332d5ea79375c57ce87b2c497239e6f31e91338f Mon Sep 17 00:00:00 2001
From: Stephan Hageboeck <stephan.hageboeck@cern.ch>
Date: Thu, 9 Mar 2023 18:08:49 +0100
Subject: [PATCH] [core] Improve readability of unit-test-support messages.
ROOT::TestSupport checks info/warning/error messages during unit tests.
Previously, it would generate one global failure irrespective of how
many messages have been received.
Now, each wrong message generates a dedicated failure.
---
core/testsupport/inc/ROOT/TestSupport.hxx | 23 ++++---
core/testsupport/src/TestSupport.cxx | 73 ++++++++++++-----------
2 files changed, 48 insertions(+), 48 deletions(-)
diff --git a/core/testsupport/inc/ROOT/TestSupport.hxx b/core/testsupport/inc/ROOT/TestSupport.hxx
index 0bd0cc9a3d6..0a93bad75c0 100644
--- a/core/testsupport/inc/ROOT/TestSupport.hxx
+++ b/core/testsupport/inc/ROOT/TestSupport.hxx
@@ -111,15 +111,6 @@ class CheckDiagsRAII {
}
private:
- struct Diag_t {
- int severity;
- std::string location;
- std::string message;
- bool matchFullString = true;
- bool optional = false;
- int receivedCount = -1;
- };
-
/// Message handler that hands over all diagnostics to the currently active instance.
static void callback(int severity, bool abort, const char * location, const char * msg) {
if (sActiveInstance) {
@@ -136,9 +127,17 @@ class CheckDiagsRAII {
}
/// Check all received diags against list of expected ones.
- void checkDiag(int severity, const char * location, const char * msg);
- /// Print the diags in `diags` to the terminal.
- void printDiags(std::vector<Diag_t> const & diags) const;
+ void checkDiag(int severity, const char *location, const char *msg);
+
+ struct Diag_t {
+ int severity;
+ std::string location;
+ std::string message;
+ bool matchFullString = true;
+ bool optional = false;
+ int receivedCount = -1;
+ };
+ friend std::ostream &operator<<(std::ostream &stream, Diag_t const &diag);
std::vector<Diag_t> fExpectedDiags;
std::vector<Diag_t> fUnexpectedDiags;
diff --git a/core/testsupport/src/TestSupport.cxx b/core/testsupport/src/TestSupport.cxx
index 259ab4e09c2..60cb3922a50 100644
--- a/core/testsupport/src/TestSupport.cxx
+++ b/core/testsupport/src/TestSupport.cxx
@@ -38,7 +38,8 @@ static struct ForbidDiagnostics {
const char *msg) {
if (level <= gErrorIgnoreLevel) return;
if (level <= kInfo) {
- std::cerr << "Diagnostic in '" << location << "': " << msg << std::endl;
+ std::cerr << "ROOT::TestSupport::ForbidDiagnostics::handler(): Diagnostic in '" << location << "':\n"
+ << msg << std::endl;
return;
}
@@ -90,17 +91,14 @@ CheckDiagsRAII::~CheckDiagsRAII() {
::SetErrorHandler(fOldErrorHandler);
gInterpreter->ReportDiagnosticsToErrorHandler(/*enable=*/false);
- if (!fUnexpectedDiags.empty()) ADD_FAILURE() << "ROOT::TestSupport::CheckDiagsRAII: Unexpected diagnostic messages received.";
-
- const bool missingDiag = std::any_of(fExpectedDiags.begin(), fExpectedDiags.end(), [](const Diag_t & diag){ return !diag.optional && diag.receivedCount < 1; });
- if (missingDiag) ADD_FAILURE() << "ROOT::TestSupport::CheckDiagsRAII: Diagnostic message missing.";
+ for (const auto &diag : fExpectedDiags) {
+ if (!diag.optional && diag.receivedCount < 1) {
+ ADD_FAILURE() << "ROOT::TestSupport::CheckDiagsRAII: Expected diagnostic message missing:\n" << diag;
+ }
+ }
- if (!fUnexpectedDiags.empty() || missingDiag) {
- std::cout << "-------------------------\nPre-registered messages:\n";
- printDiags(fExpectedDiags);
- std::cout << "Unexpected messages received:\n";
- printDiags(fUnexpectedDiags);
- std::cout << "-------------------------" << std::endl;
+ for (const auto &diag : fUnexpectedDiags) {
+ ADD_FAILURE() << "ROOT::TestSupport::CheckDiagsRAII: Unexpected diagnostic message:\n" << diag;
}
}
@@ -109,37 +107,40 @@ CheckDiagsRAII::~CheckDiagsRAII() {
void CheckDiagsRAII::checkDiag(int severity, const char * location, const char * msg) {
// Check that this received diagnostics was expected
const std::string message = msg;
- const auto expectedMatch = std::find_if(fExpectedDiags.begin(), fExpectedDiags.end(), [=](const Diag_t& expectedDiag){
+ const auto expectedMatch =
+ std::find_if(fExpectedDiags.begin(), fExpectedDiags.end(), [=](const Diag_t &expectedDiag) {
return expectedDiag.severity == severity
&& strstr(location, expectedDiag.location.c_str()) != nullptr
&& (expectedDiag.matchFullString ? expectedDiag.message == message : (message.find(expectedDiag.message) != std::string::npos));
- });
-
- if (expectedMatch != fExpectedDiags.end()) {
- expectedMatch->receivedCount += 1;
- } else if (severity <= kInfo) {
- fOldErrorHandler(severity, false, location, msg);
- } else {
- fUnexpectedDiags.push_back({severity, location, std::move(message)});
- }
+ });
+
+ if (expectedMatch != fExpectedDiags.end()) {
+ expectedMatch->receivedCount += 1;
+ } else if (severity <= kInfo) {
+ fOldErrorHandler(severity, false, location, msg);
+ } else {
+ fUnexpectedDiags.push_back({severity, location, std::move(message)});
+ }
}
-void CheckDiagsRAII::printDiags(std::vector<Diag_t> const & diags) const {
+std::ostream &operator<<(std::ostream &stream, CheckDiagsRAII::Diag_t const &diag)
+{
std::map<int, std::string> dict = {
- {kInfo, "kInfo"},
- {kWarning, "kWarning"},
- {kError, "kError"},
- {kSysError, "kSysError"}
- };
-
- for (auto const & diag : diags) {
- std::cout << std::setw(10) << dict[diag.severity] << "\t";
- if (diag.receivedCount >= 0) {
- std::cout << diag.receivedCount << "x received\t"
- << "(" << (diag.optional ? "optional" : "required") << ", " << (diag.matchFullString ? "fullMatch" : "subMatch") << ")\t";
- }
- std::cout << "'" << diag.location << "' msg='" << diag.message << "'\n";
+ {kInfo, "kInfo"}, {kWarning, "kWarning"}, {kError, "kError"}, {kSysError, "kSysError"}};
+
+ constexpr auto indent = 15;
+ stream << std::right << std::setw(indent) << "severity: " << dict[diag.severity];
+ if (diag.receivedCount >= 0) {
+ stream << "\n"
+ << std::setw(indent) << "received: " << diag.receivedCount << " times ("
+ << (diag.optional ? "optional" : "required") << ", " << (diag.matchFullString ? "fullMatch" : "subMatch")
+ << ")\t";
}
-}
+ stream << "\n"
+ << std::setw(indent) << "origin: " << '"' << diag.location << "\""
+ << "\n"
+ << std::setw(indent) << "message: " << diag.message << "\n";
+ return stream;
+}
} } //ROOT::TestSupport
--
GitLab