blob: 5cc57148d4691997d4852bfbe8e39f59dd9b4a12 [file] [log] [blame]
fdoraya4f28ec2016-06-10 00:08:581// Copyright 2016 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "base/run_loop.h"
6
jdoerrie9d7236f62019-03-05 13:00:237#include <functional>
Gabriel Charettee2b632b2017-08-02 03:52:168#include <utility>
9
fdoraya4f28ec2016-06-10 00:08:5810#include "base/bind.h"
11#include "base/bind_helpers.h"
Brett Wilsona62d9c02017-09-20 20:53:2012#include "base/containers/queue.h"
fdoraya4f28ec2016-06-10 00:08:5813#include "base/location.h"
14#include "base/macros.h"
Gabriel Charettee2b632b2017-08-02 03:52:1615#include "base/memory/ptr_util.h"
16#include "base/memory/ref_counted.h"
fdoraya4f28ec2016-06-10 00:08:5817#include "base/single_thread_task_runner.h"
Gabriel Charettee2b632b2017-08-02 03:52:1618#include "base/synchronization/lock.h"
gabcf5e4ce2017-05-19 22:56:5719#include "base/synchronization/waitable_event.h"
Wezbbffcc52019-02-21 02:01:2020#include "base/test/bind_test_util.h"
Gabriel Charettee2b632b2017-08-02 03:52:1621#include "base/test/gtest_util.h"
Wez9d5dd282020-02-10 17:21:2222#include "base/test/scoped_run_loop_timeout.h"
Gabriel Charettec7108742019-08-23 03:31:4023#include "base/test/task_environment.h"
Gabriel Charette3ff403e2017-08-07 04:22:4824#include "base/test/test_timeouts.h"
Gabriel Charettee2b632b2017-08-02 03:52:1625#include "base/threading/platform_thread.h"
Wezd9e4cb772019-01-09 03:07:0326#include "base/threading/sequenced_task_runner_handle.h"
Gabriel Charettee2b632b2017-08-02 03:52:1627#include "base/threading/thread.h"
28#include "base/threading/thread_checker_impl.h"
fdoraya4f28ec2016-06-10 00:08:5829#include "base/threading/thread_task_runner_handle.h"
Wez212eeb72020-02-04 17:54:5430#include "base/time/time.h"
Gabriel Charettee2b632b2017-08-02 03:52:1631#include "build/build_config.h"
gab7af9dc02017-05-05 13:38:5432#include "testing/gmock/include/gmock/gmock.h"
Wez212eeb72020-02-04 17:54:5433#include "testing/gtest/include/gtest/gtest-spi.h"
fdoraya4f28ec2016-06-10 00:08:5834#include "testing/gtest/include/gtest/gtest.h"
35
36namespace base {
37
38namespace {
39
40void QuitWhenIdleTask(RunLoop* run_loop, int* counter) {
41 run_loop->QuitWhenIdle();
42 ++(*counter);
43}
44
fdoraya4f28ec2016-06-10 00:08:5845void RunNestedLoopTask(int* counter) {
Gabriel Charette3ff403e2017-08-07 04:22:4846 RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
fdoraya4f28ec2016-06-10 00:08:5847
48 // This task should quit |nested_run_loop| but not the main RunLoop.
49 ThreadTaskRunnerHandle::Get()->PostTask(
tzik92b7a422017-04-11 15:00:4450 FROM_HERE, BindOnce(&QuitWhenIdleTask, Unretained(&nested_run_loop),
51 Unretained(counter)));
fdoraya4f28ec2016-06-10 00:08:5852
53 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
Wezbbffcc52019-02-21 02:01:2054 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), TimeDelta::FromDays(1));
fdoraya4f28ec2016-06-10 00:08:5855
fdoraya4f28ec2016-06-10 00:08:5856 nested_run_loop.Run();
57
58 ++(*counter);
59}
60
Gabriel Charettee2b632b2017-08-02 03:52:1661// A simple SingleThreadTaskRunner that just queues undelayed tasks (and ignores
62// delayed tasks). Tasks can then be processed one by one by ProcessTask() which
63// will return true if it processed a task and false otherwise.
64class SimpleSingleThreadTaskRunner : public SingleThreadTaskRunner {
65 public:
66 SimpleSingleThreadTaskRunner() = default;
fdoraya4f28ec2016-06-10 00:08:5867
Brett Wilson8e88b312017-09-12 05:22:1668 bool PostDelayedTask(const Location& from_here,
Gabriel Charettee2b632b2017-08-02 03:52:1669 OnceClosure task,
70 base::TimeDelta delay) override {
71 if (delay > base::TimeDelta())
72 return false;
73 AutoLock auto_lock(tasks_lock_);
74 pending_tasks_.push(std::move(task));
75 return true;
76 }
77
Brett Wilson8e88b312017-09-12 05:22:1678 bool PostNonNestableDelayedTask(const Location& from_here,
Gabriel Charettee2b632b2017-08-02 03:52:1679 OnceClosure task,
80 base::TimeDelta delay) override {
81 return PostDelayedTask(from_here, std::move(task), delay);
82 }
83
84 bool RunsTasksInCurrentSequence() const override {
85 return origin_thread_checker_.CalledOnValidThread();
86 }
87
Gabriel Charette1ef212b2017-12-03 12:47:2188 bool ProcessSingleTask() {
Gabriel Charettee2b632b2017-08-02 03:52:1689 OnceClosure task;
90 {
91 AutoLock auto_lock(tasks_lock_);
92 if (pending_tasks_.empty())
93 return false;
94 task = std::move(pending_tasks_.front());
95 pending_tasks_.pop();
96 }
97 // It's important to Run() after pop() and outside the lock as |task| may
Gabriel Charette1ef212b2017-12-03 12:47:2198 // run a nested loop which will re-enter ProcessSingleTask().
Gabriel Charettee2b632b2017-08-02 03:52:1699 std::move(task).Run();
100 return true;
101 }
102
103 private:
104 ~SimpleSingleThreadTaskRunner() override = default;
105
106 Lock tasks_lock_;
Brett Wilsona62d9c02017-09-20 20:53:20107 base::queue<OnceClosure> pending_tasks_;
Gabriel Charettee2b632b2017-08-02 03:52:16108
109 // RunLoop relies on RunsTasksInCurrentSequence() signal. Use a
110 // ThreadCheckerImpl to be able to reliably provide that signal even in
111 // non-dcheck builds.
112 ThreadCheckerImpl origin_thread_checker_;
113
114 DISALLOW_COPY_AND_ASSIGN(SimpleSingleThreadTaskRunner);
115};
116
Gabriel Charette1ef212b2017-12-03 12:47:21117// The basis of all TestDelegates, allows safely injecting a OnceClosure to be
118// run in the next idle phase of this delegate's Run() implementation. This can
119// be used to have code run on a thread that is otherwise livelocked in an idle
120// phase (sometimes a simple PostTask() won't do it -- e.g. when processing
121// application tasks is disallowed).
122class InjectableTestDelegate : public RunLoop::Delegate {
Gabriel Charettee2b632b2017-08-02 03:52:16123 public:
Gabriel Charette1ef212b2017-12-03 12:47:21124 void InjectClosureOnDelegate(OnceClosure closure) {
125 AutoLock auto_lock(closure_lock_);
126 closure_ = std::move(closure);
127 }
Gabriel Charettee2b632b2017-08-02 03:52:16128
Gabriel Charette1ef212b2017-12-03 12:47:21129 bool RunInjectedClosure() {
130 AutoLock auto_lock(closure_lock_);
131 if (closure_.is_null())
132 return false;
133 std::move(closure_).Run();
134 return true;
135 }
136
137 private:
138 Lock closure_lock_;
139 OnceClosure closure_;
140};
141
142// A simple test RunLoop::Delegate to exercise Runloop logic independent of any
143// other base constructs. BindToCurrentThread() must be called before this
144// TestBoundDelegate is operational.
145class TestBoundDelegate final : public InjectableTestDelegate {
146 public:
147 TestBoundDelegate() = default;
148
149 // Makes this TestBoundDelegate become the RunLoop::Delegate and
150 // ThreadTaskRunnerHandle for this thread.
Gabriel Charettee2b632b2017-08-02 03:52:16151 void BindToCurrentThread() {
152 thread_task_runner_handle_ =
Jeremy Roman9532f252017-08-16 23:27:24153 std::make_unique<ThreadTaskRunnerHandle>(simple_task_runner_);
Gabriel Charettea3ec9612017-12-14 17:22:40154 RunLoop::RegisterDelegateForCurrentThread(this);
Gabriel Charettee2b632b2017-08-02 03:52:16155 }
156
157 private:
Alex Clarke9752bbf2019-04-01 10:41:20158 void Run(bool application_tasks_allowed, TimeDelta timeout) override {
Gabriel Charette3ff403e2017-08-07 04:22:48159 if (nested_run_allowing_tasks_incoming_) {
Gabriel Charette1ef212b2017-12-03 12:47:21160 EXPECT_TRUE(RunLoop::IsNestedOnCurrentThread());
Gabriel Charetteb030a4a2017-10-26 01:04:40161 EXPECT_TRUE(application_tasks_allowed);
Gabriel Charette1ef212b2017-12-03 12:47:21162 } else if (RunLoop::IsNestedOnCurrentThread()) {
Gabriel Charetteb030a4a2017-10-26 01:04:40163 EXPECT_FALSE(application_tasks_allowed);
Gabriel Charette3ff403e2017-08-07 04:22:48164 }
165 nested_run_allowing_tasks_incoming_ = false;
166
Gabriel Charettee2b632b2017-08-02 03:52:16167 while (!should_quit_) {
Gabriel Charette1ef212b2017-12-03 12:47:21168 if (application_tasks_allowed && simple_task_runner_->ProcessSingleTask())
Gabriel Charettee2b632b2017-08-02 03:52:16169 continue;
170
Gabriel Charettea3ec9612017-12-14 17:22:40171 if (ShouldQuitWhenIdle())
Gabriel Charettee2b632b2017-08-02 03:52:16172 break;
173
Gabriel Charette1ef212b2017-12-03 12:47:21174 if (RunInjectedClosure())
175 continue;
Gabriel Charette3ff403e2017-08-07 04:22:48176
Gabriel Charettee2b632b2017-08-02 03:52:16177 PlatformThread::YieldCurrentThread();
178 }
179 should_quit_ = false;
180 }
181
182 void Quit() override { should_quit_ = true; }
183
Gabriel Charette3ff403e2017-08-07 04:22:48184 void EnsureWorkScheduled() override {
185 nested_run_allowing_tasks_incoming_ = true;
186 }
187
188 // True if the next invocation of Run() is expected to be from a
189 // kNestableTasksAllowed RunLoop.
190 bool nested_run_allowing_tasks_incoming_ = false;
191
Gabriel Charettee2b632b2017-08-02 03:52:16192 scoped_refptr<SimpleSingleThreadTaskRunner> simple_task_runner_ =
193 MakeRefCounted<SimpleSingleThreadTaskRunner>();
Gabriel Charette1ef212b2017-12-03 12:47:21194
Gabriel Charettee2b632b2017-08-02 03:52:16195 std::unique_ptr<ThreadTaskRunnerHandle> thread_task_runner_handle_;
196
197 bool should_quit_ = false;
Gabriel Charette1ef212b2017-12-03 12:47:21198};
199
Gabriel Charettee2b632b2017-08-02 03:52:16200enum class RunLoopTestType {
Gabriel Charette694c3c332019-08-19 14:53:05201 // Runs all RunLoopTests under a TaskEnvironment to make sure real world
Gabriel Charettee2b632b2017-08-02 03:52:16202 // scenarios work.
203 kRealEnvironment,
204
205 // Runs all RunLoopTests under a test RunLoop::Delegate to make sure the
206 // delegate interface fully works standalone.
207 kTestDelegate,
208};
209
210// The task environment for the RunLoopTest of a given type. A separate class
211// so it can be instantiated on the stack in the RunLoopTest fixture.
212class RunLoopTestEnvironment {
213 public:
214 RunLoopTestEnvironment(RunLoopTestType type) {
215 switch (type) {
Gabriel Charette1ef212b2017-12-03 12:47:21216 case RunLoopTestType::kRealEnvironment: {
Gabriel Charette694c3c332019-08-19 14:53:05217 task_environment_ = std::make_unique<test::TaskEnvironment>();
Gabriel Charettee2b632b2017-08-02 03:52:16218 break;
Gabriel Charette1ef212b2017-12-03 12:47:21219 }
220 case RunLoopTestType::kTestDelegate: {
221 auto test_delegate = std::make_unique<TestBoundDelegate>();
222 test_delegate->BindToCurrentThread();
223 test_delegate_ = std::move(test_delegate);
Gabriel Charettee2b632b2017-08-02 03:52:16224 break;
Gabriel Charette1ef212b2017-12-03 12:47:21225 }
Gabriel Charettee2b632b2017-08-02 03:52:16226 }
227 }
228
229 private:
Gabriel Charette50518fc2018-05-22 17:53:22230 // Instantiates one or the other based on the RunLoopTestType.
Gabriel Charette694c3c332019-08-19 14:53:05231 std::unique_ptr<test::TaskEnvironment> task_environment_;
Gabriel Charette1ef212b2017-12-03 12:47:21232 std::unique_ptr<InjectableTestDelegate> test_delegate_;
Gabriel Charettee2b632b2017-08-02 03:52:16233};
234
235class RunLoopTest : public testing::TestWithParam<RunLoopTestType> {
236 protected:
237 RunLoopTest() : test_environment_(GetParam()) {}
238
239 RunLoopTestEnvironment test_environment_;
fdoraya4f28ec2016-06-10 00:08:58240 RunLoop run_loop_;
fdoraya4f28ec2016-06-10 00:08:58241
242 private:
243 DISALLOW_COPY_AND_ASSIGN(RunLoopTest);
244};
245
246} // namespace
247
Gabriel Charettee2b632b2017-08-02 03:52:16248TEST_P(RunLoopTest, QuitWhenIdle) {
Wezbbffcc52019-02-21 02:01:20249 int counter = 0;
gab7af9dc02017-05-05 13:38:54250 ThreadTaskRunnerHandle::Get()->PostTask(
tzik92b7a422017-04-11 15:00:44251 FROM_HERE, BindOnce(&QuitWhenIdleTask, Unretained(&run_loop_),
Wezbbffcc52019-02-21 02:01:20252 Unretained(&counter)));
253 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
254 MakeExpectedRunClosure(FROM_HERE));
gab7af9dc02017-05-05 13:38:54255 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
Wezbbffcc52019-02-21 02:01:20256 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), TimeDelta::FromDays(1));
fdoraya4f28ec2016-06-10 00:08:58257
258 run_loop_.Run();
Wezbbffcc52019-02-21 02:01:20259 EXPECT_EQ(1, counter);
fdoraya4f28ec2016-06-10 00:08:58260}
261
Gabriel Charettee2b632b2017-08-02 03:52:16262TEST_P(RunLoopTest, QuitWhenIdleNestedLoop) {
Wezbbffcc52019-02-21 02:01:20263 int counter = 0;
gab7af9dc02017-05-05 13:38:54264 ThreadTaskRunnerHandle::Get()->PostTask(
Wezbbffcc52019-02-21 02:01:20265 FROM_HERE, BindOnce(&RunNestedLoopTask, Unretained(&counter)));
gab7af9dc02017-05-05 13:38:54266 ThreadTaskRunnerHandle::Get()->PostTask(
tzik92b7a422017-04-11 15:00:44267 FROM_HERE, BindOnce(&QuitWhenIdleTask, Unretained(&run_loop_),
Wezbbffcc52019-02-21 02:01:20268 Unretained(&counter)));
269 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
270 MakeExpectedRunClosure(FROM_HERE));
gab7af9dc02017-05-05 13:38:54271 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
Wezbbffcc52019-02-21 02:01:20272 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), TimeDelta::FromDays(1));
fdoraya4f28ec2016-06-10 00:08:58273
274 run_loop_.Run();
Wezbbffcc52019-02-21 02:01:20275 EXPECT_EQ(3, counter);
fdoraya4f28ec2016-06-10 00:08:58276}
277
Gabriel Charettee2b632b2017-08-02 03:52:16278TEST_P(RunLoopTest, QuitWhenIdleClosure) {
gab7af9dc02017-05-05 13:38:54279 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
280 run_loop_.QuitWhenIdleClosure());
Wezbbffcc52019-02-21 02:01:20281 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
282 MakeExpectedRunClosure(FROM_HERE));
gab7af9dc02017-05-05 13:38:54283 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
Wezbbffcc52019-02-21 02:01:20284 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), TimeDelta::FromDays(1));
fdoraya3658602016-06-10 18:23:15285
286 run_loop_.Run();
fdoraya3658602016-06-10 18:23:15287}
288
289// Verify that the QuitWhenIdleClosure() can run after the RunLoop has been
290// deleted. It should have no effect.
Gabriel Charettee2b632b2017-08-02 03:52:16291TEST_P(RunLoopTest, QuitWhenIdleClosureAfterRunLoopScope) {
kylechar650caf02019-07-17 03:25:41292 RepeatingClosure quit_when_idle_closure;
fdoraya3658602016-06-10 18:23:15293 {
294 RunLoop run_loop;
295 quit_when_idle_closure = run_loop.QuitWhenIdleClosure();
296 run_loop.RunUntilIdle();
297 }
298 quit_when_idle_closure.Run();
299}
300
gabcf5e4ce2017-05-19 22:56:57301// Verify that Quit can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16302TEST_P(RunLoopTest, QuitFromOtherSequence) {
303 Thread other_thread("test");
304 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57305 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16306 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57307
308 // Always expected to run before asynchronous Quit() kicks in.
Wezbbffcc52019-02-21 02:01:20309 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
310 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57311
312 WaitableEvent loop_was_quit(WaitableEvent::ResetPolicy::MANUAL,
313 WaitableEvent::InitialState::NOT_SIGNALED);
314 other_sequence->PostTask(
315 FROM_HERE, base::BindOnce([](RunLoop* run_loop) { run_loop->Quit(); },
316 Unretained(&run_loop_)));
317 other_sequence->PostTask(
318 FROM_HERE,
319 base::BindOnce(&WaitableEvent::Signal, base::Unretained(&loop_was_quit)));
320
321 // Anything that's posted after the Quit closure was posted back to this
322 // sequence shouldn't get a chance to run.
323 loop_was_quit.Wait();
Gabriel Charettee2b632b2017-08-02 03:52:16324 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
Wezbbffcc52019-02-21 02:01:20325 MakeExpectedNotRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57326
327 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57328}
329
330// Verify that QuitClosure can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16331TEST_P(RunLoopTest, QuitFromOtherSequenceWithClosure) {
332 Thread other_thread("test");
333 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57334 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16335 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57336
337 // Always expected to run before asynchronous Quit() kicks in.
Wezbbffcc52019-02-21 02:01:20338 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
339 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57340
341 WaitableEvent loop_was_quit(WaitableEvent::ResetPolicy::MANUAL,
342 WaitableEvent::InitialState::NOT_SIGNALED);
343 other_sequence->PostTask(FROM_HERE, run_loop_.QuitClosure());
344 other_sequence->PostTask(
345 FROM_HERE,
346 base::BindOnce(&WaitableEvent::Signal, base::Unretained(&loop_was_quit)));
347
348 // Anything that's posted after the Quit closure was posted back to this
349 // sequence shouldn't get a chance to run.
350 loop_was_quit.Wait();
Gabriel Charettee2b632b2017-08-02 03:52:16351 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
Wezbbffcc52019-02-21 02:01:20352 MakeExpectedNotRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57353
354 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57355}
356
357// Verify that Quit can be executed from another sequence even when the
358// Quit is racing with Run() -- i.e. forgo the WaitableEvent used above.
Gabriel Charettee2b632b2017-08-02 03:52:16359TEST_P(RunLoopTest, QuitFromOtherSequenceRacy) {
360 Thread other_thread("test");
361 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57362 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16363 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57364
365 // Always expected to run before asynchronous Quit() kicks in.
Wezbbffcc52019-02-21 02:01:20366 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
367 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57368
Wezbbffcc52019-02-21 02:01:20369 other_sequence->PostTask(FROM_HERE, run_loop_.QuitClosure());
gabcf5e4ce2017-05-19 22:56:57370
371 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57372}
373
374// Verify that QuitClosure can be executed from another sequence even when the
375// Quit is racing with Run() -- i.e. forgo the WaitableEvent used above.
Gabriel Charettee2b632b2017-08-02 03:52:16376TEST_P(RunLoopTest, QuitFromOtherSequenceRacyWithClosure) {
377 Thread other_thread("test");
378 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57379 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16380 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57381
382 // Always expected to run before asynchronous Quit() kicks in.
Wezbbffcc52019-02-21 02:01:20383 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
384 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57385
386 other_sequence->PostTask(FROM_HERE, run_loop_.QuitClosure());
387
388 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57389}
390
391// Verify that QuitWhenIdle can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16392TEST_P(RunLoopTest, QuitWhenIdleFromOtherSequence) {
393 Thread other_thread("test");
394 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57395 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16396 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57397
Wezbbffcc52019-02-21 02:01:20398 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
399 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57400
401 other_sequence->PostTask(
402 FROM_HERE,
403 base::BindOnce([](RunLoop* run_loop) { run_loop->QuitWhenIdle(); },
404 Unretained(&run_loop_)));
405
Wezbbffcc52019-02-21 02:01:20406 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
407 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57408
409 run_loop_.Run();
410
411 // Regardless of the outcome of the race this thread shouldn't have been idle
Wezbbffcc52019-02-21 02:01:20412 // until both tasks posted to this sequence have run.
gabcf5e4ce2017-05-19 22:56:57413}
414
415// Verify that QuitWhenIdleClosure can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16416TEST_P(RunLoopTest, QuitWhenIdleFromOtherSequenceWithClosure) {
417 Thread other_thread("test");
418 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57419 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16420 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57421
Wezbbffcc52019-02-21 02:01:20422 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
423 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57424
425 other_sequence->PostTask(FROM_HERE, run_loop_.QuitWhenIdleClosure());
426
Wezbbffcc52019-02-21 02:01:20427 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
428 MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57429
430 run_loop_.Run();
431
432 // Regardless of the outcome of the race this thread shouldn't have been idle
Wezbbffcc52019-02-21 02:01:20433 // until the both tasks posted to this sequence have run.
gabcf5e4ce2017-05-19 22:56:57434}
435
Gabriel Charettee2b632b2017-08-02 03:52:16436TEST_P(RunLoopTest, IsRunningOnCurrentThread) {
gab7af9dc02017-05-05 13:38:54437 EXPECT_FALSE(RunLoop::IsRunningOnCurrentThread());
438 ThreadTaskRunnerHandle::Get()->PostTask(
439 FROM_HERE,
tzik0c100dc2017-06-26 06:13:17440 BindOnce([]() { EXPECT_TRUE(RunLoop::IsRunningOnCurrentThread()); }));
gab7af9dc02017-05-05 13:38:54441 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, run_loop_.QuitClosure());
442 run_loop_.Run();
443}
444
Gabriel Charettee2b632b2017-08-02 03:52:16445TEST_P(RunLoopTest, IsNestedOnCurrentThread) {
gab7af9dc02017-05-05 13:38:54446 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
447
448 ThreadTaskRunnerHandle::Get()->PostTask(
tzik0c100dc2017-06-26 06:13:17449 FROM_HERE, BindOnce([]() {
gab7af9dc02017-05-05 13:38:54450 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
451
Gabriel Charette3ff403e2017-08-07 04:22:48452 RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
gab7af9dc02017-05-05 13:38:54453
454 ThreadTaskRunnerHandle::Get()->PostTask(
tzik0c100dc2017-06-26 06:13:17455 FROM_HERE, BindOnce([]() {
456 EXPECT_TRUE(RunLoop::IsNestedOnCurrentThread());
457 }));
gab7af9dc02017-05-05 13:38:54458 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
459 nested_run_loop.QuitClosure());
460
461 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
gab7af9dc02017-05-05 13:38:54462 nested_run_loop.Run();
463 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
464 }));
465
466 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, run_loop_.QuitClosure());
467 run_loop_.Run();
468}
469
Francois Doray80bdddf2018-01-04 16:17:32470namespace {
471
gab7af9dc02017-05-05 13:38:54472class MockNestingObserver : public RunLoop::NestingObserver {
473 public:
474 MockNestingObserver() = default;
475
476 // RunLoop::NestingObserver:
477 MOCK_METHOD0(OnBeginNestedRunLoop, void());
Francois Doray80bdddf2018-01-04 16:17:32478 MOCK_METHOD0(OnExitNestedRunLoop, void());
gab7af9dc02017-05-05 13:38:54479
480 private:
481 DISALLOW_COPY_AND_ASSIGN(MockNestingObserver);
482};
483
Francois Doray80bdddf2018-01-04 16:17:32484class MockTask {
485 public:
486 MockTask() = default;
487 MOCK_METHOD0(Task, void());
488
489 private:
490 DISALLOW_COPY_AND_ASSIGN(MockTask);
491};
492
493} // namespace
494
Gabriel Charettee2b632b2017-08-02 03:52:16495TEST_P(RunLoopTest, NestingObservers) {
gab7af9dc02017-05-05 13:38:54496 testing::StrictMock<MockNestingObserver> nesting_observer;
Francois Doray80bdddf2018-01-04 16:17:32497 testing::StrictMock<MockTask> mock_task_a;
498 testing::StrictMock<MockTask> mock_task_b;
gab7af9dc02017-05-05 13:38:54499
500 RunLoop::AddNestingObserverOnCurrentThread(&nesting_observer);
501
kylechar01598d72019-05-21 18:35:31502 const RepeatingClosure run_nested_loop = BindRepeating([]() {
Gabriel Charette3ff403e2017-08-07 04:22:48503 RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
gab7af9dc02017-05-05 13:38:54504 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
505 nested_run_loop.QuitClosure());
gab7af9dc02017-05-05 13:38:54506 nested_run_loop.Run();
507 });
508
Francois Doray80bdddf2018-01-04 16:17:32509 // Generate a stack of nested RunLoops. OnBeginNestedRunLoop() is expected
510 // when beginning each nesting depth and OnExitNestedRunLoop() is expected
Gabriel Charetted8839442018-03-15 18:56:22511 // when exiting each nesting depth. Each one of these tasks is ahead of the
512 // QuitClosures as those are only posted at the end of the queue when
513 // |run_nested_loop| is executed.
gab7af9dc02017-05-05 13:38:54514 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, run_nested_loop);
Francois Doray80bdddf2018-01-04 16:17:32515 ThreadTaskRunnerHandle::Get()->PostTask(
516 FROM_HERE,
517 base::BindOnce(&MockTask::Task, base::Unretained(&mock_task_a)));
gab7af9dc02017-05-05 13:38:54518 ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, run_nested_loop);
Francois Doray80bdddf2018-01-04 16:17:32519 ThreadTaskRunnerHandle::Get()->PostTask(
520 FROM_HERE,
521 base::BindOnce(&MockTask::Task, base::Unretained(&mock_task_b)));
gab7af9dc02017-05-05 13:38:54522
Francois Doray80bdddf2018-01-04 16:17:32523 {
524 testing::InSequence in_sequence;
525 EXPECT_CALL(nesting_observer, OnBeginNestedRunLoop());
526 EXPECT_CALL(mock_task_a, Task());
527 EXPECT_CALL(nesting_observer, OnBeginNestedRunLoop());
528 EXPECT_CALL(mock_task_b, Task());
529 EXPECT_CALL(nesting_observer, OnExitNestedRunLoop()).Times(2);
530 }
531 run_loop_.RunUntilIdle();
gab7af9dc02017-05-05 13:38:54532
533 RunLoop::RemoveNestingObserverOnCurrentThread(&nesting_observer);
534}
535
Gabriel Charettea44975052017-08-21 23:14:04536TEST_P(RunLoopTest, DisallowRunningForTesting) {
537 RunLoop::ScopedDisallowRunningForTesting disallow_running;
Gabriel Charettef3fd8f02018-05-22 15:31:48538 EXPECT_DCHECK_DEATH({ run_loop_.RunUntilIdle(); });
Gabriel Charettea44975052017-08-21 23:14:04539}
540
541TEST_P(RunLoopTest, ExpiredDisallowRunningForTesting) {
542 { RunLoop::ScopedDisallowRunningForTesting disallow_running; }
543 // Running should be fine after |disallow_running| goes out of scope.
544 run_loop_.RunUntilIdle();
545}
546
Victor Costan033b9ac2019-01-29 00:52:16547INSTANTIATE_TEST_SUITE_P(Real,
548 RunLoopTest,
549 testing::Values(RunLoopTestType::kRealEnvironment));
550INSTANTIATE_TEST_SUITE_P(Mock,
551 RunLoopTest,
552 testing::Values(RunLoopTestType::kTestDelegate));
Gabriel Charettee2b632b2017-08-02 03:52:16553
Wez212eeb72020-02-04 17:54:54554TEST(RunLoopUntilConditionTest, FailsTestOnTimeout) {
555 test::SingleThreadTaskEnvironment task_environment;
Wezd9e4cb772019-01-09 03:07:03556
Wez212eeb72020-02-04 17:54:54557 // Expect the Run() timeout to be run when |condition| is false and the loop
558 // times out.
Wez9d5dd282020-02-10 17:21:22559 const test::ScopedRunLoopTimeout short_timeout(
560 TimeDelta::FromMilliseconds(10));
561 EXPECT_FATAL_FAILURE(
562 RunLoop().RunUntilConditionForTest(BindRepeating([]() { return false; })),
563 "RunLoop::Run() timed out.");
Wezd9e4cb772019-01-09 03:07:03564}
565
Wez212eeb72020-02-04 17:54:54566TEST(RunLoopUntilConditionTest, FailsTestIfConditionNotMetOnQuit) {
567 test::SingleThreadTaskEnvironment task_environment;
568 RunLoop loop;
Wezd9e4cb772019-01-09 03:07:03569
Wez212eeb72020-02-04 17:54:54570 // Expect the Run() timeout to be run when |condition| is false and the loop
571 // Quit()s prematurely.
Wez9d5dd282020-02-10 17:21:22572 const test::ScopedRunLoopTimeout short_timeout(
573 TimeDelta::FromMilliseconds(10));
Wezd9e4cb772019-01-09 03:07:03574
Wez212eeb72020-02-04 17:54:54575 // Running with a never-true condition will fire the on-timeout callback.
Wez9d5dd282020-02-10 17:21:22576 EXPECT_FATAL_FAILURE(
577 RunLoop().RunUntilConditionForTest(BindRepeating([]() { return false; })),
578 "RunLoop::Run() timed out.");
Wez212eeb72020-02-04 17:54:54579}
Wezd9e4cb772019-01-09 03:07:03580
Wez212eeb72020-02-04 17:54:54581TEST(RunLoopUntilConditionTest, NoEffectIfConditionMetOnQuit) {
582 test::SingleThreadTaskEnvironment task_environment;
583 RunLoop loop;
584
585 // Verify that the call does not trigger the Run() timeout.
Wez9d5dd282020-02-10 17:21:22586 const test::ScopedRunLoopTimeout short_timeout(
587 TimeDelta::FromMilliseconds(10));
Wez212eeb72020-02-04 17:54:54588 SequencedTaskRunnerHandle::Get()->PostTask(FROM_HERE, loop.QuitClosure());
589 RunLoop().RunUntilConditionForTest(BindRepeating([]() { return true; }));
590}
591
592TEST(RunLoopUntilConditionTest, NoEffectIfConditionMetOnTimeout) {
593 test::SingleThreadTaskEnvironment task_environment;
594 RunLoop loop;
595
596 // Verify that the call does not trigger the Run() timeout.
597 // Note that |short_timeout| must be shorter than the RunUntilConditionForTest
598 // polling frequency.
Wez9d5dd282020-02-10 17:21:22599 const test::ScopedRunLoopTimeout short_timeout(
600 TimeDelta::FromMilliseconds(10));
Wez212eeb72020-02-04 17:54:54601 RunLoop().RunUntilConditionForTest(BindRepeating([]() { return true; }));
602}
603
604TEST(RunLoopUntilConditionTest, QuitsLoopIfConditionMetOnPoll) {
605 test::SingleThreadTaskEnvironment task_environment;
606 RunLoop loop;
607
608 // Configure a long timeout so it won't fire before we poll.
Wez9d5dd282020-02-10 17:21:22609 const test::ScopedRunLoopTimeout long_timeout(TestTimeouts::action_timeout());
Wez212eeb72020-02-04 17:54:54610
611 // Arrange to post a task to the loop after the Run()-timeout has been
612 // started, set to run after the |condition| is polled and before the Run()
613 // timeout expires. This task should not get to run.
614 ThreadTaskRunnerHandle::Get()->PostTask(
615 FROM_HERE, BindOnce([]() {
616 ThreadTaskRunnerHandle::Get()->PostDelayedTask(
617 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE),
618 TimeDelta::FromSeconds(1));
619 }));
620
621 // Run the loop, which should be Quit() the first time |condition| is polled.
622 RunLoop().RunUntilConditionForTest(BindRepeating([]() { return true; }));
Wezd9e4cb772019-01-09 03:07:03623}
624
Gabriel Charettee2b632b2017-08-02 03:52:16625TEST(RunLoopDeathTest, MustRegisterBeforeInstantiating) {
Gabriel Charette1ef212b2017-12-03 12:47:21626 TestBoundDelegate unbound_test_delegate_;
Wez39ee6102018-04-14 21:33:59627 // RunLoop::RunLoop() should CHECK fetching the ThreadTaskRunnerHandle.
628 EXPECT_DEATH_IF_SUPPORTED({ RunLoop(); }, "");
Gabriel Charettee2b632b2017-08-02 03:52:16629}
630
Gabriel Charette3ff403e2017-08-07 04:22:48631TEST(RunLoopDelegateTest, NestableTasksDontRunInDefaultNestedLoops) {
Gabriel Charette1ef212b2017-12-03 12:47:21632 TestBoundDelegate test_delegate;
Gabriel Charette3ff403e2017-08-07 04:22:48633 test_delegate.BindToCurrentThread();
634
635 base::Thread other_thread("test");
636 other_thread.Start();
637
638 RunLoop main_loop;
639 // A nested run loop which isn't kNestableTasksAllowed.
640 RunLoop nested_run_loop(RunLoop::Type::kDefault);
641
642 bool nested_run_loop_ended = false;
643
644 // The first task on the main loop will result in a nested run loop. Since
645 // it's not kNestableTasksAllowed, no further task should be processed until
646 // it's quit.
647 ThreadTaskRunnerHandle::Get()->PostTask(
648 FROM_HERE,
649 BindOnce([](RunLoop* nested_run_loop) { nested_run_loop->Run(); },
650 Unretained(&nested_run_loop)));
651
652 // Post a task that will fail if it runs inside the nested run loop.
653 ThreadTaskRunnerHandle::Get()->PostTask(
jdoerrie9d7236f62019-03-05 13:00:23654 FROM_HERE,
655 BindOnce(
656 [](const bool& nested_run_loop_ended,
657 OnceClosure continuation_callback) {
658 EXPECT_TRUE(nested_run_loop_ended);
659 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
660 std::move(continuation_callback).Run();
661 },
662 std::cref(nested_run_loop_ended), main_loop.QuitClosure()));
Gabriel Charette3ff403e2017-08-07 04:22:48663
664 // Post a task flipping the boolean bit for extra verification right before
665 // quitting |nested_run_loop|.
666 other_thread.task_runner()->PostDelayedTask(
667 FROM_HERE,
668 BindOnce(
669 [](bool* nested_run_loop_ended) {
670 EXPECT_FALSE(*nested_run_loop_ended);
671 *nested_run_loop_ended = true;
672 },
673 Unretained(&nested_run_loop_ended)),
674 TestTimeouts::tiny_timeout());
675 // Post an async delayed task to exit the run loop when idle. This confirms
676 // that (1) the test task only ran in the main loop after the nested loop
677 // exited and (2) the nested run loop actually considers itself idle while
678 // spinning. Note: The quit closure needs to be injected directly on the
679 // delegate as invoking QuitWhenIdle() off-thread results in a thread bounce
680 // which will not processed because of the very logic under test (nestable
681 // tasks don't run in |nested_run_loop|).
682 other_thread.task_runner()->PostDelayedTask(
683 FROM_HERE,
684 BindOnce(
Gabriel Charette1ef212b2017-12-03 12:47:21685 [](TestBoundDelegate* test_delegate, OnceClosure injected_closure) {
686 test_delegate->InjectClosureOnDelegate(std::move(injected_closure));
Gabriel Charette3ff403e2017-08-07 04:22:48687 },
688 Unretained(&test_delegate), nested_run_loop.QuitWhenIdleClosure()),
689 TestTimeouts::tiny_timeout());
690
691 main_loop.Run();
692}
693
fdoraya4f28ec2016-06-10 00:08:58694} // namespace base