Implement Dump-on-DCHECK (via a new LogSeverity).

base/logging_unittest.cc

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/compiler_specific.h"
+#include "base/debug/dump_without_crashing.h"
 #include "base/logging.h"
 #include "base/macros.h"
 
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace logging {
 
 namespace {
 
 using ::testing::Return;
 
 // Needs to be global since log assert handlers can't maintain state.
-int log_sink_call_count = 0;
+int g_log_sink_call_count = 0;
 
 #if !defined(OFFICIAL_BUILD) || defined(DCHECK_ALWAYS_ON) || !defined(NDEBUG)
 void LogSink(const std::string& str) {
-  ++log_sink_call_count;
+  ++g_log_sink_call_count;
 }
 #endif
 
 // Class to make sure any manipulations we do to the min log level are
 // contained (i.e., do not affect other unit tests).
 class LogStateSaver {
  public:
   LogStateSaver() : old_min_log_level_(GetMinLogLevel()) {}
 
   ~LogStateSaver() {
     SetMinLogLevel(old_min_log_level_);
     SetLogAssertHandler(NULL);
-    log_sink_call_count = 0;
+    g_log_sink_call_count = 0;
   }
 
  private:
   int old_min_log_level_;
 
   DISALLOW_COPY_AND_ASSIGN(LogStateSaver);
 };
 
 class LoggingTest : public testing::Test {
  private:
@@ skipping 32 matching lines @@
   DLOG_IF(INFO, true) << mock_log_source.Log();
   DPLOG(INFO) << mock_log_source.Log();
   DPLOG_IF(INFO, true) << mock_log_source.Log();
   DVLOG(0) << mock_log_source.Log();
   DVLOG_IF(0, true) << mock_log_source.Log();
   DVPLOG(0) << mock_log_source.Log();
   DVPLOG_IF(0, true) << mock_log_source.Log();
 }
 
 TEST_F(LoggingTest, LogIsOn) {
-#if defined(NDEBUG)
-  const bool kDfatalIsFatal = false;
+#if defined(DCHECK_IS_DUMP_WITHOUT_CRASH)
+  const bool kDfatalIsActive = true;
+#elif defined(NDEBUG)
+  const bool kDfatalIsActive = false;
 #else  // defined(NDEBUG)
-  const bool kDfatalIsFatal = true;
+  const bool kDfatalIsActive = true;
 #endif  // defined(NDEBUG)
 
   SetMinLogLevel(LOG_INFO);
   EXPECT_TRUE(LOG_IS_ON(INFO));
   EXPECT_TRUE(LOG_IS_ON(WARNING));
   EXPECT_TRUE(LOG_IS_ON(ERROR));
   EXPECT_TRUE(LOG_IS_ON(FATAL));
   EXPECT_TRUE(LOG_IS_ON(DFATAL));
 
   SetMinLogLevel(LOG_WARNING);
   EXPECT_FALSE(LOG_IS_ON(INFO));
   EXPECT_TRUE(LOG_IS_ON(WARNING));
   EXPECT_TRUE(LOG_IS_ON(ERROR));
   EXPECT_TRUE(LOG_IS_ON(FATAL));
   EXPECT_TRUE(LOG_IS_ON(DFATAL));
 
   SetMinLogLevel(LOG_ERROR);
   EXPECT_FALSE(LOG_IS_ON(INFO));
   EXPECT_FALSE(LOG_IS_ON(WARNING));
   EXPECT_TRUE(LOG_IS_ON(ERROR));
   EXPECT_TRUE(LOG_IS_ON(FATAL));
   EXPECT_TRUE(LOG_IS_ON(DFATAL));
 
   // LOG_IS_ON(FATAL) should always be true.
   SetMinLogLevel(LOG_FATAL + 1);
   EXPECT_FALSE(LOG_IS_ON(INFO));
   EXPECT_FALSE(LOG_IS_ON(WARNING));
   EXPECT_FALSE(LOG_IS_ON(ERROR));
   EXPECT_TRUE(LOG_IS_ON(FATAL));
-  EXPECT_TRUE(kDfatalIsFatal == LOG_IS_ON(DFATAL));
+  EXPECT_EQ(kDfatalIsActive, LOG_IS_ON(DFATAL));
+
+  EXPECT_EQ(DCHECK_IS_ON() != 0, LOG_IS_ON(DCHECK));
 }
 
 TEST_F(LoggingTest, LoggingIsLazyBySeverity) {
   MockLogSource mock_log_source;
   EXPECT_CALL(mock_log_source, Log()).Times(0);
 
   SetMinLogLevel(LOG_WARNING);
 
   EXPECT_FALSE(LOG_IS_ON(INFO));
   EXPECT_FALSE(DLOG_IS_ON(INFO));
@@ skipping 51 matching lines @@
   PCHECK(!mock_log_source.Log()) << mock_log_source.Log();
   CHECK_EQ(mock_log_source.Log(), mock_log_source.Log())
       << uncalled_mock_log_source.Log();
   CHECK_NE(mock_log_source.Log(), mock_log_source.Log())
       << mock_log_source.Log();
 }
 
 #endif
 
 TEST_F(LoggingTest, DebugLoggingReleaseBehavior) {
-#if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
+#if DCHECK_IS_ON()
   int debug_only_variable = 1;
 #endif
   // These should avoid emitting references to |debug_only_variable|
   // in release mode.
   DLOG_IF(INFO, debug_only_variable) << "test";
   DLOG_ASSERT(debug_only_variable) << "test";
   DPLOG_IF(INFO, debug_only_variable) << "test";
   DVLOG_IF(1, debug_only_variable) << "test";
 }
 
 TEST_F(LoggingTest, DcheckStreamsAreLazy) {
   MockLogSource mock_log_source;
   EXPECT_CALL(mock_log_source, Log()).Times(0);
 #if DCHECK_IS_ON()
   DCHECK(true) << mock_log_source.Log();
   DCHECK_EQ(0, 0) << mock_log_source.Log();
 #else
   DCHECK(mock_log_source.Log()) << mock_log_source.Log();
   DPCHECK(mock_log_source.Log()) << mock_log_source.Log();
   DCHECK_EQ(0, 0) << mock_log_source.Log();
   DCHECK_EQ(mock_log_source.Log(), static_cast<const char*>(NULL))
       << mock_log_source.Log();
 #endif
 }
 
+#if !defined(DCHECK_IS_DUMP_WITHOUT_CRASH)
 void DcheckEmptyFunction1() {
   // Provide a body so that Release builds do not cause the compiler to
   // optimize DcheckEmptyFunction1 and DcheckEmptyFunction2 as a single
   // function, which breaks the Dcheck tests below.
   LOG(INFO) << "DcheckEmptyFunction1";
 }
 void DcheckEmptyFunction2() {}
 
 TEST_F(LoggingTest, Dcheck) {
 #if defined(NDEBUG) && !defined(DCHECK_ALWAYS_ON)
   // Release build.
   EXPECT_FALSE(DCHECK_IS_ON());
   EXPECT_FALSE(DLOG_IS_ON(DCHECK));
 #elif defined(NDEBUG) && defined(DCHECK_ALWAYS_ON)
   // Release build with real DCHECKS.
   SetLogAssertHandler(&LogSink);
   EXPECT_TRUE(DCHECK_IS_ON());
   EXPECT_TRUE(DLOG_IS_ON(DCHECK));
 #else
   // Debug build.
   SetLogAssertHandler(&LogSink);
   EXPECT_TRUE(DCHECK_IS_ON());
   EXPECT_TRUE(DLOG_IS_ON(DCHECK));
 #endif
 
-  EXPECT_EQ(0, log_sink_call_count);
+  EXPECT_EQ(0, g_log_sink_call_count);
   DCHECK(false);
-  EXPECT_EQ(DCHECK_IS_ON() ? 1 : 0, log_sink_call_count);
+  EXPECT_EQ(DCHECK_IS_ON() ? 1 : 0, g_log_sink_call_count);
   DPCHECK(false);
-  EXPECT_EQ(DCHECK_IS_ON() ? 2 : 0, log_sink_call_count);
+  EXPECT_EQ(DCHECK_IS_ON() ? 2 : 0, g_log_sink_call_count);
   DCHECK_EQ(0, 1);
-  EXPECT_EQ(DCHECK_IS_ON() ? 3 : 0, log_sink_call_count);
+  EXPECT_EQ(DCHECK_IS_ON() ? 3 : 0, g_log_sink_call_count);
 
   // Test DCHECK on std::nullptr_t
-  log_sink_call_count = 0;
+  g_log_sink_call_count = 0;
   const void* p_null = nullptr;
   const void* p_not_null = &p_null;
   DCHECK_EQ(p_null, nullptr);
   DCHECK_EQ(nullptr, p_null);
   DCHECK_NE(p_not_null, nullptr);
   DCHECK_NE(nullptr, p_not_null);
-  EXPECT_EQ(0, log_sink_call_count);
+  EXPECT_EQ(0, g_log_sink_call_count);
 
   // Test DCHECK on a scoped enum.
   enum class Animal { DOG, CAT };
   DCHECK_EQ(Animal::DOG, Animal::DOG);
-  EXPECT_EQ(0, log_sink_call_count);
+  EXPECT_EQ(0, g_log_sink_call_count);
   DCHECK_EQ(Animal::DOG, Animal::CAT);
-  EXPECT_EQ(DCHECK_IS_ON() ? 1 : 0, log_sink_call_count);
+  EXPECT_EQ(DCHECK_IS_ON() ? 1 : 0, g_log_sink_call_count);
 
   // Test DCHECK on functions and function pointers.
-  log_sink_call_count = 0;
+  g_log_sink_call_count = 0;
   struct MemberFunctions {
     void MemberFunction1() {
       // See the comment in DcheckEmptyFunction1().
       LOG(INFO) << "Do not merge with MemberFunction2.";
     }
     void MemberFunction2() {}
   };
   void (MemberFunctions::*mp1)() = &MemberFunctions::MemberFunction1;
   void (MemberFunctions::*mp2)() = &MemberFunctions::MemberFunction2;
   void (*fp1)() = DcheckEmptyFunction1;
   void (*fp2)() = DcheckEmptyFunction2;
   void (*fp3)() = DcheckEmptyFunction1;
   DCHECK_EQ(fp1, fp3);
-  EXPECT_EQ(0, log_sink_call_count);
+  EXPECT_EQ(0, g_log_sink_call_count);
   DCHECK_EQ(mp1, &MemberFunctions::MemberFunction1);
-  EXPECT_EQ(0, log_sink_call_count);
+  EXPECT_EQ(0, g_log_sink_call_count);
   DCHECK_EQ(mp2, &MemberFunctions::MemberFunction2);
-  EXPECT_EQ(0, log_sink_call_count);
+  EXPECT_EQ(0, g_log_sink_call_count);
   DCHECK_EQ(fp1, fp2);
-  EXPECT_EQ(DCHECK_IS_ON() ? 1 : 0, log_sink_call_count);
+  EXPECT_EQ(DCHECK_IS_ON() ? 1 : 0, g_log_sink_call_count);
   DCHECK_EQ(mp2, &MemberFunctions::MemberFunction1);
-  EXPECT_EQ(DCHECK_IS_ON() ? 2 : 0, log_sink_call_count);
+  EXPECT_EQ(DCHECK_IS_ON() ? 2 : 0, g_log_sink_call_count);
 }
+#endif  // !defined(DCHECK_IS_DUMP_WITHOUT_CRASH)
 
 TEST_F(LoggingTest, DcheckReleaseBehavior) {
   int some_variable = 1;
   // These should still reference |some_variable| so we don't get
   // unused variable warnings.
   DCHECK(some_variable) << "test";
   DPCHECK(some_variable) << "test";
   DCHECK_EQ(some_variable, 1) << "test";
 }
 
@@ skipping 14 matching lines @@
   if (false)
     CHECK_EQ(false, true);           // Unreached.
   else
     CHECK_EQ(true, reached = true);  // Reached, passed.
   ASSERT_TRUE(reached);
 
   if (false)
     CHECK_EQ(false, true);           // Unreached.
 }
 
+namespace {
+
+int g_fake_dump_without_crashing_count = 0;
+void FakeDumpWithoutCrashing() {
+  g_fake_dump_without_crashing_count++;
+}
+
+}  // namespace
+
+TEST_F(LoggingTest, LogMessageDump) {
+  // Replace the dump-without-crashing function, to test.
+  base::debug::SetDumpWithoutCrashingFunction(&FakeDumpWithoutCrashing);
+
+  // LOG_DUMP is an internal severity level for use by dump-on-DCHECK, so
+  // we must call LogMessage() directly, rather than using LOG(DUMP).
+  LogMessage(__FILE__, __LINE__, LOG_DUMP, new std::string);
+  EXPECT_EQ(1, g_fake_dump_without_crashing_count);
+  LogMessage(__FILE__, __LINE__, LOG_DUMP, new std::string);
+  EXPECT_EQ(1, g_fake_dump_without_crashing_count);
+
+#if defined(DCHECK_IS_DUMP_WITHOUT_CRASH)
+  EXPECT_EQ(LOG_DUMP, LOG_DFATAL);
+  EXPECT_EQ(LOG_DUMP, LOG_DCHECK);
+#else   // defined(DCHECK_IS_DUMP_WITHOUT_CRASH)
+  EXPECT_NE(LOG_DUMP, LOG_DFATAL);
+  EXPECT_NE(LOG_DUMP, LOG_DCHECK);
+#endif  // defined(DCHECK_IS_DUMP_WITHOUT_CRASH)
+
+  base::debug::SetDumpWithoutCrashingFunction(nullptr);
+}
+
 // Test that defining an operator<< for a type in a namespace doesn't prevent
 // other code in that namespace from calling the operator<<(ostream, wstring)
 // defined by logging.h. This can fail if operator<<(ostream, wstring) can't be
 // found by ADL, since defining another operator<< prevents name lookup from
 // looking in the global namespace.
 namespace nested_test {
   class Streamable {};
   ALLOW_UNUSED_TYPE std::ostream& operator<<(std::ostream& out,
                                              const Streamable&) {
     return out << "Streamable";
   }
   TEST_F(LoggingTest, StreamingWstringFindsCorrectOperator) {
     std::wstring wstr = L"Hello World";
     std::ostringstream ostr;
     ostr << wstr;
     EXPECT_EQ("Hello World", ostr.str());
   }
 }  // namespace nested_test
 
 }  // namespace
 
 }  // namespace logging