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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_USER_EDUCATION_TEST_USER_EDUCATION_SESSION_TEST_UTIL_H_
#define COMPONENTS_USER_EDUCATION_TEST_USER_EDUCATION_SESSION_TEST_UTIL_H_
#include <memory>
#include <optional>
#include "base/memory/raw_ref.h"
#include "base/test/simple_test_clock.h"
#include "base/time/time.h"
namespace user_education {
struct FeaturePromoPolicyData;
struct UserEducationSessionData;
class UserEducationSessionManager;
class UserEducationStorageService;
} // namespace user_education
namespace user_education::test {
class TestIdleObserver;
// Class which seizes control of a `UserEducationSessionManager` and its
// associated session data, and gives a test fine control over the clock and the
// active state of the current session, simulating active and inactive periods.
//
// This object should not outlive the session manager itself. Also, once this
// object has been attached to a session manager, it will no longer receive
// normal session updated, even after this object is destroyed, to avoid
// spurious events occurring at the end of a test or during teardown.
//
// USAGE NOTE: for browser-based tests, prefer using
// `InteractiveFeaturePromoTest[T]` instead of directly using this class.
class UserEducationSessionTestUtil {
public:
// Creates the util object and seizes control of the session manager.
// If `new_now` is set, also replaces the system clock with a test clock.
UserEducationSessionTestUtil(UserEducationSessionManager& session_manager,
const UserEducationSessionData& session_data,
const FeaturePromoPolicyData& policy_data,
std::optional<base::Time> new_last_active_time,
std::optional<base::Time> new_now);
virtual ~UserEducationSessionTestUtil();
UserEducationSessionTestUtil(const UserEducationSessionTestUtil&) = delete;
void operator=(const UserEducationSessionTestUtil&) = delete;
// Returns the current time, whether from the test or "real" clock.
base::Time Now() const { return clock_ ? clock_->Now() : base::Time::Now(); }
// Sets the current time if using a test clock; fails if using the real clock.
void SetNow(base::Time new_now);
void UpdateLastActiveTime(std::optional<base::Time> new_active_time,
bool send_update);
private:
const raw_ref<UserEducationSessionManager> session_manager_;
const raw_ref<UserEducationStorageService> storage_service_;
raw_ptr<TestIdleObserver> idle_observer_ = nullptr;
std::unique_ptr<base::SimpleTestClock> clock_;
};
} // namespace user_education::test
#endif // COMPONENTS_USER_EDUCATION_TEST_USER_EDUCATION_SESSION_TEST_UTIL_H_
|
