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
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/threading/thread_checker.h"
#include <memory>
#include "base/bind.h"
#include "base/bind_helpers.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/sequence_token.h"
#include "base/test/gtest_util.h"
#include "base/test/test_simple_task_runner.h"
#include "base/threading/simple_thread.h"
#include "base/threading/thread_task_runner_handle.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base {
namespace {
// A thread that runs a callback.
class RunCallbackThread : public SimpleThread {
public:
explicit RunCallbackThread(const Closure& callback)
: SimpleThread("RunCallbackThread"), callback_(callback) {}
private:
// SimpleThread:
void Run() override { callback_.Run(); }
const Closure callback_;
DISALLOW_COPY_AND_ASSIGN(RunCallbackThread);
};
// Runs a callback on a new thread synchronously.
void RunCallbackOnNewThreadSynchronously(const Closure& callback) {
RunCallbackThread run_callback_thread(callback);
run_callback_thread.Start();
run_callback_thread.Join();
}
void ExpectCalledOnValidThread(ThreadCheckerImpl* thread_checker) {
ASSERT_TRUE(thread_checker);
// This should bind |thread_checker| to the current thread if it wasn't
// already bound to a thread.
EXPECT_TRUE(thread_checker->CalledOnValidThread());
// Since |thread_checker| is now bound to the current thread, another call to
// CalledOnValidThread() should return true.
EXPECT_TRUE(thread_checker->CalledOnValidThread());
}
void ExpectNotCalledOnValidThread(ThreadCheckerImpl* thread_checker) {
ASSERT_TRUE(thread_checker);
EXPECT_FALSE(thread_checker->CalledOnValidThread());
}
void ExpectNotCalledOnValidThreadWithSequenceTokenAndThreadTaskRunnerHandle(
ThreadCheckerImpl* thread_checker,
SequenceToken sequence_token) {
ThreadTaskRunnerHandle thread_task_runner_handle(
make_scoped_refptr(new TestSimpleTaskRunner));
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(sequence_token);
ExpectNotCalledOnValidThread(thread_checker);
}
} // namespace
TEST(ThreadCheckerTest, AllowedSameThreadNoSequenceToken) {
ThreadCheckerImpl thread_checker;
EXPECT_TRUE(thread_checker.CalledOnValidThread());
}
TEST(ThreadCheckerTest,
AllowedSameThreadAndSequenceDifferentTasksWithThreadTaskRunnerHandle) {
ThreadTaskRunnerHandle thread_task_runner_handle(
make_scoped_refptr(new TestSimpleTaskRunner));
std::unique_ptr<ThreadCheckerImpl> thread_checker;
const SequenceToken sequence_token = SequenceToken::Create();
{
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(sequence_token);
thread_checker.reset(new ThreadCheckerImpl);
}
{
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(sequence_token);
EXPECT_TRUE(thread_checker->CalledOnValidThread());
}
}
TEST(ThreadCheckerTest,
AllowedSameThreadSequenceAndTaskNoThreadTaskRunnerHandle) {
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
ThreadCheckerImpl thread_checker;
EXPECT_TRUE(thread_checker.CalledOnValidThread());
}
TEST(ThreadCheckerTest,
DisallowedSameThreadAndSequenceDifferentTasksNoThreadTaskRunnerHandle) {
std::unique_ptr<ThreadCheckerImpl> thread_checker;
{
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
thread_checker.reset(new ThreadCheckerImpl);
}
{
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
EXPECT_FALSE(thread_checker->CalledOnValidThread());
}
}
TEST(ThreadCheckerTest, DisallowedDifferentThreadsNoSequenceToken) {
ThreadCheckerImpl thread_checker;
RunCallbackOnNewThreadSynchronously(
Bind(&ExpectNotCalledOnValidThread, Unretained(&thread_checker)));
}
TEST(ThreadCheckerTest, DisallowedDifferentThreadsSameSequence) {
ThreadTaskRunnerHandle thread_task_runner_handle(
make_scoped_refptr(new TestSimpleTaskRunner));
const SequenceToken sequence_token(SequenceToken::Create());
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(sequence_token);
ThreadCheckerImpl thread_checker;
EXPECT_TRUE(thread_checker.CalledOnValidThread());
RunCallbackOnNewThreadSynchronously(Bind(
&ExpectNotCalledOnValidThreadWithSequenceTokenAndThreadTaskRunnerHandle,
Unretained(&thread_checker), sequence_token));
}
TEST(ThreadCheckerTest, DisallowedSameThreadDifferentSequence) {
std::unique_ptr<ThreadCheckerImpl> thread_checker;
ThreadTaskRunnerHandle thread_task_runner_handle(
make_scoped_refptr(new TestSimpleTaskRunner));
{
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
thread_checker.reset(new ThreadCheckerImpl);
}
{
// Different SequenceToken.
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
EXPECT_FALSE(thread_checker->CalledOnValidThread());
}
// No SequenceToken.
EXPECT_FALSE(thread_checker->CalledOnValidThread());
}
TEST(ThreadCheckerTest, DetachFromThread) {
ThreadCheckerImpl thread_checker;
thread_checker.DetachFromThread();
// Verify that CalledOnValidThread() returns true when called on a different
// thread after a call to DetachFromThread().
RunCallbackOnNewThreadSynchronously(
Bind(&ExpectCalledOnValidThread, Unretained(&thread_checker)));
EXPECT_FALSE(thread_checker.CalledOnValidThread());
}
TEST(ThreadCheckerTest, DetachFromThreadWithSequenceToken) {
ThreadTaskRunnerHandle thread_task_runner_handle(
make_scoped_refptr(new TestSimpleTaskRunner));
ScopedSetSequenceTokenForCurrentThread
scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
ThreadCheckerImpl thread_checker;
thread_checker.DetachFromThread();
// Verify that CalledOnValidThread() returns true when called on a different
// thread after a call to DetachFromThread().
RunCallbackOnNewThreadSynchronously(
Bind(&ExpectCalledOnValidThread, Unretained(&thread_checker)));
EXPECT_FALSE(thread_checker.CalledOnValidThread());
}
namespace {
// This fixture is a helper for unit testing the thread checker macros as it is
// not possible to inline ExpectDeathOnOtherThread() and
// ExpectNoDeathOnOtherThreadAfterDetach() as lambdas since binding
// |Unretained(&my_sequence_checker)| wouldn't compile on non-dcheck builds
// where it won't be defined.
class ThreadCheckerMacroTest : public testing::Test {
public:
ThreadCheckerMacroTest() = default;
void ExpectDeathOnOtherThread() {
#if DCHECK_IS_ON()
EXPECT_DCHECK_DEATH({ DCHECK_CALLED_ON_VALID_THREAD(my_thread_checker_); });
#else
// Happily no-ops on non-dcheck builds.
DCHECK_CALLED_ON_VALID_THREAD(my_thread_checker_);
#endif
}
void ExpectNoDeathOnOtherThreadAfterDetach() {
DCHECK_CALLED_ON_VALID_THREAD(my_thread_checker_);
}
protected:
THREAD_CHECKER(my_thread_checker_);
private:
DISALLOW_COPY_AND_ASSIGN(ThreadCheckerMacroTest);
};
} // namespace
TEST_F(ThreadCheckerMacroTest, Macros) {
THREAD_CHECKER(my_thread_checker);
RunCallbackOnNewThreadSynchronously(Bind(
&ThreadCheckerMacroTest::ExpectDeathOnOtherThread, Unretained(this)));
DETACH_FROM_THREAD(my_thread_checker_);
RunCallbackOnNewThreadSynchronously(
Bind(&ThreadCheckerMacroTest::ExpectNoDeathOnOtherThreadAfterDetach,
Unretained(this)));
}
} // namespace base
|
