src/chrome/browser/spellchecker/spellcheck_host_metrics_unittest.cc

   1 // Copyright (c) 2012 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 "chrome/browser/spellchecker/spellcheck_host_metrics.h"
   6
   7 #include "base/basictypes.h"
   8 #include "base/memory/scoped_ptr.h"
   9 #include "base/message_loop/message_loop.h"
  10 #include "base/metrics/histogram.h"
  11 #include "base/metrics/histogram_samples.h"
  12 #include "base/metrics/statistics_recorder.h"
  13 #include "base/strings/utf_string_conversions.h"
  14 #include "testing/gtest/include/gtest/gtest.h"
  15
  16 #if defined(OS_WIN)
  17 // For version specific disabled tests below (http://crbug.com/230534).
  18 #include "base/win/windows_version.h"
  19 #endif
  20
  21 using base::HistogramBase;
  22 using base::HistogramSamples;
  23 using base::StatisticsRecorder;
  24
  25 class SpellcheckHostMetricsTest : public testing::Test {
  26  public:
  27   SpellcheckHostMetricsTest() : loop_(base::MessageLoop::TYPE_DEFAULT) {
  28   }
  29
  30   virtual void SetUp() OVERRIDE {
  31     base::StatisticsRecorder::Initialize();
  32     metrics_.reset(new SpellCheckHostMetrics);
  33   }
  34
  35   SpellCheckHostMetrics* metrics() { return metrics_.get(); }
  36   void RecordWordCountsForTesting() { metrics_->RecordWordCounts(); }
  37
  38  private:
  39   base::MessageLoop loop_;
  40   scoped_ptr<SpellCheckHostMetrics> metrics_;
  41 };
  42
  43 TEST_F(SpellcheckHostMetricsTest, RecordEnabledStats) {
  44   scoped_ptr<HistogramSamples> baseline;
  45   HistogramBase* histogram =
  46       StatisticsRecorder::FindHistogram("SpellCheck.Enabled");
  47   if (histogram)
  48     baseline = histogram->SnapshotSamples();
  49
  50   metrics()->RecordEnabledStats(false);
  51
  52   histogram =
  53       StatisticsRecorder::FindHistogram("SpellCheck.Enabled");
  54   ASSERT_TRUE(histogram != NULL);
  55   scoped_ptr<HistogramSamples> samples(histogram->SnapshotSamples());
  56   if (baseline.get())
  57     samples->Subtract(*baseline);
  58   EXPECT_EQ(1, samples->GetCount(0));
  59   EXPECT_EQ(0, samples->GetCount(1));
  60
  61   baseline.reset(samples.release());
  62
  63   metrics()->RecordEnabledStats(true);
  64
  65   histogram =
  66       StatisticsRecorder::FindHistogram("SpellCheck.Enabled");
  67   ASSERT_TRUE(histogram != NULL);
  68   samples = histogram->SnapshotSamples();
  69   samples->Subtract(*baseline);
  70   EXPECT_EQ(0, samples->GetCount(0));
  71   EXPECT_EQ(1, samples->GetCount(1));
  72 }
  73
  74 TEST_F(SpellcheckHostMetricsTest, CustomWordStats) {
  75 #if defined(OS_WIN)
  76 // Failing consistently on Win7. See crbug.com/230534.
  77   if (base::win::GetVersion() >= base::win::VERSION_VISTA)
  78     return;
  79 #endif
  80   SpellCheckHostMetrics::RecordCustomWordCountStats(123);
  81
  82   // Determine if test failures are due the statistics recorder not being
  83   // available or because the histogram just isn't there: crbug.com/230534.
  84   EXPECT_TRUE(StatisticsRecorder::IsActive());
  85
  86   HistogramBase* histogram =
  87       StatisticsRecorder::FindHistogram("SpellCheck.CustomWords");
  88   ASSERT_TRUE(histogram != NULL);
  89   scoped_ptr<HistogramSamples> baseline = histogram->SnapshotSamples();
  90
  91   SpellCheckHostMetrics::RecordCustomWordCountStats(23);
  92   histogram =
  93       StatisticsRecorder::FindHistogram("SpellCheck.CustomWords");
  94   ASSERT_TRUE(histogram != NULL);
  95   scoped_ptr<HistogramSamples> samples = histogram->SnapshotSamples();
  96
  97   samples->Subtract(*baseline);
  98   EXPECT_EQ(23,samples->sum());
  99 }
 100
 101 TEST_F(SpellcheckHostMetricsTest, RecordWordCountsDiscardsDuplicates) {
 102   // This test ensures that RecordWordCounts only records metrics if they
 103   // have changed from the last invocation.
 104   const char* histogramName[] = {
 105     "SpellCheck.CheckedWords",
 106     "SpellCheck.MisspelledWords",
 107     "SpellCheck.ReplacedWords",
 108     "SpellCheck.UniqueWords",
 109     "SpellCheck.ShownSuggestions"
 110   };
 111
 112   // Ensure all histograms exist.
 113   metrics()->RecordCheckedWordStats(string16(ASCIIToUTF16("test")), false);
 114   RecordWordCountsForTesting();
 115
 116   // Get baselines for all affected histograms.
 117   scoped_ptr<HistogramSamples> baselines[arraysize(histogramName)];
 118   for (size_t i = 0; i < arraysize(histogramName); ++i) {
 119     HistogramBase* histogram =
 120         StatisticsRecorder::FindHistogram(histogramName[i]);
 121     if (histogram)
 122       baselines[i] = histogram->SnapshotSamples();
 123   }
 124
 125   // Nothing changed, so this invocation should not affect any histograms.
 126   RecordWordCountsForTesting();
 127
 128   // Get samples for all affected histograms.
 129   scoped_ptr<HistogramSamples> samples[arraysize(histogramName)];
 130   for (size_t i = 0; i < arraysize(histogramName); ++i) {
 131     HistogramBase* histogram =
 132         StatisticsRecorder::FindHistogram(histogramName[i]);
 133     ASSERT_TRUE(histogram != NULL);
 134     samples[i] = histogram->SnapshotSamples();
 135     if (baselines[i].get())
 136       samples[i]->Subtract(*baselines[i]);
 137
 138     EXPECT_EQ(0, samples[i]->TotalCount());
 139   }
 140 }
 141
 142 TEST_F(SpellcheckHostMetricsTest, RecordSpellingServiceStats) {
 143   const char kMetricName[] = "SpellCheck.SpellingService.Enabled";
 144   scoped_ptr<HistogramSamples> baseline;
 145   HistogramBase* histogram = StatisticsRecorder::FindHistogram(kMetricName);
 146   if (histogram)
 147     baseline = histogram->SnapshotSamples();
 148
 149   metrics()->RecordSpellingServiceStats(false);
 150
 151   histogram =
 152       StatisticsRecorder::FindHistogram(kMetricName);
 153   ASSERT_TRUE(histogram != NULL);
 154   scoped_ptr<HistogramSamples> samples(histogram->SnapshotSamples());
 155   if (baseline.get())
 156     samples->Subtract(*baseline);
 157   EXPECT_EQ(1, samples->GetCount(0));
 158   EXPECT_EQ(0, samples->GetCount(1));
 159
 160   baseline.reset(samples.release());
 161
 162   metrics()->RecordSpellingServiceStats(true);
 163
 164   histogram =
 165       StatisticsRecorder::FindHistogram(kMetricName);
 166   ASSERT_TRUE(histogram != NULL);
 167   samples = histogram->SnapshotSamples();
 168   samples->Subtract(*baseline);
 169   EXPECT_EQ(0, samples->GetCount(0));
 170   EXPECT_EQ(1, samples->GetCount(1));
 171 }