Skip to content

Conversation

maflcko
Copy link
Member

@maflcko maflcko commented Mar 31, 2020

Explain logging added in #18472 and #16975

@maflcko maflcko force-pushed the 2004-docTestLogging branch from fa8d687 to faabce8 Compare March 31, 2020 20:30
@maflcko
Copy link
Member Author

maflcko commented Mar 31, 2020

Just as a note, if we wanted to remove boost, BOOST_TEST_MESSAGE can be replaced by a simple TEST_MESSAGE macro with this diff:

diff --git a/src/test/main.cpp b/src/test/main.cpp
index f32243d1d3..9bccbef805 100644
--- a/src/test/main.cpp
+++ b/src/test/main.cpp
@@ -13,14 +13,19 @@
 
 #include <iostream>
 
-/** Redirect debug log to unit_test.log files */
-const std::function<void(const std::string&)> G_TEST_LOG_FUN = [](const std::string& s) {
+bool IsTestLoggingEnabled()
+{
     static const bool should_log{std::any_of(
         &boost::unit_test::framework::master_test_suite().argv[1],
         &boost::unit_test::framework::master_test_suite().argv[boost::unit_test::framework::master_test_suite().argc],
         [](const char* arg) {
             return std::string{"DEBUG_LOG_OUT"} == arg;
         })};
-    if (!should_log) return;
+    return should_log;
+}
+
+/** Redirect debug log to unit_test.cpp.log files */
+const std::function<void(const std::string&)> G_TEST_LOG_FUN = [](const std::string& s) {
+    if (!IsTestLoggingEnabled()) return;
     std::cout << s;
 };
diff --git a/src/test/util/logging.h b/src/test/util/logging.h
index 45ec44173c..f4ad232c6e 100644
--- a/src/test/util/logging.h
+++ b/src/test/util/logging.h
@@ -11,6 +11,13 @@
 #include <list>
 #include <string>
 
+bool IsTestLoggingEnabled();
+
+#define TEST_MESSAGE(blob)              \
+    if (IsTestLoggingEnabled()) {       \
+        std::cout << blob << std::endl; \
+    }
+
 class DebugLogHelper
 {
     const std::string m_message;

Copy link
Member

@jonatack jonatack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK modulo nit

@maflcko maflcko force-pushed the 2004-docTestLogging branch from faabce8 to 7777703 Compare March 31, 2020 21:14
Copy link
Member

@jonatack jonatack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 7777703

@DrahtBot
Copy link
Contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

@maflcko maflcko merged commit eb773f1 into bitcoin:master Apr 1, 2020
@maflcko maflcko deleted the 2004-docTestLogging branch April 1, 2020 02:54
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants