components/rappor/test_rappor_service.h

   1 // Copyright 2014 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 #ifndef COMPONENTS_RAPPOR_TEST_RAPPOR_SERVICE_H_
   6 #define COMPONENTS_RAPPOR_TEST_RAPPOR_SERVICE_H_
   7
   8 #include <map>
   9 #include <string>
  10
  11 #include "base/prefs/testing_pref_service.h"
  12 #include "components/rappor/rappor_service.h"
  13 #include "components/rappor/test_log_uploader.h"
  14
  15 namespace rappor {
  16
  17 // This class provides a simple instance that can be instantiated by tests
  18 // and examined to check that metrics were recorded.  It assumes the most
  19 // permissive settings so that any metric can be recorded.
  20 class TestRapporService : public RapporService {
  21  public:
  22   TestRapporService();
  23
  24   ~TestRapporService() override;
  25
  26   // Intercepts the sample being recorded and saves it in a test structure.
  27   void RecordSample(const std::string& metric_name,
  28                     RapporType type,
  29                     const std::string& sample) override;
  30
  31   // Gets the number of reports that would be uploaded by this service.
  32   // This also clears the internal map of metrics as a biproduct, so if
  33   // comparing numbers of reports, the comparison should be from the last time
  34   // GetReportsCount() was called (not from the beginning of the test).
  35   int GetReportsCount();
  36
  37   // Gets the reports proto that would be uploaded.
  38   // This clears the internal map of metrics.
  39   void GetReports(RapporReports* reports);
  40
  41   // Gets the recorded sample/type for a |metric_name|, and returns whether the
  42   // recorded metric was found. Limitation: if the metric was logged more than
  43   // once, this will return the latest sample that was logged.
  44   bool GetRecordedSampleForMetric(const std::string& metric_name,
  45                                   std::string* sample,
  46                                   RapporType* type);
  47
  48   void set_is_incognito(bool is_incognito) { is_incognito_ = is_incognito; }
  49
  50   TestingPrefServiceSimple* test_prefs() { return &test_prefs_; }
  51
  52   TestLogUploader* test_uploader() { return test_uploader_; }
  53
  54   base::TimeDelta next_rotation() { return next_rotation_; }
  55
  56  protected:
  57   // Cancels the next call to OnLogInterval.
  58   void CancelNextLogRotation() override;
  59
  60   // Schedules the next call to OnLogInterval.
  61   void ScheduleNextLogRotation(base::TimeDelta interval) override;
  62
  63  private:
  64   // Used to keep track of recorded RAPPOR samples.
  65   struct RapporSample {
  66     RapporType type;
  67     std::string value;
  68   };
  69   typedef std::map<std::string, RapporSample> SamplesMap;
  70   SamplesMap samples_;
  71
  72   TestingPrefServiceSimple test_prefs_;
  73
  74   // Holds a weak ref to the uploader_ object.
  75   TestLogUploader* test_uploader_;
  76
  77   // The last scheduled log rotation.
  78   base::TimeDelta next_rotation_;
  79
  80   // Sets this to true to mock incognito state.
  81   bool is_incognito_;
  82
  83   DISALLOW_COPY_AND_ASSIGN(TestRapporService);
  84 };
  85
  86 }  // namespace rappor
  87
  88 #endif  // COMPONENTS_RAPPOR_TEST_RAPPOR_SERVICE_H_