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
|
// 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/offline_pages/task/task_queue.h"
#include <memory>
#include <utility>
#include "base/logging.h"
#include "base/memory/raw_ptr.h"
#include "base/task/single_thread_task_runner.h"
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/test_simple_task_runner.h"
#include "components/offline_pages/task/test_task.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace offline_pages {
class SimpleTask : public Task {
public:
SimpleTask(const std::string& name, std::vector<std::string>* events)
: events_(events), name_(name) {}
void Run() override {
events_->push_back("Run " + name_);
TaskComplete();
}
using Task::TaskComplete;
protected:
raw_ptr<std::vector<std::string>> events_;
std::string name_;
};
// A test task which suspends and waits for something to complete before
// resuming.
class SuspendingTask : public SimpleTask {
public:
SuspendingTask(const std::string& name,
std::vector<std::string>* events,
int suspend_count = 1)
: SimpleTask(name, events), suspend_count_(suspend_count) {}
~SuspendingTask() override { events_->push_back("Destroy " + name_); }
void Run() override {
events_->push_back("Run " + name_);
DoWork();
}
void DoResume() {
events_->push_back("DoResume " + name_);
Resume(
base::BindOnce(&SuspendingTask::TaskResumed, base::Unretained(this)));
}
void TaskResumed() {
events_->push_back("TaskResumed " + name_);
DoWork();
}
void Done() { TaskComplete(); }
private:
void DoWork() {
if (suspend_count_ > 0) {
--suspend_count_;
Suspend();
return;
}
Done();
}
int suspend_count_ = 0;
};
using TaskState = TestTask::TaskState;
class OfflineTaskQueueTest : public testing::Test, public TaskQueue::Delegate {
public:
OfflineTaskQueueTest();
~OfflineTaskQueueTest() override = default;
// TaskQueue::Delegate
void OnTaskQueueIsIdle() override;
void TaskCompleted(Task* task);
void PumpLoop();
Task* completed_task() const { return completed_task_; }
bool on_idle_called() { return on_idle_called_; }
private:
raw_ptr<Task> completed_task_ = nullptr;
scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
base::SingleThreadTaskRunner::CurrentDefaultHandle
task_runner_current_default_handle_;
bool on_idle_called_ = false;
};
OfflineTaskQueueTest::OfflineTaskQueueTest()
: task_runner_(new base::TestSimpleTaskRunner),
task_runner_current_default_handle_(task_runner_) {}
void OfflineTaskQueueTest::PumpLoop() {
task_runner_->RunUntilIdle();
}
void OfflineTaskQueueTest::OnTaskQueueIsIdle() {
on_idle_called_ = true;
}
void OfflineTaskQueueTest::TaskCompleted(Task* task) {
completed_task_ = task;
}
TEST_F(OfflineTaskQueueTest, AddAndRunSingleTask) {
ConsumedResource resource;
std::unique_ptr<TestTask> task(new TestTask(&resource));
TestTask* task_ptr = task.get();
TaskQueue queue(this);
EXPECT_FALSE(on_idle_called());
queue.AddTask(std::move(task));
EXPECT_TRUE(queue.HasPendingTasks());
EXPECT_TRUE(queue.HasRunningTask());
EXPECT_EQ(TaskState::NOT_STARTED, task_ptr->state());
PumpLoop(); // Start running the task.
EXPECT_EQ(TaskState::STEP_1, task_ptr->state());
EXPECT_TRUE(resource.HasNextStep());
resource.CompleteStep();
EXPECT_EQ(TaskState::STEP_2, task_ptr->state());
EXPECT_TRUE(resource.HasNextStep());
resource.CompleteStep();
EXPECT_EQ(TaskState::COMPLETED, task_ptr->state());
EXPECT_FALSE(resource.HasNextStep());
PumpLoop(); // Deletes task, task_ptr is invalid after that.
EXPECT_TRUE(on_idle_called());
EXPECT_FALSE(queue.HasRunningTask());
EXPECT_FALSE(queue.HasPendingTasks());
}
TEST_F(OfflineTaskQueueTest, AddAndRunMultipleTasks) {
ConsumedResource resource;
std::unique_ptr<TestTask> task_1(new TestTask(&resource));
TestTask* task_1_ptr = task_1.get();
std::unique_ptr<TestTask> task_2(new TestTask(&resource));
TestTask* task_2_ptr = task_2.get();
TaskQueue queue(this);
queue.AddTask(std::move(task_1));
queue.AddTask(std::move(task_2));
EXPECT_TRUE(queue.HasPendingTasks());
EXPECT_TRUE(queue.HasRunningTask());
EXPECT_EQ(TaskState::NOT_STARTED, task_1_ptr->state());
EXPECT_EQ(TaskState::NOT_STARTED, task_2_ptr->state());
PumpLoop(); // Start running the task 1.
EXPECT_EQ(TaskState::STEP_1, task_1_ptr->state());
EXPECT_EQ(TaskState::NOT_STARTED, task_2_ptr->state());
resource.CompleteStep();
EXPECT_EQ(TaskState::STEP_2, task_1_ptr->state());
EXPECT_EQ(TaskState::NOT_STARTED, task_2_ptr->state());
resource.CompleteStep();
EXPECT_EQ(TaskState::COMPLETED, task_1_ptr->state());
EXPECT_EQ(TaskState::NOT_STARTED, task_2_ptr->state());
PumpLoop(); // Deletes task_1, task_1_ptr is invalid after that.
EXPECT_EQ(TaskState::STEP_1, task_2_ptr->state());
EXPECT_FALSE(on_idle_called());
}
TEST_F(OfflineTaskQueueTest, LeaveEarly) {
ConsumedResource resource;
std::unique_ptr<TestTask> task(
new TestTask(&resource, true /* leave early */));
TestTask* task_ptr = task.get();
TaskQueue queue(this);
queue.AddTask(std::move(task));
EXPECT_TRUE(queue.HasPendingTasks());
EXPECT_TRUE(queue.HasRunningTask());
EXPECT_EQ(TaskState::NOT_STARTED, task_ptr->state());
PumpLoop(); // Start running the task.
EXPECT_EQ(TaskState::STEP_1, task_ptr->state());
EXPECT_TRUE(resource.HasNextStep());
resource.CompleteStep();
// Notice STEP_2 was omitted and task went from STEP_1 to completed.
EXPECT_EQ(TaskState::COMPLETED, task_ptr->state());
EXPECT_FALSE(resource.HasNextStep());
PumpLoop(); // Deletes task, task_ptr is invalid after that.
EXPECT_TRUE(on_idle_called());
EXPECT_FALSE(queue.HasPendingTasks());
EXPECT_FALSE(queue.HasRunningTask());
}
TEST_F(OfflineTaskQueueTest, SuspendAndResume) {
TaskQueue queue(this);
std::vector<std::string> events;
queue.AddTask(std::make_unique<SimpleTask>("T1", &events));
SuspendingTask* t2;
{
auto task = std::make_unique<SuspendingTask>("T2", &events);
t2 = task.get();
queue.AddTask(std::move(task));
}
PumpLoop();
queue.AddTask(std::make_unique<SimpleTask>("T3", &events));
PumpLoop();
queue.AddTask(std::make_unique<SimpleTask>("T4", &events));
t2->DoResume();
queue.AddTask(std::make_unique<SimpleTask>("T5", &events));
PumpLoop();
EXPECT_EQ(std::vector<std::string>({"Run T1", "Run T2", "Run T3",
"DoResume T2", "Run T4", "TaskResumed T2",
"Destroy T2", "Run T5"}),
events);
}
TEST_F(OfflineTaskQueueTest, SuspendResumeSuspend) {
TaskQueue queue(this);
std::vector<std::string> events;
queue.AddTask(std::make_unique<SimpleTask>("T1", &events));
SuspendingTask* t2;
{
auto task =
std::make_unique<SuspendingTask>("T2", &events, /*suspend_count=*/2);
t2 = task.get();
queue.AddTask(std::move(task));
}
PumpLoop();
t2->DoResume();
PumpLoop();
t2->DoResume();
PumpLoop();
EXPECT_EQ(std::vector<std::string>({"Run T1", "Run T2", "DoResume T2",
"TaskResumed T2", "DoResume T2",
"TaskResumed T2", "Destroy T2"}),
events);
}
TEST_F(OfflineTaskQueueTest, SuspendAndResumeNoOtherTasksRunning) {
TaskQueue queue(this);
std::vector<std::string> events;
SuspendingTask* t1;
{
auto task = std::make_unique<SuspendingTask>("T1", &events);
t1 = task.get();
queue.AddTask(std::move(task));
}
PumpLoop();
t1->DoResume();
PumpLoop();
EXPECT_EQ(std::vector<std::string>(
{"Run T1", "DoResume T1", "TaskResumed T1", "Destroy T1"}),
events);
}
TEST_F(OfflineTaskQueueTest, SuspendAndNeverResume) {
std::vector<std::string> events;
{
TaskQueue queue(this);
queue.AddTask(std::make_unique<SuspendingTask>("T1", &events));
PumpLoop();
}
EXPECT_EQ(std::vector<std::string>({"Run T1", "Destroy T1"}), events);
}
TEST_F(OfflineTaskQueueTest, CompleteWhileSuspended) {
TaskQueue queue(this);
std::vector<std::string> events;
SuspendingTask* t1;
{
auto task = std::make_unique<SuspendingTask>("T1", &events);
t1 = task.get();
queue.AddTask(std::move(task));
}
PumpLoop();
t1->Done();
PumpLoop();
EXPECT_EQ(std::vector<std::string>({"Run T1", "Destroy T1"}), events);
}
} // namespace offline_pages
|
