File: periodic_metrics_service_unittest.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (302 lines) | stat: -rw-r--r-- 11,485 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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <string>

#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "base/time/time.h"
#include "chrome/browser/ash/app_mode/metrics/periodic_metrics_service.h"
#include "chrome/common/pref_names.h"
#include "chrome/test/base/scoped_testing_local_state.h"
#include "chrome/test/base/testing_browser_process.h"
#include "chromeos/ash/components/network/network_handler_test_helper.h"
#include "chromeos/ash/components/sync_wifi/network_test_helper.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/base/user_activity/user_activity_detector.h"

namespace ash {

namespace {

struct KioskSessionInternetAccessTestCase {
  std::string test_name;
  bool is_first_app_offline_enabled;
  bool is_second_app_offline_enabled;
  bool should_make_offline;
  KioskInternetAccessInfo expected_metric;
};

struct KioskSessionUserActivityTestCase {
  std::string test_name;
  base::TimeDelta idle_timeout;
  KioskUserActivity expected_metric;
};

}  // namespace

class BasePeriodicMetricsServiceTest {
 public:
  BasePeriodicMetricsServiceTest()
      : task_environment_(base::test::TaskEnvironment::TimeSource::MOCK_TIME),
        local_state_(std::make_unique<ScopedTestingLocalState>(
            TestingBrowserProcess::GetGlobal())),
        network_handler_test_helper_(
            std::make_unique<NetworkHandlerTestHelper>()),
        periodic_metrics_service_(local_state()),
        histogram_tester_(std::make_unique<base::HistogramTester>()) {}

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

  base::test::TaskEnvironment* task_environment() { return &task_environment_; }

  TestingPrefServiceSimple* local_state() { return local_state_->Get(); }

  base::HistogramTester* histogram_tester() { return histogram_tester_.get(); }

  void RecordPreviousSessionMetrics() {
    periodic_metrics_service_.RecordPreviousSessionMetrics();
  }

  void StartRecordingPeriodicMetrics(bool is_offline_enabled = true) {
    periodic_metrics_service_.StartRecordingPeriodicMetrics(is_offline_enabled);
    // Some periodic metrics are calculated asynchronously.
    task_environment_.RunUntilIdle();
  }

  void EmulateKioskRestart(bool is_first_app_offline_enabled = true,
                           bool is_second_app_offline_enabled = true) {
    // Emulate running a kiosk session.
    RecordPreviousSessionMetrics();
    StartRecordingPeriodicMetrics(is_first_app_offline_enabled);
    // Nothing was saved in prefs. That means the kiosk session started the
    // first time.
    histogram_tester()->ExpectTotalCount(
        kKioskSessionRestartInternetAccessHistogram, 0);
    histogram_tester()->ExpectTotalCount(
        kKioskSessionRestartUserActivityHistogram, 0);

    // Emulate kiosk session restart.
    RecordPreviousSessionMetrics();
    StartRecordingPeriodicMetrics(is_second_app_offline_enabled);
  }

