Create a histogram serialization mechanism in components/metrics

components/metrics/chromeos/metrics_utils_unittest.cc

Index: components/metrics/chromeos/metrics_utils_unittest.cc
diff --git a/components/metrics/chromeos/metrics_utils_unittest.cc b/components/metrics/chromeos/metrics_utils_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..1a34032643265c06101a5618ec0c30ccb0291d1f
--- /dev/null
+++ b/components/metrics/chromeos/metrics_utils_unittest.cc
@@ -0,0 +1,165 @@
+// 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 "components/metrics/chromeos/metrics_utils.h"
+
+#include "base/file_util.h"
+#include "base/files/scoped_temp_dir.h"
+#include "base/logging.h"
+#include "base/strings/stringprintf.h"
+#include "components/metrics/chromeos/metric_sample.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace metrics {
+namespace {
+
+class MetricsUtilsChromeOSTest : public testing::Test {
+ protected:
+  MetricsUtilsChromeOSTest() {
+    bool success = temporary_dir.CreateUniqueTempDir();
+    if (success) {
+      base::FilePath dir_path = temporary_dir.path();
+      filename = dir_path.value() + "chromeossampletest";
+      filepath = base::FilePath(filename);
+    }
+  }
+
+  bool AreEq(MetricSample* a, MetricSample* b) {
+    CHECK(a);
+    CHECK(b);
+    return a->IsEqual(b);
+  }
+
+  virtual void SetUp() {
+    base::DeleteFile(filepath, false);
+  }
+
+  void TestSerialization(MetricSample* sample) {
+    std::string serialized(sample->ToString());
+    ASSERT_EQ('\0', serialized[serialized.length() - 1]);
+    AreEq(sample, MetricsUtils::ReadSample(serialized).release());
+  }
+
+  std::string filename;
+  base::ScopedTempDir temporary_dir;
+  base::FilePath filepath;
+};
+
+TEST_F(MetricsUtilsChromeOSTest, CrashSerializeTest) {
+  TestSerialization(MetricSample::CrashSample("test").release());
+}
+
+TEST_F(MetricsUtilsChromeOSTest, HistogramSerializeTest) {
+  TestSerialization(
+      MetricSample::HistogramSample("myhist", 13, 1, 100, 10).release());
+}
+
+TEST_F(MetricsUtilsChromeOSTest, LinearSerializeTest) {
+  TestSerialization(
+      MetricSample::LinearHistogramSample("linearhist", 12, 30).release());
+}
+
+TEST_F(MetricsUtilsChromeOSTest, SparseSerializeTest) {
+  TestSerialization(
+      MetricSample::SparseHistogramSample("mysparse", 30).release());
+}
+
+TEST_F(MetricsUtilsChromeOSTest, UserActionSerializeTest) {
+  TestSerialization(MetricSample::UserActionSample("myaction").release());
+}
+
+TEST_F(MetricsUtilsChromeOSTest, IllegalNameAreFilteredTest) {
+  scoped_ptr<MetricSample> sample1 =
+      MetricSample::SparseHistogramSample("no space", 10);
+  scoped_ptr<MetricSample> sample2 = MetricSample::LinearHistogramSample(
+      base::StringPrintf("here%cbhe", '\0'), 1, 3);
+
+  EXPECT_FALSE(MetricsUtils::WriteMetricToFile(sample1.get(), filename));
+  EXPECT_FALSE(MetricsUtils::WriteMetricToFile(sample2.get(), filename));
+  int64 size = 0;
+
+  ASSERT_TRUE(!PathExists(filepath) || base::GetFileSize(filepath, &size));
+
+  EXPECT_EQ(0, size);
+}
+
+TEST_F(MetricsUtilsChromeOSTest, BadInputIsCaughtTest) {
+  std::string input(
+      base::StringPrintf("sparsehistogram%cname foo%c", '\0', '\0'));
+  EXPECT_EQ(NULL, MetricSample::ReadSparseHistogram(input).release());
+}
+
+TEST_F(MetricsUtilsChromeOSTest, MessageSeparatedByZero) {
+  scoped_ptr<MetricSample> crash = MetricSample::CrashSample("crash");
+
+  MetricsUtils::WriteMetricToFile(crash.get(), filename);
+  int64 size = 0;
+  ASSERT_TRUE(base::GetFileSize(filepath, &size));
+  EXPECT_EQ(size, 16);
+}
+
+TEST_F(MetricsUtilsChromeOSTest, MessagesTooLongAreDiscardedTest) {
+  // Creates a message that is bigger than the maximum allowed size.
+  // As we are adding extra character (crash, \0s, etc), if the name is
+  // kMessageMaxLength long, it will be too long.
+  std::string name(MetricsUtils::kMessageMaxLength, 'c');
+
+  scoped_ptr<MetricSample> crash = MetricSample::CrashSample(name);
+  EXPECT_FALSE(MetricsUtils::WriteMetricToFile(crash.get(), filename));
+  int64 size = 0;
+  ASSERT_TRUE(base::GetFileSize(filepath, &size));
+  EXPECT_EQ(0, size);
+}
+
+TEST_F(MetricsUtilsChromeOSTest, ReadLongMessageTest) {
+  base::File test_file(filepath,
+                       base::File::FLAG_OPEN_ALWAYS | base::File::FLAG_APPEND);
+  std::string message(MetricsUtils::kMessageMaxLength + 1, 'c');
+
+  int32_t message_size = message.length() + sizeof(int32_t);
+  test_file.WriteAtCurrentPos(reinterpret_cast<const char*>(&message_size),
+                              sizeof(message_size));
+  test_file.WriteAtCurrentPos(message.c_str(), message.length());
+  test_file.Close();
+
+  scoped_ptr<MetricSample> crash = MetricSample::CrashSample("test");
+  MetricsUtils::WriteMetricToFile(crash.get(), filename);
+
+  ScopedVector<MetricSample> samples;
+  MetricsUtils::ReadAndTruncateMetricsFromFile(filename, &samples);
+  ASSERT_EQ(size_t(1), samples.size());
+  AreEq(crash.get(), samples[0]);
+}
+
+TEST_F(MetricsUtilsChromeOSTest, WriteReadTest) {
+  scoped_ptr<MetricSample> hist =
+      MetricSample::HistogramSample("myhist", 1, 2, 3, 4);
+  scoped_ptr<MetricSample> crash = MetricSample::CrashSample("crash");
+  scoped_ptr<MetricSample> lhist =
+      MetricSample::LinearHistogramSample("linear", 1, 10);
+  scoped_ptr<MetricSample> shist =
+      MetricSample::SparseHistogramSample("mysparse", 30);
+  scoped_ptr<MetricSample> action = MetricSample::UserActionSample("myaction");
+
+  MetricsUtils::WriteMetricToFile(hist.get(), filename);
+  MetricsUtils::WriteMetricToFile(crash.get(), filename);
+  MetricsUtils::WriteMetricToFile(lhist.get(), filename);
+  MetricsUtils::WriteMetricToFile(shist.get(), filename);
+  MetricsUtils::WriteMetricToFile(action.get(), filename);
+  ScopedVector<MetricSample> vect;
+  MetricsUtils::ReadAndTruncateMetricsFromFile(filename, &vect);
+  ASSERT_EQ(vect.size(), size_t(5));
+  AreEq(hist.get(), vect[0]);

[Alexei Svitkine (slow), 2014/05/13 15:36:26]

You're ignoring the return value of this - since your AreEq() function returns
the result.

Honestly, I don't really see the point of AreEq(), just do:

EXPECT_TRUE(hist->IsEqual(vect[1]));

[bsimonnet, 2014/05/13 17:59:14]

Thanks for catching that, one of those was not equal because of a bug I
introduced and it was not failing the test.
I agree. AreEq is not useful now that IsEqual contains the logic.

+  AreEq(crash.get(), vect[1]);
+  AreEq(lhist.get(), vect[2]);
+  AreEq(shist.get(), vect[3]);
+  AreEq(action.get(), vect[4]);
+
+  int64 size = 0;
+  ASSERT_TRUE(base::GetFileSize(filepath, &size));
+  ASSERT_EQ(0, size);
+}
+
+}  // namespace
+}  // namespace metrics