summaryrefslogtreecommitdiff
path: root/base/sequence_checker_unittest.cc
blob: 86e9298d9792d342af895805e237d42d917988c7 (plain)
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
// Copyright 2013 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 <stddef.h>

#include <memory>
#include <string>

#include "base/bind.h"
#include "base/bind_helpers.h"
#include "base/callback_forward.h"
#include "base/macros.h"
#include "base/message_loop/message_loop.h"
#include "base/sequence_checker_impl.h"
#include "base/sequence_token.h"
#include "base/single_thread_task_runner.h"
#include "base/test/sequenced_worker_pool_owner.h"
#include "base/threading/simple_thread.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace base {

namespace {

constexpr size_t kNumWorkerThreads = 3;

// Runs a callback on another thread.
class RunCallbackThread : public SimpleThread {
 public:
  explicit RunCallbackThread(const Closure& callback)
      : SimpleThread("RunCallbackThread"), callback_(callback) {
    Start();
    Join();
  }

 private:
  // SimpleThread:
  void Run() override { callback_.Run(); }

  const Closure callback_;

  DISALLOW_COPY_AND_ASSIGN(RunCallbackThread);
};

class SequenceCheckerTest : public testing::Test {
 protected:
  SequenceCheckerTest() : pool_owner_(kNumWorkerThreads, "test") {}

  void PostToSequencedWorkerPool(const Closure& callback,
                                 const std::string& token_name) {
    pool_owner_.pool()->PostNamedSequencedWorkerTask(token_name, FROM_HERE,
                                                     callback);
  }

  void FlushSequencedWorkerPoolForTesting() {
    pool_owner_.pool()->FlushForTesting();
  }

 private:
  MessageLoop message_loop_;  // Needed by SequencedWorkerPool to function.
  SequencedWorkerPoolOwner pool_owner_;

  DISALLOW_COPY_AND_ASSIGN(SequenceCheckerTest);
};

void ExpectCalledOnValidSequence(SequenceCheckerImpl* sequence_checker) {
  ASSERT_TRUE(sequence_checker);

  // This should bind |sequence_checker| to the current sequence if it wasn't
  // already bound to a sequence.
  EXPECT_TRUE(sequence_checker->CalledOnValidSequence());

  // Since |sequence_checker| is now bound to the current sequence, another call
  // to CalledOnValidSequence() should return true.
  EXPECT_TRUE(sequence_checker->CalledOnValidSequence());
}

void ExpectCalledOnValidSequenceWithSequenceToken(
    SequenceCheckerImpl* sequence_checker,
    SequenceToken sequence_token) {
  ScopedSetSequenceTokenForCurrentThread
      scoped_set_sequence_token_for_current_thread(sequence_token);
  ExpectCalledOnValidSequence(sequence_checker);
}

void ExpectNotCalledOnValidSequence(SequenceCheckerImpl* sequence_checker) {
  ASSERT_TRUE(sequence_checker);
  EXPECT_FALSE(sequence_checker->CalledOnValidSequence());
}

}  // namespace

TEST_F(SequenceCheckerTest, CallsAllowedOnSameThreadNoSequenceToken) {
  SequenceCheckerImpl sequence_checker;
  EXPECT_TRUE(sequence_checker.CalledOnValidSequence());
}

TEST_F(SequenceCheckerTest, CallsAllowedOnSameThreadSameSequenceToken) {
  ScopedSetSequenceTokenForCurrentThread
      scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
  SequenceCheckerImpl sequence_checker;
  EXPECT_TRUE(sequence_checker.CalledOnValidSequence());
}

TEST_F(SequenceCheckerTest, CallsDisallowedOnDifferentThreadsNoSequenceToken) {
  SequenceCheckerImpl sequence_checker;
  RunCallbackThread thread(
      Bind(&ExpectNotCalledOnValidSequence, Unretained(&sequence_checker)));
}

TEST_F(SequenceCheckerTest, CallsAllowedOnDifferentThreadsSameSequenceToken) {
  const SequenceToken sequence_token(SequenceToken::Create());

  ScopedSetSequenceTokenForCurrentThread
      scoped_set_sequence_token_for_current_thread(sequence_token);
  SequenceCheckerImpl sequence_checker;
  EXPECT_TRUE(sequence_checker.CalledOnValidSequence());

  RunCallbackThread thread(Bind(&ExpectCalledOnValidSequenceWithSequenceToken,
                                Unretained(&sequence_checker), sequence_token));
}

