akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 1 | // Copyright (c) 2010 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #include "base/basictypes.h" |
| 6 | #include "base/logging.h" |
| 7 | |
| 8 | #include "testing/gmock/include/gmock/gmock.h" |
| 9 | #include "testing/gtest/include/gtest/gtest.h" |
| 10 | |
| 11 | namespace logging { |
| 12 | |
| 13 | namespace { |
| 14 | |
| 15 | using ::testing::Return; |
| 16 | |
akalin@chromium.org | 25cef53 | 2010-11-02 04:49:22 +0900 | [diff] [blame^] | 17 | // Needs to be global since log assert handlers can't maintain state. |
| 18 | int log_sink_call_count = 0; |
| 19 | |
| 20 | void LogSink(const std::string& str) { |
| 21 | ++log_sink_call_count; |
| 22 | } |
| 23 | |
akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 24 | // Class to make sure any manipulations we do to the min log level are |
| 25 | // contained (i.e., do not affect other unit tests). |
akalin@chromium.org | 25cef53 | 2010-11-02 04:49:22 +0900 | [diff] [blame^] | 26 | class LogStateSaver { |
akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 27 | public: |
akalin@chromium.org | 25cef53 | 2010-11-02 04:49:22 +0900 | [diff] [blame^] | 28 | LogStateSaver() : old_min_log_level_(GetMinLogLevel()) {} |
akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 29 | |
akalin@chromium.org | 25cef53 | 2010-11-02 04:49:22 +0900 | [diff] [blame^] | 30 | ~LogStateSaver() { |
| 31 | SetMinLogLevel(old_min_log_level_); |
| 32 | SetLogAssertHandler(NULL); |
| 33 | SetLogReportHandler(NULL); |
| 34 | log_sink_call_count = 0; |
| 35 | } |
akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 36 | |
| 37 | private: |
| 38 | int old_min_log_level_; |
| 39 | |
akalin@chromium.org | 25cef53 | 2010-11-02 04:49:22 +0900 | [diff] [blame^] | 40 | DISALLOW_COPY_AND_ASSIGN(LogStateSaver); |
akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 41 | }; |
| 42 | |
| 43 | class LoggingTest : public testing::Test { |
| 44 | private: |
akalin@chromium.org | 25cef53 | 2010-11-02 04:49:22 +0900 | [diff] [blame^] | 45 | LogStateSaver log_state_saver_; |
akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 46 | }; |
| 47 | |
| 48 | class MockLogSource { |
| 49 | public: |
| 50 | MOCK_METHOD0(Log, const char*()); |
| 51 | }; |
| 52 | |
| 53 | TEST_F(LoggingTest, BasicLogging) { |
| 54 | MockLogSource mock_log_source; |
| 55 | const int kExpectedDebugOrReleaseCalls = 6; |
| 56 | const int kExpectedDebugCalls = 6; |
| 57 | const int kExpectedCalls = |
| 58 | kExpectedDebugOrReleaseCalls + (DEBUG_MODE ? kExpectedDebugCalls : 0); |
| 59 | EXPECT_CALL(mock_log_source, Log()).Times(kExpectedCalls). |
| 60 | WillRepeatedly(Return("log message")); |
| 61 | |
| 62 | SetMinLogLevel(LOG_INFO); |
| 63 | |
| 64 | EXPECT_TRUE(LOG_IS_ON(INFO)); |
| 65 | EXPECT_EQ(DEBUG_MODE != 0, DLOG_IS_ON(INFO)); |
| 66 | EXPECT_TRUE(VLOG_IS_ON(0)); |
| 67 | |
| 68 | LOG(INFO) << mock_log_source.Log(); |
| 69 | LOG_IF(INFO, true) << mock_log_source.Log(); |
| 70 | PLOG(INFO) << mock_log_source.Log(); |
| 71 | PLOG_IF(INFO, true) << mock_log_source.Log(); |
| 72 | VLOG(0) << mock_log_source.Log(); |
| 73 | VLOG_IF(0, true) << mock_log_source.Log(); |
| 74 | |
| 75 | DLOG(INFO) << mock_log_source.Log(); |
| 76 | DLOG_IF(INFO, true) << mock_log_source.Log(); |
| 77 | DPLOG(INFO) << mock_log_source.Log(); |
| 78 | DPLOG_IF(INFO, true) << mock_log_source.Log(); |
| 79 | DVLOG(0) << mock_log_source.Log(); |
| 80 | DVLOG_IF(0, true) << mock_log_source.Log(); |
| 81 | } |
| 82 | |
| 83 | TEST_F(LoggingTest, LoggingIsLazy) { |
| 84 | MockLogSource mock_log_source; |
| 85 | EXPECT_CALL(mock_log_source, Log()).Times(0); |
| 86 | |
| 87 | SetMinLogLevel(LOG_WARNING); |
| 88 | |
| 89 | EXPECT_FALSE(LOG_IS_ON(INFO)); |
| 90 | EXPECT_FALSE(DLOG_IS_ON(INFO)); |
| 91 | EXPECT_FALSE(VLOG_IS_ON(1)); |
| 92 | |
| 93 | LOG(INFO) << mock_log_source.Log(); |
| 94 | LOG_IF(INFO, false) << mock_log_source.Log(); |
| 95 | PLOG(INFO) << mock_log_source.Log(); |
| 96 | PLOG_IF(INFO, false) << mock_log_source.Log(); |
| 97 | VLOG(1) << mock_log_source.Log(); |
| 98 | VLOG_IF(1, true) << mock_log_source.Log(); |
| 99 | |
| 100 | DLOG(INFO) << mock_log_source.Log(); |
| 101 | DLOG_IF(INFO, true) << mock_log_source.Log(); |
| 102 | DPLOG(INFO) << mock_log_source.Log(); |
| 103 | DPLOG_IF(INFO, true) << mock_log_source.Log(); |
| 104 | DVLOG(1) << mock_log_source.Log(); |
| 105 | DVLOG_IF(1, true) << mock_log_source.Log(); |
| 106 | } |
| 107 | |
| 108 | TEST_F(LoggingTest, ChecksAreNotLazy) { |
| 109 | MockLogSource mock_log_source, uncalled_mock_log_source; |
| 110 | EXPECT_CALL(mock_log_source, Log()).Times(8). |
| 111 | WillRepeatedly(Return("check message")); |
| 112 | EXPECT_CALL(uncalled_mock_log_source, Log()).Times(0); |
| 113 | |
| 114 | SetMinLogLevel(LOG_FATAL + 1); |
| 115 | EXPECT_FALSE(LOG_IS_ON(FATAL)); |
| 116 | |
| 117 | CHECK(mock_log_source.Log()) << uncalled_mock_log_source.Log(); |
| 118 | PCHECK(!mock_log_source.Log()) << mock_log_source.Log(); |
| 119 | CHECK_EQ(mock_log_source.Log(), mock_log_source.Log()) |
| 120 | << uncalled_mock_log_source.Log(); |
| 121 | CHECK_NE(mock_log_source.Log(), mock_log_source.Log()) |
| 122 | << mock_log_source.Log(); |
| 123 | } |
| 124 | |
| 125 | TEST_F(LoggingTest, DebugLoggingReleaseBehavior) { |
| 126 | #if !defined(NDEBUG) |
| 127 | int debug_only_variable = 1; |
| 128 | #endif |
| 129 | // These should avoid emitting references to |debug_only_variable| |
| 130 | // in release mode. |
| 131 | DLOG_IF(INFO, debug_only_variable) << "test"; |
| 132 | DLOG_ASSERT(debug_only_variable) << "test"; |
| 133 | DPLOG_IF(INFO, debug_only_variable) << "test"; |
| 134 | DVLOG_IF(1, debug_only_variable) << "test"; |
| 135 | } |
| 136 | |
| 137 | TEST_F(LoggingTest, DchecksAreLazy) { |
| 138 | MockLogSource mock_log_source; |
| 139 | EXPECT_CALL(mock_log_source, Log()).Times(0); |
| 140 | |
| 141 | #if !defined(LOGGING_IS_OFFICIAL_BUILD) && defined(NDEBUG) |
| 142 | // Unofficial release build. |
| 143 | logging::g_enable_dcheck = false; |
| 144 | #else // !defined(LOGGING_IS_OFFICIAL_BUILD) && defined(NDEBUG) |
| 145 | SetMinLogLevel(LOG_FATAL + 1); |
| 146 | EXPECT_FALSE(LOG_IS_ON(FATAL)); |
| 147 | #endif // !defined(LOGGING_IS_OFFICIAL_BUILD) && defined(NDEBUG) |
| 148 | DCHECK(mock_log_source.Log()) << mock_log_source.Log(); |
| 149 | DPCHECK(mock_log_source.Log()) << mock_log_source.Log(); |
| 150 | DCHECK_EQ(0, 0) << mock_log_source.Log(); |
| 151 | DCHECK_EQ(mock_log_source.Log(), static_cast<const char*>(NULL)) |
| 152 | << mock_log_source.Log(); |
| 153 | } |
| 154 | |
akalin@chromium.org | 25cef53 | 2010-11-02 04:49:22 +0900 | [diff] [blame^] | 155 | TEST_F(LoggingTest, Dcheck) { |
| 156 | #if defined(LOGGING_IS_OFFICIAL_BUILD) |
| 157 | // Official build. |
| 158 | EXPECT_FALSE(DCHECK_IS_ON()); |
| 159 | EXPECT_FALSE(DLOG_IS_ON(DCHECK)); |
| 160 | #elif defined(NDEBUG) |
| 161 | // Unofficial release build. |
| 162 | logging::g_enable_dcheck = true; |
| 163 | logging::SetLogReportHandler(&LogSink); |
| 164 | EXPECT_TRUE(DCHECK_IS_ON()); |
| 165 | EXPECT_FALSE(DLOG_IS_ON(DCHECK)); |
| 166 | #else |
| 167 | // Unofficial debug build. |
| 168 | logging::SetLogAssertHandler(&LogSink); |
| 169 | EXPECT_TRUE(DCHECK_IS_ON()); |
| 170 | EXPECT_TRUE(DLOG_IS_ON(DCHECK)); |
| 171 | #endif // defined(LOGGING_IS_OFFICIAL_BUILD) |
| 172 | |
| 173 | EXPECT_EQ(0, log_sink_call_count); |
| 174 | DCHECK(false); |
| 175 | EXPECT_EQ(DCHECK_IS_ON() ? 1 : 0, log_sink_call_count); |
| 176 | DPCHECK(false); |
| 177 | EXPECT_EQ(DCHECK_IS_ON() ? 2 : 0, log_sink_call_count); |
| 178 | DCHECK_EQ(0, 1); |
| 179 | EXPECT_EQ(DCHECK_IS_ON() ? 3 : 0, log_sink_call_count); |
| 180 | } |
| 181 | |
akalin@chromium.org | a88579b | 2010-10-02 08:02:36 +0900 | [diff] [blame] | 182 | TEST_F(LoggingTest, DcheckReleaseBehavior) { |
| 183 | int some_variable = 1; |
| 184 | // These should still reference |some_variable| so we don't get |
| 185 | // unused variable warnings. |
| 186 | DCHECK(some_variable) << "test"; |
| 187 | DPCHECK(some_variable) << "test"; |
| 188 | DCHECK_EQ(some_variable, 1) << "test"; |
| 189 | } |
| 190 | |
| 191 | } // namespace |
| 192 | |
| 193 | } // namespace logging |