components/metrics/reporting_service_unittest.cc

   1 // Copyright 2014 The Chromium Authors
   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 "components/metrics/reporting_service.h"
   6
   7 #include <stdint.h>
   8
   9 #include <deque>
  10 #include <memory>
  11 #include <string>
  12
  13 #include "base/bind.h"
  14 #include "base/hash/sha1.h"
  15 #include "base/strings/string_util.h"
  16 #include "base/test/test_simple_task_runner.h"
  17 #include "base/threading/thread_task_runner_handle.h"
  18 #include "components/metrics/log_store.h"
  19 #include "components/metrics/test/test_metrics_service_client.h"
  20 #include "components/prefs/testing_pref_service.h"
  21 #include "testing/gtest/include/gtest/gtest.h"
  22 #include "third_party/zlib/google/compression_utils.h"
  23
  24 namespace metrics {
  25
  26 namespace {
  27
  28 // Represent a flushed log and its metadata to be used for testing.
  29 struct TestLog {
  30   explicit TestLog(const std::string& log) : log(log), user_id(absl::nullopt) {}
  31   TestLog(const std::string& log, uint64_t user_id)
  32       : log(log), user_id(user_id) {}
  33   TestLog(const TestLog& other) = default;
  34   ~TestLog() = default;
  35
  36   const std::string log;
  37   const absl::optional<uint64_t> user_id;
  38 };
  39
  40 const char kTestUploadUrl[] = "test_url";
  41 const char kTestMimeType[] = "test_mime_type";
  42
  43 class TestLogStore : public LogStore {
  44  public:
  45   TestLogStore() = default;
  46   ~TestLogStore() override = default;
  47
  48   void AddLog(const TestLog& log) { logs_.push_back(log); }
  49
  50   // LogStore:
  51   bool has_unsent_logs() const override { return !logs_.empty(); }
  52   bool has_staged_log() const override { return !staged_log_hash_.empty(); }
  53   const std::string& staged_log() const override { return logs_.front().log; }
  54   const std::string& staged_log_hash() const override {
  55     return staged_log_hash_;
  56   }
  57   absl::optional<uint64_t> staged_log_user_id() const override {
  58     return logs_.front().user_id;
  59   }
  60   const std::string& staged_log_signature() const override {
  61     return base::EmptyString();
  62   }
  63   void StageNextLog() override {
  64     if (has_unsent_logs()) {
  65       staged_log_hash_ = base::SHA1HashString(logs_.front().log);
  66     }
  67   }
  68   void DiscardStagedLog() override {
  69     if (!has_staged_log())
  70       return;
  71     logs_.pop_front();
  72     staged_log_hash_.clear();
  73   }
  74   void MarkStagedLogAsSent() override {}
  75   void TrimAndPersistUnsentLogs(bool overwrite_in_memory_store) override {}
  76   void LoadPersistedUnsentLogs() override {}
  77
  78  private:
  79   std::string staged_log_hash_;
  80   std::deque<TestLog> logs_;
  81 };
  82
  83 class TestReportingService : public ReportingService {
  84  public:
  85   TestReportingService(MetricsServiceClient* client, PrefService* local_state)
  86       : ReportingService(client,
  87                          local_state,
  88                          100,
  89                          /*logs_event_manager=*/nullptr) {
  90     Initialize();
  91   }
  92
  93   TestReportingService(const TestReportingService&) = delete;
  94   TestReportingService& operator=(const TestReportingService&) = delete;
  95
  96   ~TestReportingService() override {}
  97
  98   void AddLog(const TestLog& log) { log_store_.AddLog(log); }
  99
 100  private:
 101   // ReportingService:
 102   LogStore* log_store() override { return &log_store_; }
 103   GURL GetUploadUrl() const override { return GURL(kTestUploadUrl); }
 104   GURL GetInsecureUploadUrl() const override { return GURL(kTestUploadUrl); }
 105   base::StringPiece upload_mime_type() const override { return kTestMimeType; }
 106   MetricsLogUploader::MetricServiceType service_type() const override {
 107     return MetricsLogUploader::MetricServiceType::UMA;
 108   }
 109
 110   TestLogStore log_store_;
 111 };
 112
 113 class ReportingServiceTest : public testing::Test {
 114  public:
 115   ReportingServiceTest()
 116       : task_runner_(new base::TestSimpleTaskRunner),
 117         task_runner_handle_(task_runner_) {
 118     ReportingService::RegisterPrefs(testing_local_state_.registry());
 119   }
 120
 121   ReportingServiceTest(const ReportingServiceTest&) = delete;
 122   ReportingServiceTest& operator=(const ReportingServiceTest&) = delete;
 123
 124   ~ReportingServiceTest() override {}
 125
 126   PrefService* GetLocalState() { return &testing_local_state_; }
 127
 128  protected:
 129   scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
 130   base::ThreadTaskRunnerHandle task_runner_handle_;
 131   TestMetricsServiceClient client_;
 132
 133  private:
 134   TestingPrefServiceSimple testing_local_state_;
 135 };
 136
 137 }  // namespace
 138
 139 TEST_F(ReportingServiceTest, BasicTest) {
 140   TestReportingService service(&client_, GetLocalState());
 141   service.AddLog(TestLog("log1"));
 142   service.AddLog(TestLog("log2"));
 143
 144   service.EnableReporting();
 145   task_runner_->RunPendingTasks();
 146   client_.uploader()->is_uploading();
 147   EXPECT_TRUE(client_.uploader()->is_uploading());
 148   EXPECT_EQ(1, client_.uploader()->reporting_info().attempt_count());
 149   EXPECT_FALSE(client_.uploader()->reporting_info().has_last_response_code());
 150
 151   client_.uploader()->CompleteUpload(404);
 152   task_runner_->RunPendingTasks();
 153   EXPECT_TRUE(client_.uploader()->is_uploading());
 154   EXPECT_EQ(2, client_.uploader()->reporting_info().attempt_count());
 155   EXPECT_EQ(404, client_.uploader()->reporting_info().last_response_code());
 156
 157   client_.uploader()->CompleteUpload(200);
 158   task_runner_->RunPendingTasks();
 159   EXPECT_TRUE(client_.uploader()->is_uploading());
 160   EXPECT_EQ(1, client_.uploader()->reporting_info().attempt_count());
 161   EXPECT_EQ(200, client_.uploader()->reporting_info().last_response_code());
 162
 163   client_.uploader()->CompleteUpload(200);
 164   EXPECT_EQ(0U, task_runner_->NumPendingTasks());
 165   EXPECT_FALSE(client_.uploader()->is_uploading());
 166 }
 167
 168 TEST_F(ReportingServiceTest, UserIdLogsUploadedIfUserConsented) {
 169   uint64_t user_id = 12345;
 170
 171   TestReportingService service(&client_, GetLocalState());
 172   service.AddLog(TestLog("log1", user_id));
 173   service.AddLog(TestLog("log2", user_id));
 174   service.EnableReporting();
 175   client_.AllowMetricUploadForUserId(user_id);
 176
 177   task_runner_->RunPendingTasks();
 178   EXPECT_TRUE(client_.uploader()->is_uploading());
 179   EXPECT_EQ(1, client_.uploader()->reporting_info().attempt_count());
 180   EXPECT_FALSE(client_.uploader()->reporting_info().has_last_response_code());
 181   client_.uploader()->CompleteUpload(200);
 182
 183   // Upload 2nd log and last response code logged.
 184   task_runner_->RunPendingTasks();
 185   EXPECT_EQ(200, client_.uploader()->reporting_info().last_response_code());
 186   EXPECT_TRUE(client_.uploader()->is_uploading());
 187
 188   client_.uploader()->CompleteUpload(200);
 189   EXPECT_EQ(0U, task_runner_->NumPendingTasks());
 190   EXPECT_FALSE(client_.uploader()->is_uploading());
 191 }
 192
 193 TEST_F(ReportingServiceTest, UserIdLogsNotUploadedIfUserNotConsented) {
 194   TestReportingService service(&client_, GetLocalState());
 195   service.AddLog(TestLog("log1", 12345));
 196   service.AddLog(TestLog("log2", 12345));
 197   service.EnableReporting();
 198
 199   // Log with user id should never be in uploading state if user upload
 200   // disabled. |client_.uploader()| should be nullptr since it is lazily
 201   // created when a log is to be uploaded for the first time.
 202   EXPECT_EQ(client_.uploader(), nullptr);
 203 }
 204
 205 }  // namespace metrics