TEST_F(SequenceCheckerTest, CallsDisallowedOnSameThreadDifferentSequenceToken) {
  std::unique_ptr<SequenceCheckerImpl> sequence_checker;

  {
    ScopedSetSequenceTokenForCurrentThread
        scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
    sequence_checker.reset(new SequenceCheckerImpl);
  }

  {
    // Different SequenceToken.
    ScopedSetSequenceTokenForCurrentThread
        scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
    EXPECT_FALSE(sequence_checker->CalledOnValidSequence());
  }

  // No SequenceToken.
  EXPECT_FALSE(sequence_checker->CalledOnValidSequence());
}

TEST_F(SequenceCheckerTest, DetachFromSequence) {
  std::unique_ptr<SequenceCheckerImpl> sequence_checker;

  {
    ScopedSetSequenceTokenForCurrentThread
        scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
    sequence_checker.reset(new SequenceCheckerImpl);
  }

  sequence_checker->DetachFromSequence();

  {
    // Verify that CalledOnValidSequence() returns true when called with
    // a different sequence token after a call to DetachFromSequence().
    ScopedSetSequenceTokenForCurrentThread
        scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
    EXPECT_TRUE(sequence_checker->CalledOnValidSequence());
  }
}

TEST_F(SequenceCheckerTest, DetachFromSequenceNoSequenceToken) {
  SequenceCheckerImpl sequence_checker;
  sequence_checker.DetachFromSequence();

  // Verify that CalledOnValidSequence() returns true when called on a
  // different thread after a call to DetachFromSequence().
  RunCallbackThread thread(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)));

  EXPECT_FALSE(sequence_checker.CalledOnValidSequence());
}

TEST_F(SequenceCheckerTest, SequencedWorkerPool_SameSequenceTokenValid) {
  SequenceCheckerImpl sequence_checker;
  sequence_checker.DetachFromSequence();

  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  FlushSequencedWorkerPoolForTesting();
}

TEST_F(SequenceCheckerTest, SequencedWorkerPool_DetachSequenceTokenValid) {
  SequenceCheckerImpl sequence_checker;
  sequence_checker.DetachFromSequence();

  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  FlushSequencedWorkerPoolForTesting();

  sequence_checker.DetachFromSequence();

  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "B");
  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "B");
  FlushSequencedWorkerPoolForTesting();
}

TEST_F(SequenceCheckerTest,
       SequencedWorkerPool_DifferentSequenceTokensInvalid) {
  SequenceCheckerImpl sequence_checker;
  sequence_checker.DetachFromSequence();

  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  FlushSequencedWorkerPoolForTesting();

  PostToSequencedWorkerPool(
      Bind(&ExpectNotCalledOnValidSequence, Unretained(&sequence_checker)),
      "B");
  PostToSequencedWorkerPool(
      Bind(&ExpectNotCalledOnValidSequence, Unretained(&sequence_checker)),
      "B");
  FlushSequencedWorkerPoolForTesting();
}

TEST_F(SequenceCheckerTest,
       SequencedWorkerPool_WorkerPoolAndSimpleThreadInvalid) {
  SequenceCheckerImpl sequence_checker;
  sequence_checker.DetachFromSequence();

  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  FlushSequencedWorkerPoolForTesting();

  EXPECT_FALSE(sequence_checker.CalledOnValidSequence());
}

TEST_F(SequenceCheckerTest,
       SequencedWorkerPool_TwoDifferentWorkerPoolsInvalid) {
  SequenceCheckerImpl sequence_checker;
  sequence_checker.DetachFromSequence();

  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  PostToSequencedWorkerPool(
      Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A");
  FlushSequencedWorkerPoolForTesting();

  SequencedWorkerPoolOwner second_pool_owner(kNumWorkerThreads, "test2");
  second_pool_owner.pool()->PostNamedSequencedWorkerTask(
      "A", FROM_HERE, base::Bind(&ExpectNotCalledOnValidSequence,
                                 base::Unretained(&sequence_checker)));
  second_pool_owner.pool()->FlushForTesting();
}

}  // namespace base