summaryrefslogtreecommitdiffstats
path: root/base/sequence_checker_impl_unittest.cc
blob: 4e601b074236e883ade2c940bed98a3e8d032d09 (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
// 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/sequence_checker_impl.h"

#include <cstddef>

#include "base/bind.h"
#include "base/compiler_specific.h"
#include "base/location.h"
#include "base/memory/ref_counted.h"
#include "base/message_loop.h"
#include "base/sequenced_task_runner.h"
#include "base/threading/thread.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace base {

namespace {

// Implementation of SequencedTaskRunner that lets us control what
// RunsTasksOnCurrentThread() returns.
class FakeTaskRunner : public SequencedTaskRunner {
 public:
  FakeTaskRunner() : runs_tasks_on_current_thread_(false) {}

  void SetRunsTasksOnCurrentThread(bool runs_tasks_on_current_thread) {
    runs_tasks_on_current_thread_ = runs_tasks_on_current_thread;
  }

  // SequencedTaskRunner implementation.
  virtual bool PostDelayedTask(const tracked_objects::Location& from_here,
                               const Closure& task,
                               TimeDelta delay) OVERRIDE {
    ADD_FAILURE();
    return false;
  }

  virtual bool PostNonNestableDelayedTask(
      const tracked_objects::Location& from_here,
      const Closure& task,
      TimeDelta delay) OVERRIDE {
    ADD_FAILURE();
    return false;
  }

  virtual bool RunsTasksOnCurrentThread() const OVERRIDE {
    return runs_tasks_on_current_thread_;
  }

 protected:
  virtual ~FakeTaskRunner() {}

 private:
  bool runs_tasks_on_current_thread_;
};

class SequenceCheckerImplTest : public ::testing::Test {
};

// Create a SequenceCheckerImpl with a SequencedTaskRunner and make
// sure that CalledOnValidSequence() returns what that SequencedTaskRunner
// returns for RunsTasksOnCurrentThread().
TEST_F(SequenceCheckerImplTest, CalledOnValidSequenceNonNull) {
  const scoped_refptr<FakeTaskRunner> fake_sequenced_task_runner(
      new FakeTaskRunner());

  const SequenceCheckerImpl sequence_checker_impl(fake_sequenced_task_runner);
  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());

  fake_sequenced_task_runner->SetRunsTasksOnCurrentThread(true);
  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());

  fake_sequenced_task_runner->SetRunsTasksOnCurrentThread(false);
  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());
}

void ExpectCalledOnValidSequence(
    const tracked_objects::Location& location,
    const SequenceCheckerImpl* sequence_checker_impl,
    bool expected_value) {
  EXPECT_EQ(expected_value, sequence_checker_impl->CalledOnValidSequence())
      << location.ToString();
}

// Create a SequenceCheckerImpl with no SequencedTaskRunner and make
// sure that CalledOnValidSequence() behaves like
// ThreadChecker::CalledOnValidThread().
TEST_F(SequenceCheckerImplTest, CalledOnValidSequenceNull) {
  const SequenceCheckerImpl sequence_checker_impl(NULL);
  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());

  {
    Thread thread("thread 1");
    ASSERT_TRUE(thread.Start());
    thread.message_loop()->PostTask(
        FROM_HERE, Bind(&ExpectCalledOnValidSequence,
                        FROM_HERE,
                        Unretained(&sequence_checker_impl),
                        false));
  }

  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());
}

// Create a SequenceCheckerImpl with a SequencedTaskRunner and switch
// it to another one. CalledOnValidSequence() should return what its
// underlying SequencedTaskRunner returns for
// RunsTasksOnCurrentThread().
TEST_F(SequenceCheckerImplTest, ChangeSequenceNonNull) {
  const scoped_refptr<FakeTaskRunner> fake_sequenced_task_runner1(
      new FakeTaskRunner());

  const scoped_refptr<FakeTaskRunner> fake_sequenced_task_runner2(
      new FakeTaskRunner());

  SequenceCheckerImpl sequence_checker_impl(fake_sequenced_task_runner1);
  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());

  fake_sequenced_task_runner2->SetRunsTasksOnCurrentThread(true);
  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());

  sequence_checker_impl.ChangeSequence(fake_sequenced_task_runner2);
  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());

  sequence_checker_impl.ChangeSequence(fake_sequenced_task_runner1);
  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());
}

// Create a SequenceCheckerImpl with a SequencedTaskRunner and switch
// it to a NULL one. CalledOnValidSequence() should then behave like
// ThreadChecker::CalledOnValidThread().
TEST_F(SequenceCheckerImplTest, ChangeSequenceNull) {
  const scoped_refptr<FakeTaskRunner> fake_sequenced_task_runner(
      new FakeTaskRunner());

  SequenceCheckerImpl sequence_checker_impl(fake_sequenced_task_runner);
  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());

  sequence_checker_impl.ChangeSequence(NULL);
  // Binds to current thread.
  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());
  {
    Thread thread("thread 1");
    ASSERT_TRUE(thread.Start());
    thread.message_loop()->PostTask(
        FROM_HERE, Bind(&ExpectCalledOnValidSequence,
                        FROM_HERE,
                        Unretained(&sequence_checker_impl),
                        false));
  }

  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());

  sequence_checker_impl.ChangeSequence(NULL);
  // Binds to worker thread.
  {
    Thread thread("thread 2");
    ASSERT_TRUE(thread.Start());
    thread.message_loop()->PostTask(
        FROM_HERE, Bind(&ExpectCalledOnValidSequence,
                        FROM_HERE,
                        Unretained(&sequence_checker_impl),
                        true));
  }
  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());
}

// Create a SequenceCheckerImpl with the current thread's task runner
// and switch it to other task runners. CalledOnValidSequence() should
// return true only when it's on the correct thread.
TEST_F(SequenceCheckerImplTest, MultipleThreads) {
  MessageLoop loop;

  SequenceCheckerImpl sequence_checker_impl(loop.message_loop_proxy());
  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());

  {
    Thread thread("thread 1");
    ASSERT_TRUE(thread.Start());
    thread.message_loop()->PostTask(
        FROM_HERE, Bind(&ExpectCalledOnValidSequence,
                        FROM_HERE,
                        Unretained(&sequence_checker_impl),
                        false));
    thread.message_loop()->PostTask(
        FROM_HERE, Bind(&SequenceCheckerImpl::ChangeSequence,
                        Unretained(&sequence_checker_impl),
                        thread.message_loop_proxy()));
    thread.message_loop()->PostTask(
        FROM_HERE, Bind(&ExpectCalledOnValidSequence,
                        FROM_HERE,
                        Unretained(&sequence_checker_impl),
                        true));
  }

  EXPECT_FALSE(sequence_checker_impl.CalledOnValidSequence());

  sequence_checker_impl.ChangeSequence(loop.message_loop_proxy());
  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());

  {
    Thread thread("thread 2");
    ASSERT_TRUE(thread.Start());
    thread.message_loop()->PostTask(
        FROM_HERE, Bind(&ExpectCalledOnValidSequence,
                        FROM_HERE,
                        Unretained(&sequence_checker_impl),
                        false));
  }

  EXPECT_TRUE(sequence_checker_impl.CalledOnValidSequence());
}

}  // namespace

}  // namespace base