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
|
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/keep_alive_registry/keep_alive_registry.h"
#include <memory>
#include "base/memory/raw_ptr.h"
#include "components/keep_alive_registry/keep_alive_state_observer.h"
#include "components/keep_alive_registry/keep_alive_types.h"
#include "components/keep_alive_registry/scoped_keep_alive.h"
#include "testing/gtest/include/gtest/gtest.h"
class KeepAliveRegistryTest : public testing::Test,
public KeepAliveStateObserver {
public:
KeepAliveRegistryTest()
: on_restart_allowed_call_count_(0),
on_restart_forbidden_call_count_(0),
start_keep_alive_call_count_(0),
stop_keep_alive_call_count_(0),
registry_(KeepAliveRegistry::GetInstance()) {
registry_->AddObserver(this);
EXPECT_FALSE(registry_->IsKeepingAlive());
}
~KeepAliveRegistryTest() override {
registry_->RemoveObserver(this);
EXPECT_FALSE(registry_->IsKeepingAlive());
}
void OnKeepAliveStateChanged(bool is_keeping_alive) override {
if (is_keeping_alive)
++start_keep_alive_call_count_;
else
++stop_keep_alive_call_count_;
}
void OnKeepAliveRestartStateChanged(bool can_restart) override {
if (can_restart)
++on_restart_allowed_call_count_;
else
++on_restart_forbidden_call_count_;
}
protected:
int on_restart_allowed_call_count_;
int on_restart_forbidden_call_count_;
int start_keep_alive_call_count_;
int stop_keep_alive_call_count_;
raw_ptr<KeepAliveRegistry> registry_;
};
// Test the IsKeepingAlive state and when we interact with the browser with
// a KeepAlive registered.
TEST_F(KeepAliveRegistryTest, BasicKeepAliveTest) {
EXPECT_EQ(0, start_keep_alive_call_count_);
EXPECT_EQ(0, stop_keep_alive_call_count_);
{
// Arbitrarily chosen Origin
ScopedKeepAlive test_keep_alive(KeepAliveOrigin::CHROME_APP_DELEGATE,
KeepAliveRestartOption::DISABLED);
// We should require the browser to stay alive
ASSERT_EQ(1, start_keep_alive_call_count_--); // decrement to ack
EXPECT_TRUE(registry_->IsKeepingAlive());
}
// We should be back to normal now, notifying of the state change.
ASSERT_EQ(1, stop_keep_alive_call_count_--);
EXPECT_FALSE(registry_->IsKeepingAlive());
// This should not have changed.
ASSERT_EQ(0, start_keep_alive_call_count_);
}
// Test the IsKeepingAlive state and when we interact with the browser with
// more than one KeepAlive registered.
TEST_F(KeepAliveRegistryTest, DoubleKeepAliveTest) {
EXPECT_EQ(0, start_keep_alive_call_count_);
EXPECT_EQ(0, stop_keep_alive_call_count_);
std::unique_ptr<ScopedKeepAlive> keep_alive_1, keep_alive_2;
keep_alive_1 = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::DISABLED);
ASSERT_EQ(1, start_keep_alive_call_count_--); // decrement to ack
EXPECT_TRUE(registry_->IsKeepingAlive());
keep_alive_2 = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::DISABLED);
// We should not increment the count twice
EXPECT_EQ(0, start_keep_alive_call_count_);
EXPECT_TRUE(registry_->IsKeepingAlive());
keep_alive_1.reset();
// We should not decrement the count before the last keep alive is released.
EXPECT_EQ(0, stop_keep_alive_call_count_);
EXPECT_TRUE(registry_->IsKeepingAlive());
keep_alive_2.reset();
ASSERT_EQ(1, stop_keep_alive_call_count_--);
EXPECT_EQ(0, start_keep_alive_call_count_);
EXPECT_FALSE(registry_->IsKeepingAlive());
}
// Test the IsKeepingAlive state and when we interact with the browser with
// more than one KeepAlive registered.
TEST_F(KeepAliveRegistryTest, RestartOptionTest) {
std::unique_ptr<ScopedKeepAlive> keep_alive, keep_alive_restart;
EXPECT_EQ(0, on_restart_allowed_call_count_);
EXPECT_EQ(0, on_restart_forbidden_call_count_);
// With a normal keep alive, restart should not be allowed
keep_alive = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::DISABLED);
ASSERT_EQ(1, on_restart_forbidden_call_count_--); // decrement to ack
// Restart should not be allowed if all KA don't allow it.
keep_alive_restart = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::ENABLED);
EXPECT_EQ(0, on_restart_allowed_call_count_);
// Now restart should be allowed, the only one left allows it.
keep_alive.reset();
ASSERT_EQ(1, on_restart_allowed_call_count_--);
// No keep alive, we should no prevent restarts.
keep_alive.reset();
EXPECT_EQ(0, on_restart_forbidden_call_count_);
// Make sure all calls were checked.
EXPECT_EQ(0, on_restart_allowed_call_count_);
EXPECT_EQ(0, on_restart_forbidden_call_count_);
}
// Check that KeepAliveState is changed on attempting restarting,
// if the remaining keepalive is only RestartOption::ENABLED.
TEST_F(KeepAliveRegistryTest, AttemptRestarting) {
std::unique_ptr<ScopedKeepAlive> keep_alive, keep_alive_restart;
EXPECT_EQ(0, on_restart_allowed_call_count_);
EXPECT_EQ(0, on_restart_forbidden_call_count_);
// With a normal keep alive, restart should not be allowed
keep_alive = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::DISABLED);
ASSERT_EQ(1, start_keep_alive_call_count_--); // decrement to ack
ASSERT_EQ(1, on_restart_forbidden_call_count_--);
// Restart should not be allowed if all KA don't allow it.
keep_alive_restart = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::ENABLED);
// No state change.
EXPECT_EQ(0, start_keep_alive_call_count_);
EXPECT_EQ(0, on_restart_allowed_call_count_);
// Now restart should be allowed, the only one left allows it.
keep_alive.reset();
EXPECT_EQ(0, start_keep_alive_call_count_);
ASSERT_EQ(1, on_restart_allowed_call_count_--);
EXPECT_TRUE(registry_->IsRestartAllowed());
// Trigger the restarting procedure.
registry_->SetRestarting();
ASSERT_EQ(1, stop_keep_alive_call_count_);
}
TEST_F(KeepAliveRegistryTest,
AttemptRestartingBeforeDestroyingDisabledKeepAlive) {
std::unique_ptr<ScopedKeepAlive> keep_alive, keep_alive_restart;
EXPECT_EQ(0, on_restart_allowed_call_count_);
EXPECT_EQ(0, on_restart_forbidden_call_count_);
// With a normal keep alive, restart should not be allowed
keep_alive = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::DISABLED);
ASSERT_EQ(1, start_keep_alive_call_count_--); // decrement to ack
ASSERT_EQ(1, on_restart_forbidden_call_count_--);
// Restart should not be allowed if all KA don't allow it.
keep_alive_restart = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveRestartOption::ENABLED);
// No state change.
EXPECT_EQ(0, start_keep_alive_call_count_);
EXPECT_EQ(0, on_restart_allowed_call_count_);
// Trigger the restarting procedure, during normal keep alive is still
// active.
registry_->SetRestarting();
EXPECT_EQ(0, stop_keep_alive_call_count_);
// Now restart should be allowed, the only one left allows it.
// This also updates KeepAliveState.
keep_alive.reset();
ASSERT_EQ(1, stop_keep_alive_call_count_--);
ASSERT_EQ(1, on_restart_allowed_call_count_--);
}
TEST_F(KeepAliveRegistryTest, WouldRestartWithoutTest) {
// WouldRestartWithout() should have the same results as IsRestartAllowed()
// when called with an empty vector.
std::vector<KeepAliveOrigin> empty_vector;
// Init and sanity checks.
ScopedKeepAlive kar(KeepAliveOrigin::BACKGROUND_MODE_MANAGER,
KeepAliveRestartOption::ENABLED);
ASSERT_TRUE(registry_->IsRestartAllowed());
EXPECT_EQ(registry_->IsRestartAllowed(),
registry_->WouldRestartWithout(empty_vector));
ScopedKeepAlive ka1(KeepAliveOrigin::CHROME_APP_DELEGATE,
KeepAliveRestartOption::DISABLED);
ASSERT_FALSE(registry_->IsRestartAllowed());
// Basic case: exclude one KeepAlive.
EXPECT_TRUE(
registry_->WouldRestartWithout({KeepAliveOrigin::CHROME_APP_DELEGATE}));
EXPECT_FALSE(registry_->WouldRestartWithout(
{KeepAliveOrigin::BACKGROUND_MODE_MANAGER}));
// Check it works properly with multiple KeepAlives of the same type
ScopedKeepAlive ka2(KeepAliveOrigin::CHROME_APP_DELEGATE,
KeepAliveRestartOption::DISABLED);
EXPECT_TRUE(
registry_->WouldRestartWithout({KeepAliveOrigin::CHROME_APP_DELEGATE}));
// Check it works properly with different KeepAlive types
ScopedKeepAlive ka3(KeepAliveOrigin::PANEL, KeepAliveRestartOption::DISABLED);
EXPECT_FALSE(
registry_->WouldRestartWithout({KeepAliveOrigin::CHROME_APP_DELEGATE}));
EXPECT_FALSE(registry_->WouldRestartWithout(
{KeepAliveOrigin::BACKGROUND_MODE_MANAGER}));
EXPECT_TRUE(registry_->WouldRestartWithout(
{KeepAliveOrigin::CHROME_APP_DELEGATE, KeepAliveOrigin::PANEL}));
EXPECT_EQ(registry_->IsRestartAllowed(),
registry_->WouldRestartWithout(empty_vector));
}
|
