Generalize network_event_log -> device_event_log

This CL:
* Moves network_event_log.cc -> device_event_log_impl.cc
* Defines macros and initialization code in device_event_log.h
* Modifies network_event_log.h to use device_event_log instead.
* Converts PowerManagerClient logging to use POWER_LOG as an immediately useful example.
* Adds the non-network log entries to a 'device_log' entry in chrome://system and feedback reports.

BUG=293739

Review URL: https://codereview.chromium.org/773703002

Cr-Commit-Position: refs/heads/master@{#307086}

1 files changed, 267 insertions, 0 deletions

diff --git a/chromeos/device_event_log_impl_unittest.cc b/chromeos/device_event_log_impl_unittest.cc
new file mode 100644
index 0000000..f3676a6
--- /dev/null
+++ b/chromeos/device_event_log_impl_unittest.cc
@@ -0,0 +1,267 @@
+// Copyright 2014 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 "chromeos/device_event_log_impl.h"
+
+#include <algorithm>
+
+#include "base/basictypes.h"
+#include "base/compiler_specific.h"
+#include "base/format_macros.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/strings/string_split.h"
+#include "base/strings/stringprintf.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace chromeos {
+
+namespace device_event_log {
+
+namespace {
+
+const size_t kDefaultMaxEvents = 100;
+LogLevel kDefaultLevel = LOG_LEVEL_EVENT;
+LogType kDefaultType = LOG_TYPE_NETWORK;
+
+}  // namespace
+
+class DeviceEventLogTest : public testing::Test {
+ public:
+  DeviceEventLogTest() {}
+
+  void SetUp() override {
+    impl_.reset(new DeviceEventLogImpl(kDefaultMaxEvents));
+  }
+
+  void TearDown() override { impl_.reset(); }
+
+ protected:
+  std::string SkipTime(const std::string& input) {
+    std::string output;
+    std::vector<std::string> lines;
+    base::SplitString(input, '\n', &lines);
+    for (size_t i = 0; i < lines.size(); ++i) {
+      size_t n = lines[i].find(']');
+      if (n != std::string::npos)
+        output += "[time] " + lines[i].substr(n + 2) + '\n';
+      else
+        output += lines[i];
+    }
+    return output;
+  }
+
+  size_t CountLines(const std::string& input) {
+    return std::count(input.begin(), input.end(), '\n');
+  }
+
+  std::string GetLogString(StringOrder order,
+                           const std::string& format,
+                           LogLevel max_level,
+                           size_t max_events) {
+    return impl_->GetAsString(order, format, kDefaultType, max_level,
+                              max_events);
+  }
+
+  std::string GetOrderedString(StringOrder order, size_t max_events) {
+    return impl_->GetAsString(order, "file", kDefaultType, kDefaultLevel,
+                              max_events);
+  }
+
+  std::string GetLogStringForType(LogType type) {
+    return impl_->GetAsString(OLDEST_FIRST, "type", type, kDefaultLevel, 0);
+  }
+
+  void AddNetworkEntry(const char* file,
+                       int line,
+                       LogLevel level,
+                       const std::string& event) {
+    impl_->AddEntry(file, line, kDefaultType, level, event);
+  }
+
+  void AddTestEvent(LogLevel level, const std::string& event) {
+    AddNetworkEntry("file", 0, level, event);
+  }
+
+  void AddEventType(LogType type, const std::string& event) {
+    impl_->AddEntry("file", 0, type, kDefaultLevel, event);
+  }
+
+  size_t GetMaxEntries() const { return impl_->max_entries(); }
+
+  scoped_ptr<DeviceEventLogImpl> impl_;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(DeviceEventLogTest);
+};
+
+TEST_F(DeviceEventLogTest, TestNetworkEvents) {
+  std::string output_none = GetOrderedString(OLDEST_FIRST, 0);
+  EXPECT_EQ("No Log Entries.", output_none);
+
+  LogLevel level = kDefaultLevel;
+  AddNetworkEntry("file1", 1, level, "event1");
+  AddNetworkEntry("file2", 2, level, "event2");
+  AddNetworkEntry("file3", 3, level, "event3");
+  AddNetworkEntry("file3", 3, level, "event3");
+
+  const std::string expected_output_oldest_first(
+      "file1:1 event1\n"
+      "file2:2 event2\n"
+      "file3:3 event3 (2)\n");
+  std::string output_oldest_first = GetOrderedString(OLDEST_FIRST, 0);
+  EXPECT_EQ(expected_output_oldest_first, output_oldest_first);
+
+  const std::string expected_output_oldest_first_short(
+      "file2:2 event2\n"
+      "file3:3 event3 (2)\n");
+  std::string output_oldest_first_short = GetOrderedString(OLDEST_FIRST, 2);
+  EXPECT_EQ(expected_output_oldest_first_short, output_oldest_first_short);
+
+  const std::string expected_output_newest_first(
+      "file3:3 event3 (2)\n"
+      "file2:2 event2\n"
+      "file1:1 event1\n");
+  std::string output_newest_first = GetOrderedString(NEWEST_FIRST, 0);
+  EXPECT_EQ(expected_output_newest_first, output_newest_first);
+
+  const std::string expected_output_newest_first_short(
+      "file3:3 event3 (2)\n"
+      "file2:2 event2\n");
+  std::string output_newest_first_short = GetOrderedString(NEWEST_FIRST, 2);
+  EXPECT_EQ(expected_output_newest_first_short, output_newest_first_short);
+}
+
+TEST_F(DeviceEventLogTest, TestMaxEntries) {
+  const size_t max_entries = GetMaxEntries();
+  const size_t entries_to_add = max_entries + 3;
+  for (size_t i = 0; i < entries_to_add; ++i) {
+    AddTestEvent(LOG_LEVEL_EVENT, base::StringPrintf("event_%" PRIuS, i));
+  }
+  std::string output = GetOrderedString(OLDEST_FIRST, 0);
+  size_t output_lines = CountLines(output);
+  EXPECT_EQ(max_entries, output_lines);
+}
+
+TEST_F(DeviceEventLogTest, TestStringFormat) {
+  AddTestEvent(LOG_LEVEL_ERROR, "event0");
+  EXPECT_EQ("file:0 event0\n",
+            GetLogString(OLDEST_FIRST, "file", kDefaultLevel, 1));
+  EXPECT_EQ("[time] event0\n",
+            SkipTime(GetLogString(OLDEST_FIRST, "time", kDefaultLevel, 1)));
+  EXPECT_EQ("event0\n", GetLogString(OLDEST_FIRST, "", kDefaultLevel, 1));
+  EXPECT_EQ("<b><i>event0</i></b>\n",
+            GetLogString(OLDEST_FIRST, "html", kDefaultLevel, 1));
+  EXPECT_EQ(
+      "[time] file:0 event0\n",
+      SkipTime(GetLogString(OLDEST_FIRST, "file,time", kDefaultLevel, 1)));
+
+  AddTestEvent(LOG_LEVEL_DEBUG, "event1");
+  EXPECT_EQ("[time] file:0 <i>event1</i>\n",
+            SkipTime(GetLogString(OLDEST_FIRST, "file,time,html",
+                                  LOG_LEVEL_DEBUG, 1)));
+
+  AddTestEvent(kDefaultLevel, "event2");
+  EXPECT_EQ("Network: file:0 event2\n",
+            GetLogString(OLDEST_FIRST, "file,type", kDefaultLevel, 1));
+}
+
+TEST_F(DeviceEventLogTest, TestLogLevel) {
+  AddTestEvent(LOG_LEVEL_ERROR, "error1");
+  AddTestEvent(LOG_LEVEL_ERROR, "error2");
+  AddTestEvent(LOG_LEVEL_EVENT, "event3");
+  AddTestEvent(LOG_LEVEL_ERROR, "error4");
+  AddTestEvent(LOG_LEVEL_EVENT, "event5");
+  AddTestEvent(LOG_LEVEL_DEBUG, "debug6");
+
+  std::string out;
+  out = GetLogString(OLDEST_FIRST, "", LOG_LEVEL_ERROR, 0);
+  EXPECT_EQ(3u, CountLines(out));
+  out = GetLogString(OLDEST_FIRST, "", LOG_LEVEL_EVENT, 0);
+  EXPECT_EQ(5u, CountLines(out));
+  out = GetLogString(OLDEST_FIRST, "", LOG_LEVEL_DEBUG, 0);
+  EXPECT_EQ(6u, CountLines(out));
+
+  // Test max_level. Get only the ERROR entries.
+  out = GetLogString(OLDEST_FIRST, "", LOG_LEVEL_ERROR, 0);
+  EXPECT_EQ("error1\nerror2\nerror4\n", out);
+}
+
+TEST_F(DeviceEventLogTest, TestMaxEvents) {
+  AddTestEvent(LOG_LEVEL_EVENT, "event1");
+  AddTestEvent(LOG_LEVEL_ERROR, "error2");
+  AddTestEvent(LOG_LEVEL_EVENT, "event3");
+  AddTestEvent(LOG_LEVEL_ERROR, "error4");
+  AddTestEvent(LOG_LEVEL_EVENT, "event5");
+
+  // Oldest first
+  EXPECT_EQ("error4\n", GetLogString(OLDEST_FIRST, "", LOG_LEVEL_ERROR, 1));
+
+  EXPECT_EQ("error2\nerror4\n",
+            GetLogString(OLDEST_FIRST, "", LOG_LEVEL_ERROR, 2));
+
+  EXPECT_EQ("event3\nerror4\nevent5\n",
+            GetLogString(OLDEST_FIRST, "", LOG_LEVEL_EVENT, 3));
+
+  EXPECT_EQ("error2\nevent3\nerror4\nevent5\n",
+            GetLogString(OLDEST_FIRST, "", LOG_LEVEL_EVENT, 4));
+
+  EXPECT_EQ("event1\nerror2\nevent3\nerror4\nevent5\n",
+            GetLogString(OLDEST_FIRST, "", LOG_LEVEL_EVENT, 5));
+
+  // Newest first
+  EXPECT_EQ("error4\n", GetLogString(NEWEST_FIRST, "", LOG_LEVEL_ERROR, 1));
+
+  EXPECT_EQ("error4\nerror2\n",
+            GetLogString(NEWEST_FIRST, "", LOG_LEVEL_ERROR, 2));
+
+  EXPECT_EQ("event5\nerror4\nevent3\n",
+            GetLogString(NEWEST_FIRST, "", LOG_LEVEL_EVENT, 3));
+
+  EXPECT_EQ("event5\nerror4\nevent3\nerror2\n",
+            GetLogString(NEWEST_FIRST, "", LOG_LEVEL_EVENT, 4));
+
+  EXPECT_EQ("event5\nerror4\nevent3\nerror2\nevent1\n",
+            GetLogString(NEWEST_FIRST, "", LOG_LEVEL_EVENT, 5));
+}
+
+TEST_F(DeviceEventLogTest, TestMaxErrors) {
+  const int kMaxTestEntries = 4;
+  impl_.reset(new DeviceEventLogImpl(kMaxTestEntries));
+  AddTestEvent(LOG_LEVEL_EVENT, "event1");
+  AddTestEvent(LOG_LEVEL_ERROR, "error2");
+  AddTestEvent(LOG_LEVEL_EVENT, "event3");
+  AddTestEvent(LOG_LEVEL_ERROR, "error4");
+  AddTestEvent(LOG_LEVEL_EVENT, "event5");
+  AddTestEvent(LOG_LEVEL_EVENT, "event6");
+  EXPECT_EQ("error2\nerror4\nevent5\nevent6\n",
+            GetLogString(OLDEST_FIRST, "", LOG_LEVEL_DEBUG, 0));
+}
+
+TEST_F(DeviceEventLogTest, TestType) {
+  AddEventType(LOG_TYPE_NETWORK, "event1");
+  AddEventType(LOG_TYPE_POWER, "event2");
+  AddEventType(LOG_TYPE_NETWORK, "event3");
+  AddEventType(LOG_TYPE_POWER, "event4");
+  AddEventType(LOG_TYPE_NETWORK, "event5");
+  AddEventType(LOG_TYPE_NETWORK, "event6");
+  EXPECT_EQ(
+      "Network: event1\nNetwork: event3\nNetwork: event5\nNetwork: event6\n",
+      GetLogStringForType(LOG_TYPE_NETWORK));
+  EXPECT_EQ("Power: event2\nPower: event4\n",
+            GetLogStringForType(LOG_TYPE_POWER));
+  EXPECT_EQ("Power: event2\nPower: event4\n",
+            GetLogStringForType(LOG_TYPE_NON_NETWORK));
+  EXPECT_EQ(
+      "Network: event1\n"
+      "Power: event2\n"
+      "Network: event3\n"
+      "Power: event4\n"
+      "Network: event5\n"
+      "Network: event6\n",
+      GetLogStringForType(LOG_TYPE_ALL));
+}
+
+}  // namespace device_event_log
+
+}  // namespace chromeos