Add a StatisticsDeltaReader class and use cases

chrome/browser/spellchecker/spellcheck_host_metrics_unittest.cc

 // 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.
 
 #include "chrome/browser/spellchecker/spellcheck_host_metrics.h"
 
 #include "base/basictypes.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
-#include "base/metrics/histogram.h"
 #include "base/metrics/histogram_samples.h"
 #include "base/metrics/statistics_recorder.h"
 #include "base/strings/utf_string_conversions.h"
+#include "base/test/statistics_delta_reader.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 #if defined(OS_WIN)
 // For version specific disabled tests below (http://crbug.com/230534).
 #include "base/win/windows_version.h"
 #endif
 
-using base::HistogramBase;
-using base::HistogramSamples;
-using base::StatisticsRecorder;
-
 class SpellcheckHostMetricsTest : public testing::Test {
  public:
   SpellcheckHostMetricsTest() : loop_(base::MessageLoop::TYPE_DEFAULT) {
   }
 
+  static void SetUpTestCase() {
+    base::StatisticsRecorder::Initialize();
+  }
+
   virtual void SetUp() OVERRIDE {
-    base::StatisticsRecorder::Initialize();
     metrics_.reset(new SpellCheckHostMetrics);
   }
 
   SpellCheckHostMetrics* metrics() { return metrics_.get(); }
   void RecordWordCountsForTesting() { metrics_->RecordWordCounts(); }
 
  private:
   base::MessageLoop loop_;
   scoped_ptr<SpellCheckHostMetrics> metrics_;
 };
 
 TEST_F(SpellcheckHostMetricsTest, RecordEnabledStats) {
-  scoped_ptr<HistogramSamples> baseline;
-  HistogramBase* histogram =
-      StatisticsRecorder::FindHistogram("SpellCheck.Enabled");
-  if (histogram)
-    baseline = histogram->SnapshotSamples();
+  const char kMetricName[] = "SpellCheck.Enabled";
+  base::StatisticsDeltaReader statistics_delta_reader1;
 
   metrics()->RecordEnabledStats(false);
 
-  histogram =
-      StatisticsRecorder::FindHistogram("SpellCheck.Enabled");
-  ASSERT_TRUE(histogram != NULL);
-  scoped_ptr<HistogramSamples> samples(histogram->SnapshotSamples());
-  if (baseline.get())
-    samples->Subtract(*baseline);
+  scoped_ptr<base::HistogramSamples> samples(
+      statistics_delta_reader1.GetHistogramSamplesSinceCreation(kMetricName));
   EXPECT_EQ(1, samples->GetCount(0));
   EXPECT_EQ(0, samples->GetCount(1));
 
-  baseline.reset(samples.release());
+  base::StatisticsDeltaReader statistics_delta_reader2;
 
   metrics()->RecordEnabledStats(true);
 
-  histogram =
-      StatisticsRecorder::FindHistogram("SpellCheck.Enabled");
-  ASSERT_TRUE(histogram != NULL);
-  samples = histogram->SnapshotSamples();
-  samples->Subtract(*baseline);
+  samples =
+      statistics_delta_reader2.GetHistogramSamplesSinceCreation(kMetricName);
   EXPECT_EQ(0, samples->GetCount(0));
   EXPECT_EQ(1, samples->GetCount(1));
 }
 
 TEST_F(SpellcheckHostMetricsTest, CustomWordStats) {
 #if defined(OS_WIN)
 // Failing consistently on Win7. See crbug.com/230534.
   if (base::win::GetVersion() >= base::win::VERSION_VISTA)
     return;
 #endif
   SpellCheckHostMetrics::RecordCustomWordCountStats(123);
 
   // Determine if test failures are due the statistics recorder not being
   // available or because the histogram just isn't there: crbug.com/230534.
-  EXPECT_TRUE(StatisticsRecorder::IsActive());
+  EXPECT_TRUE(base::StatisticsRecorder::IsActive());
 
-  HistogramBase* histogram =
-      StatisticsRecorder::FindHistogram("SpellCheck.CustomWords");
-  ASSERT_TRUE(histogram != NULL);
-  scoped_ptr<HistogramSamples> baseline = histogram->SnapshotSamples();
+  base::StatisticsDeltaReader statistics_delta_reader;
 
   SpellCheckHostMetrics::RecordCustomWordCountStats(23);
-  histogram =
-      StatisticsRecorder::FindHistogram("SpellCheck.CustomWords");
-  ASSERT_TRUE(histogram != NULL);
-  scoped_ptr<HistogramSamples> samples = histogram->SnapshotSamples();
 
-  samples->Subtract(*baseline);
-  EXPECT_EQ(23,samples->sum());
+  scoped_ptr<base::HistogramSamples> samples(
+      statistics_delta_reader.GetHistogramSamplesSinceCreation(
+          "SpellCheck.CustomWords"));
+  EXPECT_EQ(23, samples->sum());
 }
 
 TEST_F(SpellcheckHostMetricsTest, RecordWordCountsDiscardsDuplicates) {
   // This test ensures that RecordWordCounts only records metrics if they
   // have changed from the last invocation.
   const char* histogramName[] = {
     "SpellCheck.CheckedWords",
     "SpellCheck.MisspelledWords",
     "SpellCheck.ReplacedWords",
     "SpellCheck.UniqueWords",
     "SpellCheck.ShownSuggestions"
   };
 
   // Ensure all histograms exist.
   metrics()->RecordCheckedWordStats(ASCIIToUTF16("test"), false);
   RecordWordCountsForTesting();
 
-  // Get baselines for all affected histograms.
-  scoped_ptr<HistogramSamples> baselines[arraysize(histogramName)];
-  for (size_t i = 0; i < arraysize(histogramName); ++i) {
-    HistogramBase* histogram =
-        StatisticsRecorder::FindHistogram(histogramName[i]);
-    if (histogram)
-      baselines[i] = histogram->SnapshotSamples();
-  }
+  // Start the reader.
+  base::StatisticsDeltaReader statistics_delta_reader;
 
   // Nothing changed, so this invocation should not affect any histograms.
   RecordWordCountsForTesting();
 
   // Get samples for all affected histograms.
-  scoped_ptr<HistogramSamples> samples[arraysize(histogramName)];
+  scoped_ptr<base::HistogramSamples> samples;
   for (size_t i = 0; i < arraysize(histogramName); ++i) {
-    HistogramBase* histogram =
-        StatisticsRecorder::FindHistogram(histogramName[i]);
-    ASSERT_TRUE(histogram != NULL);
-    samples[i] = histogram->SnapshotSamples();
-    if (baselines[i].get())
-      samples[i]->Subtract(*baselines[i]);
-
-    EXPECT_EQ(0, samples[i]->TotalCount());
+    samples = statistics_delta_reader.GetHistogramSamplesSinceCreation(
+        histogramName[i]);
+    EXPECT_EQ(0, samples->TotalCount());
   }
 }
 
 TEST_F(SpellcheckHostMetricsTest, RecordSpellingServiceStats) {
   const char kMetricName[] = "SpellCheck.SpellingService.Enabled";
-  scoped_ptr<HistogramSamples> baseline;
-  HistogramBase* histogram = StatisticsRecorder::FindHistogram(kMetricName);
-  if (histogram)
-    baseline = histogram->SnapshotSamples();
+  base::StatisticsDeltaReader statistics_delta_reader1;
 
   metrics()->RecordSpellingServiceStats(false);
 
-  histogram =
-      StatisticsRecorder::FindHistogram(kMetricName);
-  ASSERT_TRUE(histogram != NULL);
-  scoped_ptr<HistogramSamples> samples(histogram->SnapshotSamples());
-  if (baseline.get())
-    samples->Subtract(*baseline);
+  scoped_ptr<base::HistogramSamples> samples(
+      statistics_delta_reader1.GetHistogramSamplesSinceCreation(kMetricName));
   EXPECT_EQ(1, samples->GetCount(0));
   EXPECT_EQ(0, samples->GetCount(1));
 
-  baseline.reset(samples.release());
+  base::StatisticsDeltaReader statistics_delta_reader2;
 
   metrics()->RecordSpellingServiceStats(true);
 
-  histogram =
-      StatisticsRecorder::FindHistogram(kMetricName);
-  ASSERT_TRUE(histogram != NULL);
-  samples = histogram->SnapshotSamples();
-  samples->Subtract(*baseline);
+  samples =
+      statistics_delta_reader2.GetHistogramSamplesSinceCreation(kMetricName);
   EXPECT_EQ(0, samples->GetCount(0));
   EXPECT_EQ(1, samples->GetCount(1));
 }