File: metrics_reporter_unittest.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (222 lines) | stat: -rw-r--r-- 8,612 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/power/auto_screen_brightness/metrics_reporter.h"

#include <memory>

#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "chrome/common/pref_names.h"
#include "chromeos/dbus/power/fake_power_manager_client.h"
#include "components/metrics/daily_event.h"
#include "components/prefs/testing_pref_service.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace ash {
namespace power {
namespace auto_screen_brightness {

namespace {

constexpr auto kNoAls = MetricsReporter::DeviceClass::kNoAls;
constexpr auto kSupportedAls = MetricsReporter::DeviceClass::kSupportedAls;
constexpr auto kUnsupportedAls = MetricsReporter::DeviceClass::kUnsupportedAls;
constexpr auto kAtlas = MetricsReporter::DeviceClass::kAtlas;
constexpr auto kEve = MetricsReporter::DeviceClass::kEve;
constexpr auto kNocturne = MetricsReporter::DeviceClass::kNocturne;
constexpr auto kKohaku = MetricsReporter::DeviceClass::kKohaku;

}  // namespace

class MetricsReporterTest : public testing::Test {
 public:
  MetricsReporterTest() = default;

  MetricsReporterTest(const MetricsReporterTest&) = delete;
  MetricsReporterTest& operator=(const MetricsReporterTest&) = delete;

  ~MetricsReporterTest() override = default;

  void SetUp() override {
    chromeos::PowerManagerClient::InitializeFake();
    MetricsReporter::RegisterLocalStatePrefs(pref_service_.registry());
  }

  void TearDown() override {
    reporter_.reset();
    chromeos::PowerManagerClient::Shutdown();
  }

 protected:
  // Reinitialize |reporter_| without resetting underlying prefs. May be called
  // by tests to simulate a Chrome restart.
  void ResetReporter(MetricsReporter::DeviceClass device_class) {
    reporter_ = std::make_unique<MetricsReporter>(
        chromeos::PowerManagerClient::Get(), &pref_service_);
    reporter_->SetDeviceClass(device_class);
  }

  // Notifies |reporter_| that a user adjustment request is received.
  void SendOnUserBrightnessChangeRequested() {
    reporter_->OnUserBrightnessChangeRequested();
  }

  // Instructs |reporter_| to report daily metrics for reason |type|.
  void TriggerDailyEvent(metrics::DailyEvent::IntervalType type) {
    reporter_->ReportDailyMetricsForTesting(type);
  }

  // Instructs |reporter_| to report daily metrics due to the passage of a day
  // and verifies that it reports one sample with each of the passed values.
  void TriggerDailyEventAndVerifyHistograms(const std::string& histogram_name,
                                            int expected_count) {
    base::HistogramTester histogram_tester;

    TriggerDailyEvent(metrics::DailyEvent::IntervalType::DAY_ELAPSED);
    histogram_tester.ExpectUniqueSample(histogram_name, expected_count, 1);
  }

  base::test::TaskEnvironment task_environment_;
  TestingPrefServiceSimple pref_service_;
  std::unique_ptr<MetricsReporter> reporter_;
};

TEST_F(MetricsReporterTest, CountAndReportEvents) {
  // Three without ALS.
  ResetReporter(kNoAls);
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kNoAlsUserAdjustmentName, 3);

  // Two with unsupported ALS.
  ResetReporter(kUnsupportedAls);
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kUnsupportedAlsUserAdjustmentName, 2);

  // Two with supported ALS.
  ResetReporter(kSupportedAls);
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kSupportedAlsUserAdjustmentName, 2);

  // Two with Atlas.
  ResetReporter(kAtlas);
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kAtlasUserAdjustmentName, 2);

  // Three with Eve.
  ResetReporter(kEve);
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(MetricsReporter::kEveUserAdjustmentName,
                                       3);

  // The next day, another two with Eve.
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(MetricsReporter::kEveUserAdjustmentName,
                                       2);

  // Four with Nocturne.
  ResetReporter(kNocturne);
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kNocturneUserAdjustmentName, 4);

  // Three with Kohaku.
  ResetReporter(kKohaku);
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  SendOnUserBrightnessChangeRequested();
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kKohakuUserAdjustmentName, 3);
}

TEST_F(MetricsReporterTest, LoadInitialCountsFromPrefs) {
  // Create a new reporter and check that it loads its initial event counts from
  // prefs.
  pref_service_.SetInteger(
      prefs::kAutoScreenBrightnessMetricsNoAlsUserAdjustmentCount, 1);
  pref_service_.SetInteger(
      prefs::kAutoScreenBrightnessMetricsSupportedAlsUserAdjustmentCount, 2);
  pref_service_.SetInteger(
      prefs::kAutoScreenBrightnessMetricsAtlasUserAdjustmentCount, 2);
  pref_service_.SetInteger(
      prefs::kAutoScreenBrightnessMetricsEveUserAdjustmentCount, 4);
  pref_service_.SetInteger(
      prefs::kAutoScreenBrightnessMetricsNocturneUserAdjustmentCount, 3);
  ResetReporter(kAtlas);

  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kAtlasUserAdjustmentName, 2);

  // The previous report should've cleared the prefs, so a new reporter should
  // start out at zero.
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kAtlasUserAdjustmentName, 0);

  // Now test Kohaku.
  pref_service_.SetInteger(
      prefs::kAutoScreenBrightnessMetricsKohakuUserAdjustmentCount, 6);
  ResetReporter(kKohaku);
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kKohakuUserAdjustmentName, 6);
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kKohakuUserAdjustmentName, 0);
}

TEST_F(MetricsReporterTest, IgnoreDailyEventFirstRun) {
  ResetReporter(kAtlas);
  // metrics::DailyEvent notifies observers immediately on first run. Histograms
  // shouldn't be sent in this case.
  base::HistogramTester tester;
  TriggerDailyEvent(metrics::DailyEvent::IntervalType::FIRST_RUN);
  tester.ExpectTotalCount(MetricsReporter::kNoAlsUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kSupportedAlsUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kUnsupportedAlsUserAdjustmentName,
                          0);
  tester.ExpectTotalCount(MetricsReporter::kAtlasUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kEveUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kNocturneUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kKohakuUserAdjustmentName, 0);
}

TEST_F(MetricsReporterTest, IgnoreDailyEventClockChanged) {
  ResetReporter(kKohaku);
  SendOnUserBrightnessChangeRequested();

  // metrics::DailyEvent notifies observers if it sees that the system clock has
  // jumped back. Histograms shouldn't be sent in this case.
  base::HistogramTester tester;
  TriggerDailyEvent(metrics::DailyEvent::IntervalType::CLOCK_CHANGED);
  tester.ExpectTotalCount(MetricsReporter::kNoAlsUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kSupportedAlsUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kUnsupportedAlsUserAdjustmentName,
                          0);
  tester.ExpectTotalCount(MetricsReporter::kAtlasUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kEveUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kNocturneUserAdjustmentName, 0);
  tester.ExpectTotalCount(MetricsReporter::kKohakuUserAdjustmentName, 0);

  // The existing stats should be cleared when the clock change notification is
  // received, so the next report should only contain zeros.
  TriggerDailyEventAndVerifyHistograms(
      MetricsReporter::kKohakuUserAdjustmentName, 0);
}

}  // namespace auto_screen_brightness
}  // namespace power
}  // namespace ash