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
content / public / test / browser_task_environment.cc [blame]
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/public/test/browser_task_environment.h"
#include <utility>
#include "base/check.h"
#include "base/functional/bind.h"
#include "base/memory/ptr_util.h"
#include "base/memory/scoped_refptr.h"
#include "base/run_loop.h"
#include "base/task/current_thread.h"
#include "base/task/single_thread_task_runner.h"
#include "base/threading/thread.h"
#include "build/build_config.h"
#include "content/browser/after_startup_task_utils.h"
#include "content/browser/browser_process_io_thread.h"
#include "content/browser/browser_thread_impl.h"
#include "content/browser/scheduler/browser_io_thread_delegate.h"
#include "content/browser/scheduler/browser_task_executor.h"
#include "content/browser/scheduler/browser_task_priority.h"
#include "content/browser/scheduler/browser_ui_thread_scheduler.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/test/test_utils.h"
#if BUILDFLAG(IS_ANDROID)
#include "base/android/task_scheduler/post_task_android.h"
#endif
#if BUILDFLAG(IS_WIN)
#include "base/win/scoped_com_initializer.h"
#endif
namespace content {
class TestBrowserThread {
public:
// Creates and starts a TestBrowserThread with a MessagePumpForIO.
static std::unique_ptr<TestBrowserThread> StartIOThread();
// Constructs a TestBrowserThread "running" on |thread_runner| (no
// |real_thread_|).
TestBrowserThread(BrowserThread::ID identifier,
scoped_refptr<base::SingleThreadTaskRunner> thread_runner);
TestBrowserThread(const TestBrowserThread&) = delete;
TestBrowserThread& operator=(const TestBrowserThread&) = delete;
~TestBrowserThread();
// Stops the thread, no-op if this is not a real thread.
void Stop();
private:
explicit TestBrowserThread(
BrowserThread::ID identifier,
std::unique_ptr<BrowserProcessIOThread> real_thread);
const BrowserThread::ID identifier_;
// A real thread which represents |identifier_| when StartIOThread() is used
// (null otherwise).
std::unique_ptr<BrowserProcessIOThread> real_thread_;
// Binds |identifier_| to |thread_runner| when the public constructor is used
// (null otherwise).
std::unique_ptr<BrowserThreadImpl> fake_thread_;
};
// static
std::unique_ptr<TestBrowserThread> TestBrowserThread::StartIOThread() {
auto thread = base::WrapUnique(new TestBrowserThread(
BrowserThread::IO, BrowserTaskExecutor::CreateIOThread()));
thread->real_thread_->RegisterAsBrowserThread();
return thread;
}
TestBrowserThread::TestBrowserThread(
BrowserThread::ID identifier,
std::unique_ptr<BrowserProcessIOThread> real_thread)
: identifier_(identifier), real_thread_(std::move(real_thread)) {}
TestBrowserThread::TestBrowserThread(
BrowserThread::ID identifier,
scoped_refptr<base::SingleThreadTaskRunner> thread_runner)
: identifier_(identifier),
fake_thread_(
new BrowserThreadImpl(identifier_, std::move(thread_runner))) {}
TestBrowserThread::~TestBrowserThread() {
// The upcoming BrowserThreadImpl::ResetGlobalsForTesting() call requires that
// |identifier_| have completed its SHUTDOWN phase.
real_thread_.reset();
fake_thread_.reset();
// Resets BrowserThreadImpl's globals so that |identifier_| is no longer
// bound. This is fine since the underlying MessageLoop has already been
// flushed and deleted above. In the case of an externally provided
// MessageLoop however, this means that TaskRunners obtained through
// |BrowserThreadImpl::GetTaskRunnerForThread(identifier_)| will no longer
// recognize their BrowserThreadImpl for RunsTasksInCurrentSequence(). This
// happens most often when such verifications are made from
// CurrentThread::DestructionObservers. Callers that care to work around
// that should instead use this shutdown sequence:
// 1) TestBrowserThread::Stop()
// 2) ~MessageLoop()
// 3) ~TestBrowserThread()
// (~BrowserTaskEnvironment() does this).
BrowserThreadImpl::ResetGlobalsForTesting(identifier_);
}
void TestBrowserThread::Stop() {
if (real_thread_)
real_thread_->Stop();
}
// static
base::sequence_manager::SequenceManager::PrioritySettings
BrowserTaskEnvironment::CreateBrowserTaskPrioritySettings() {
return internal::CreateBrowserTaskPrioritySettings();
}
BrowserTaskEnvironment::~BrowserTaskEnvironment() {
// This is required to ensure we run all remaining MessageLoop and
// ThreadPool tasks in an atomic step. This is a bit different than
// production where the main thread is not flushed after it's done running
// but this approach is preferred in unit tests as running more tasks can
// merely uncover more issues (e.g. if a bad tasks is posted but never
// blocked upon it could make a test flaky whereas by flushing we guarantee
// it will blow up).
RunUntilIdle();
// When REAL_IO_THREAD, we need to stop the IO thread explicitly and flush
// again.
if (real_io_thread_) {
io_thread_->Stop();
RunUntilIdle();
}
// The only way this check can fail after RunUntilIdle() is if a test is
// running its own base::Thread's. Such tests should make sure to coalesce
// independent threads before this point.
CHECK(MainThreadIsIdle()) << sequence_manager()->DescribeAllPendingTasks();
BrowserTaskExecutor::ResetForTesting();
// Run DestructionObservers before our fake threads go away to ensure
// BrowserThread::CurrentlyOn() returns the results expected by the observers.
DestroyTaskEnvironment();
#if BUILDFLAG(IS_WIN)
com_initializer_.reset();
#endif
}
BrowserTaskEnvironment::BrowserTaskEnvironment(
base::test::TaskEnvironment&& task_environment,
bool real_io_thread)
: base::test::TaskEnvironment(std::move(task_environment)),
real_io_thread_(real_io_thread) {
Init();
}
void BrowserTaskEnvironment::Init() {
// Check that the UI thread hasn't already been initialized. This will fail if
// multiple BrowserTaskEnvironments are initialized in the same scope.
CHECK(!BrowserThread::IsThreadInitialized(BrowserThread::UI));
CHECK(!real_io_thread_ || !HasIOMainLoop()) << "Can't have two IO threads";
#if BUILDFLAG(IS_WIN)
// Similar to Chrome's UI thread, we need to initialize COM separately for
// this thread as we don't call Start() for the UI TestBrowserThread; it's
// already started!
com_initializer_ = std::make_unique<base::win::ScopedCOMInitializer>();
CHECK(com_initializer_->Succeeded());
#endif
if (GetMockTimeDomain())
sequence_manager()->SetTimeDomain(GetMockTimeDomain());
auto browser_ui_thread_scheduler =
BrowserUIThreadScheduler::CreateForTesting(sequence_manager());
auto default_ui_task_runner =
browser_ui_thread_scheduler->GetHandle()->GetDefaultTaskRunner();
auto browser_io_thread_delegate =
real_io_thread_
? std::make_unique<BrowserIOThreadDelegate>()
: BrowserIOThreadDelegate::CreateForTesting(sequence_manager());
browser_io_thread_delegate->SetAllowBlockingForTesting();
BrowserTaskExecutor::CreateForTesting(std::move(browser_ui_thread_scheduler),
std::move(browser_io_thread_delegate));
DeferredInitFromSubclass(std::move(default_ui_task_runner));
if (HasIOMainLoop()) {
CHECK(base::CurrentIOThread::IsSet());
} else if (main_thread_type() == MainThreadType::UI) {
CHECK(base::CurrentUIThread::IsSet());
}
// Set the current thread as the UI thread.
ui_thread_ = std::make_unique<TestBrowserThread>(
BrowserThread::UI, base::SingleThreadTaskRunner::GetCurrentDefault());
if (real_io_thread_) {
io_thread_ = TestBrowserThread::StartIOThread();
} else {
io_thread_ = std::make_unique<TestBrowserThread>(
BrowserThread::IO, base::SingleThreadTaskRunner::GetCurrentDefault());
}
// Consider startup complete such that after-startup-tasks always run in
// the scope of the test they were posted from (http://crbug.com/732018).
SetBrowserStartupIsCompleteForTesting();
// Some unittests check the number of pending tasks, which will include the
// one that enables the best effort queues, so run everything pending before
// we hand control over to the test.
// TODO(carlscab): Maybe find a better way to not expose control tasks
BrowserTaskExecutor::RunAllPendingTasksOnThreadForTesting(BrowserThread::UI);
BrowserTaskExecutor::RunAllPendingTasksOnThreadForTesting(BrowserThread::IO);
}
void BrowserTaskEnvironment::RunIOThreadUntilIdle() {
// Use a RunLoop to run until idle if already on BrowserThread::IO (which is
// the main thread unless using REAL_IO_THREAD).
DCHECK(!BrowserThread::CurrentlyOn(BrowserThread::IO));
base::WaitableEvent io_thread_idle(
base::WaitableEvent::ResetPolicy::MANUAL,
base::WaitableEvent::InitialState::NOT_SIGNALED);
GetIOThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(
[](base::WaitableEvent* io_thread_idle) {
base::RunLoop(base::RunLoop::Type::kNestableTasksAllowed)
.RunUntilIdle();
io_thread_idle->Signal();
},
Unretained(&io_thread_idle)));
io_thread_idle.Wait();
}
} // namespace content