 protected:
  content::BrowserTaskEnvironment task_environment_;
  sync_preferences::TestingPrefServiceSyncable user_prefs_;
  std::unique_ptr<ScopedTestingLocalState> local_state_;
  std::unique_ptr<NetworkHandlerTestHelper> network_handler_test_helper_;
  PeriodicMetricsService periodic_metrics_service_;
  std::unique_ptr<base::HistogramTester> histogram_tester_;
};

class PeriodicMetricsServiceTest : public BasePeriodicMetricsServiceTest,
                                   public ::testing::Test {
 public:
  PeriodicMetricsServiceTest() = default;
  PeriodicMetricsServiceTest(const PeriodicMetricsServiceTest&) = delete;
  PeriodicMetricsServiceTest& operator=(const PeriodicMetricsServiceTest&) =
      delete;
};

TEST_F(PeriodicMetricsServiceTest, PeriodicMetrics) {
  const char* const kPeriodicMetrics[] = {
      kKioskRamUsagePercentageHistogram, kKioskSwapUsagePercentageHistogram,
      kKioskDiskUsagePercentageHistogram, kKioskChromeProcessCountHistogram};
  for (const char* metric : kPeriodicMetrics) {
    histogram_tester()->ExpectTotalCount(metric, 0);
  }

  StartRecordingPeriodicMetrics();
  // Check that periodic metrics were recoreded right calling
  // `StartRecordingPeriodicMetrics`.
  for (const char* metric : kPeriodicMetrics) {
    histogram_tester()->ExpectTotalCount(metric, 1);
  }

  // Next time periodic metrics should be recorded only after
  // `kPeriodicMetricsInterval`.
  task_environment()->FastForwardBy(kPeriodicMetricsInterval / 2);
  for (const char* metric : kPeriodicMetrics) {
    histogram_tester()->ExpectTotalCount(metric, 1);
  }

  task_environment()->FastForwardBy(kPeriodicMetricsInterval / 2);
  for (const char* metric : kPeriodicMetrics) {
    histogram_tester()->ExpectTotalCount(metric, 2);
  }
}

class InternetPeriodicMetricsServiceTest
    : public ::testing::TestWithParam<KioskSessionInternetAccessTestCase>,
      public BasePeriodicMetricsServiceTest {
 public:
  InternetPeriodicMetricsServiceTest() = default;
  InternetPeriodicMetricsServiceTest(
      const InternetPeriodicMetricsServiceTest&) = delete;
  InternetPeriodicMetricsServiceTest& operator=(
      const InternetPeriodicMetricsServiceTest&) = delete;

  void SetUp() override { network_handler_test_helper_->AddDefaultProfiles(); }

  void TearDown() override {
    network_handler_test_helper_.reset();
    local_state()->RemoveUserPref(prefs::kKioskMetrics);
  }

  void MakeOffline() {
    network_handler_test_helper_->ResetDevicesAndServices();
  }
};

TEST_P(InternetPeriodicMetricsServiceTest, KioskInternetMetric) {
  const KioskSessionInternetAccessTestCase& test_config = GetParam();
  if (test_config.should_make_offline) {
    MakeOffline();
  }

  EmulateKioskRestart(test_config.is_first_app_offline_enabled,
                      test_config.is_second_app_offline_enabled);
  histogram_tester()->ExpectBucketCount(
      kKioskSessionRestartInternetAccessHistogram, test_config.expected_metric,
      1);
  histogram_tester()->ExpectTotalCount(
      kKioskSessionRestartInternetAccessHistogram, 1);
}

INSTANTIATE_TEST_SUITE_P(
    InternetAccessInfos,
    InternetPeriodicMetricsServiceTest,
    testing::ValuesIn<KioskSessionInternetAccessTestCase>({
        {/*test_name=*/"OnlineAndAppSupportsOffline",
         /*is_first_app_offline_enabled=*/true,
         /*is_second_app_offline_enabled=*/true, /*should_make_offline=*/false,
         /*expected_metric=*/
         KioskInternetAccessInfo::kOnlineAndAppSupportsOffline},
        {/*test_name=*/"OfflineAndAppSupportsOffline",
         /*is_first_app_offline_enabled=*/true,
         /*is_second_app_offline_enabled=*/true, /*should_make_offline=*/true,
         /*expected_metric=*/
         KioskInternetAccessInfo::kOfflineAndAppSupportsOffline},
        {/*test_name=*/"OfflineAndAppRequiresInternet",
         /*is_first_app_offline_enabled=*/false,
         /*is_second_app_offline_enabled=*/false, /*should_make_offline=*/true,
         /*expected_metric=*/
         KioskInternetAccessInfo::kOfflineAndAppRequiresInternet},
        {/*test_name=*/"DifferentSupportOfflineMode",
         /*is_first_app_offline_enabled=*/false,
         /*is_second_app_offline_enabled=*/true, /*should_make_offline=*/false,
         /*expected_metric=*/
         KioskInternetAccessInfo::kOnlineAndAppRequiresInternet},
    }),
    [](const testing::TestParamInfo<
        InternetPeriodicMetricsServiceTest::ParamType>& info) {
      return info.param.test_name;
    });

class UserActivityPeriodicMetricsServiceTest
    : public ::testing::TestWithParam<KioskSessionUserActivityTestCase>,
      public BasePeriodicMetricsServiceTest {
 public:
  UserActivityPeriodicMetricsServiceTest() = default;
  UserActivityPeriodicMetricsServiceTest(
      const UserActivityPeriodicMetricsServiceTest&) = delete;
  UserActivityPeriodicMetricsServiceTest& operator=(
      const UserActivityPeriodicMetricsServiceTest&) = delete;

  void TearDown() override {
    local_state()->RemoveUserPref(prefs::kKioskMetrics);
  }

  void SetDeviceIdleTime(base::TimeDelta idle_time,
                         base::TimeTicks from_time = base::TimeTicks::Now()) {
    ui::UserActivityDetector::Get()->set_last_activity_time_for_test(from_time -
                                                                     idle_time);
  }
};

TEST_P(UserActivityPeriodicMetricsServiceTest, KioskUserActivityMetric) {
  const KioskSessionUserActivityTestCase& test_config = GetParam();

  SetDeviceIdleTime(test_config.idle_timeout);
  EmulateKioskRestart();

  histogram_tester()->ExpectBucketCount(
      kKioskSessionRestartUserActivityHistogram, test_config.expected_metric,
      1);
  histogram_tester()->ExpectTotalCount(
      kKioskSessionRestartUserActivityHistogram, 1);
}

INSTANTIATE_TEST_SUITE_P(
    UserActivityInfos,
    UserActivityPeriodicMetricsServiceTest,
    testing::ValuesIn<KioskSessionUserActivityTestCase>({
        {/*test_name=*/"UserActiv",
         /*idle_timeout=*/base::Seconds(0),
         /*expected_metric=*/KioskUserActivity::kActive},
        {/*test_name=*/"UserAlmostIdle",
         /*idle_timeout=*/kFirstIdleTimeout / 2,
         /*expected_metric=*/KioskUserActivity::kActive},
        {/*test_name=*/"UserIdle",
         /*idle_timeout=*/kFirstIdleTimeout,
         /*expected_metric=*/KioskUserActivity::kIdle},
    }),
    [](const testing::TestParamInfo<
        UserActivityPeriodicMetricsServiceTest::ParamType>& info) {
      return info.param.test_name;
    });

// Check that after the first metrics record, ChromeOS is using a new idle
// timeout.
TEST_F(UserActivityPeriodicMetricsServiceTest, UserActivityTimeoutChanged) {
  ASSERT_TRUE(kFirstIdleTimeout < kRegularIdleTimeout / 2);
  SetDeviceIdleTime(kFirstIdleTimeout);

  // Emulate running a kiosk session. The user is idle.
  RecordPreviousSessionMetrics();
  StartRecordingPeriodicMetrics();

  // User was active during.
  SetDeviceIdleTime(
      kRegularIdleTimeout / 2,
      /*from_time=*/base::TimeTicks::Now() + kPeriodicMetricsInterval);
  task_environment()->FastForwardBy(kPeriodicMetricsInterval);

  // Emulate kiosk session restart.
  RecordPreviousSessionMetrics();

  histogram_tester()->ExpectBucketCount(
      kKioskSessionRestartUserActivityHistogram, KioskUserActivity::kActive, 1);
  histogram_tester()->ExpectTotalCount(
      kKioskSessionRestartUserActivityHistogram, 1);
}

TEST_F(UserActivityPeriodicMetricsServiceTest, UserBecomesIdle) {
  ASSERT_TRUE(kFirstIdleTimeout < kRegularIdleTimeout / 2);
  SetDeviceIdleTime(kFirstIdleTimeout / 2);

  // Emulate running a kiosk session.
  RecordPreviousSessionMetrics();
  StartRecordingPeriodicMetrics();

  // User becomes idle and metrics should be updated because of the timeout.
  SetDeviceIdleTime(kRegularIdleTimeout, /*from_time=*/base::TimeTicks::Now() +
                                             kPeriodicMetricsInterval);
  task_environment()->FastForwardBy(kPeriodicMetricsInterval);

  // Emulate kiosk session restart.
  RecordPreviousSessionMetrics();

  histogram_tester()->ExpectBucketCount(
      kKioskSessionRestartUserActivityHistogram, KioskUserActivity::kIdle, 1);
  histogram_tester()->ExpectTotalCount(
      kKioskSessionRestartUserActivityHistogram, 1);
}

}  // namespace ash