// Copyright (c) 2012 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. // Note: this test tests RTC_LOG_V and RTC_LOG_E since all other logs are // expressed in forms of them. RTC_LOG is also tested for good measure. // Also note that we are only allowed to call InitLogging() twice so the test // cases are more dense than normal. // We must include Chromium headers before including the overrides header // since webrtc's logging.h file may conflict with chromium. #include "base/logging.h" #include "base/command_line.h" #include "base/files/file_util.h" #include "base/files/scoped_temp_dir.h" #include "build/build_config.h" #include "testing/gtest/include/gtest/gtest.h" #include "third_party/webrtc_overrides/rtc_base/logging.h" static const int kDefaultVerbosity = 0; static const char* AsString(rtc::LoggingSeverity severity) { switch (severity) { case rtc::LS_ERROR: return "LS_ERROR"; case rtc::LS_WARNING: return "LS_WARNING"; case rtc::LS_INFO: return "LS_INFO"; case rtc::LS_VERBOSE: return "LS_VERBOSE"; case rtc::LS_SENSITIVE: return "LS_SENSITIVE"; default: return ""; } } static bool ContainsString(const std::string& original, const char* string_to_match) { return original.find(string_to_match) != std::string::npos; } class WebRtcTextLogTest : public testing::Test { public: void SetUp() override { ASSERT_TRUE(log_dir_.CreateUniqueTempDir()); log_file_path_ = log_dir_.GetPath().AppendASCII("webrtc_log"); } protected: bool Initialize(int verbosity_level) { if (verbosity_level != kDefaultVerbosity) { // Update the command line with specified verbosity level for this file. base::CommandLine* command_line = base::CommandLine::ForCurrentProcess(); std::ostringstream value_stream; value_stream << "logging_unittest=" << verbosity_level; const std::string& value = value_stream.str(); command_line->AppendSwitchASCII("vmodule", value); } // The command line flags are parsed here and the log file name is set. logging::LoggingSettings settings; settings.logging_dest = logging::LOG_TO_FILE; settings.log_file_path = log_file_path_.value().data(); settings.lock_log = logging::DONT_LOCK_LOG_FILE; settings.delete_old = logging::DELETE_OLD_LOG_FILE; if (!logging::InitLogging(settings)) { return false; } #if BUILDFLAG(USE_RUNTIME_VLOG) EXPECT_TRUE(VLOG_IS_ON(verbosity_level)); #else // VLOGs default to off when not using runtime vlog. EXPECT_FALSE(VLOG_IS_ON(verbosity_level)); #endif // BUILDFLAG(USE_RUNTIME_VLOG) EXPECT_FALSE(VLOG_IS_ON(verbosity_level + 1)); return true; } base::ScopedTempDir log_dir_; base::FilePath log_file_path_; }; TEST_F(WebRtcTextLogTest, DefaultConfiguration) { ASSERT_TRUE(Initialize(kDefaultVerbosity)); // In the default configuration only warnings and errors should be logged. RTC_LOG_V(rtc::LS_ERROR) << AsString(rtc::LS_ERROR); RTC_LOG_V(rtc::LS_WARNING) << AsString(rtc::LS_WARNING); RTC_LOG_V(rtc::LS_INFO) << AsString(rtc::LS_INFO); RTC_LOG_V(rtc::LS_VERBOSE) << AsString(rtc::LS_VERBOSE); RTC_LOG_V(rtc::LS_SENSITIVE) << AsString(rtc::LS_SENSITIVE); // Read file to string. std::string contents_of_file; base::ReadFileToString(log_file_path_, &contents_of_file); // Make sure string contains the expected values. EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_ERROR))); EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_WARNING))); EXPECT_FALSE(ContainsString(contents_of_file, AsString(rtc::LS_INFO))); EXPECT_FALSE(ContainsString(contents_of_file, AsString(rtc::LS_VERBOSE))); EXPECT_FALSE(ContainsString(contents_of_file, AsString(rtc::LS_SENSITIVE))); } TEST_F(WebRtcTextLogTest, InfoConfiguration) { ASSERT_TRUE(Initialize(0)); // 0 == Chrome's 'info' level. // In this configuration everything lower or equal to LS_INFO should be // logged. RTC_LOG_V(rtc::LS_ERROR) << AsString(rtc::LS_ERROR); RTC_LOG_V(rtc::LS_WARNING) << AsString(rtc::LS_WARNING); RTC_LOG_V(rtc::LS_INFO) << AsString(rtc::LS_INFO); RTC_LOG_V(rtc::LS_VERBOSE) << AsString(rtc::LS_VERBOSE); RTC_LOG_V(rtc::LS_SENSITIVE) << AsString(rtc::LS_SENSITIVE); // Read file to string. std::string contents_of_file; base::ReadFileToString(log_file_path_, &contents_of_file); // Make sure string contains the expected values. EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_ERROR))); EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_WARNING))); EXPECT_FALSE(ContainsString(contents_of_file, AsString(rtc::LS_INFO))); EXPECT_FALSE(ContainsString(contents_of_file, AsString(rtc::LS_VERBOSE))); EXPECT_FALSE(ContainsString(contents_of_file, AsString(rtc::LS_SENSITIVE))); // Also check that the log is proper. EXPECT_TRUE(ContainsString(contents_of_file, "logging_unittest.cc")); EXPECT_FALSE(ContainsString(contents_of_file, "logging.h")); EXPECT_FALSE(ContainsString(contents_of_file, "logging.cc")); } TEST_F(WebRtcTextLogTest, LogEverythingConfiguration) { ASSERT_TRUE(Initialize(2)); // verbosity at level 2 allows LS_SENSITIVE. // In this configuration everything should be logged. RTC_LOG_V(rtc::LS_ERROR) << AsString(rtc::LS_ERROR); RTC_LOG_V(rtc::LS_WARNING) << AsString(rtc::LS_WARNING); RTC_LOG(LS_INFO) << AsString(rtc::LS_INFO); static const int kFakeError = 1; RTC_LOG_E(LS_INFO, EN, kFakeError) << "RTC_LOG_E(" << AsString(rtc::LS_INFO) << ")"; RTC_LOG_V(rtc::LS_VERBOSE) << AsString(rtc::LS_VERBOSE); RTC_LOG_V(rtc::LS_SENSITIVE) << AsString(rtc::LS_SENSITIVE); // Read file to string. std::string contents_of_file; base::ReadFileToString(log_file_path_, &contents_of_file); // Make sure string contains the expected values. EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_ERROR))); EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_WARNING))); #if BUILDFLAG(USE_RUNTIME_VLOG) EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_INFO))); // RTC_LOG_E EXPECT_TRUE(ContainsString(contents_of_file, strerror(kFakeError))); EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_VERBOSE))); EXPECT_TRUE(ContainsString(contents_of_file, AsString(rtc::LS_SENSITIVE))); #endif // BUILDFLAG(USE_RUNTIME_VLOG) }