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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/task/cancelable_task_tracker.h"
#include <cstddef>
#include <tuple>
#include "base/check_op.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/location.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "base/run_loop.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/bind.h"
#include "base/test/gtest_util.h"
#include "base/test/task_environment.h"
#include "base/test/test_simple_task_runner.h"
#include "base/threading/thread.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base {
namespace {
class CancelableTaskTrackerTest : public testing::Test {
protected:
~CancelableTaskTrackerTest() override { RunLoop().RunUntilIdle(); }
CancelableTaskTracker task_tracker_;
private:
// Needed by CancelableTaskTracker methods.
test::TaskEnvironment task_environment_;
};
} // namespace
// With the task tracker, post a task, a task with a reply, and get a
// new task id without canceling any of them. The tasks and the reply
// should run and the "is canceled" callback should return false.
TEST_F(CancelableTaskTrackerTest, NoCancel) {
Thread worker_thread("worker thread");
ASSERT_TRUE(worker_thread.Start());
std::ignore =
task_tracker_.PostTask(worker_thread.task_runner().get(), FROM_HERE,
MakeExpectedRunClosure(FROM_HERE));
std::ignore = task_tracker_.PostTaskAndReply(
worker_thread.task_runner().get(), FROM_HERE,
MakeExpectedRunClosure(FROM_HERE), MakeExpectedRunClosure(FROM_HERE));
CancelableTaskTracker::IsCanceledCallback is_canceled;
std::ignore = task_tracker_.NewTrackedTaskId(&is_canceled);
worker_thread.Stop();
RunLoop().RunUntilIdle();
EXPECT_FALSE(is_canceled.Run());
}
// Post a task with the task tracker but cancel it before running the
// task runner. The task should not run.
TEST_F(CancelableTaskTrackerTest, CancelPostedTask) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
CancelableTaskTracker::TaskId task_id = task_tracker_.PostTask(
test_task_runner.get(), FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE));
EXPECT_NE(CancelableTaskTracker::kBadTaskId, task_id);
EXPECT_EQ(1U, test_task_runner->NumPendingTasks());
task_tracker_.TryCancel(task_id);
test_task_runner->RunUntilIdle();
}
// Post a task with reply with the task tracker and cancel it before
// running the task runner. Neither the task nor the reply should
// run.
TEST_F(CancelableTaskTrackerTest, CancelPostedTaskAndReply) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
CancelableTaskTracker::TaskId task_id =
task_tracker_.PostTaskAndReply(test_task_runner.get(),
FROM_HERE,
MakeExpectedNotRunClosure(FROM_HERE),
MakeExpectedNotRunClosure(FROM_HERE));
EXPECT_NE(CancelableTaskTracker::kBadTaskId, task_id);
task_tracker_.TryCancel(task_id);
test_task_runner->RunUntilIdle();
}
// Post a task with reply with the task tracker and cancel it after
// running the task runner but before running the current message
// loop. The task should run but the reply should not.
TEST_F(CancelableTaskTrackerTest, CancelReply) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
CancelableTaskTracker::TaskId task_id =
task_tracker_.PostTaskAndReply(test_task_runner.get(),
FROM_HERE,
MakeExpectedRunClosure(FROM_HERE),
MakeExpectedNotRunClosure(FROM_HERE));
EXPECT_NE(CancelableTaskTracker::kBadTaskId, task_id);
test_task_runner->RunUntilIdle();
task_tracker_.TryCancel(task_id);
}
// Post a task with reply with the task tracker on a worker thread and
// cancel it before running the current message loop. The task should
// run but the reply should not.
TEST_F(CancelableTaskTrackerTest, CancelReplyDifferentThread) {
Thread worker_thread("worker thread");
ASSERT_TRUE(worker_thread.Start());
CancelableTaskTracker::TaskId task_id = task_tracker_.PostTaskAndReply(
worker_thread.task_runner().get(), FROM_HERE, DoNothing(),
MakeExpectedNotRunClosure(FROM_HERE));
EXPECT_NE(CancelableTaskTracker::kBadTaskId, task_id);
task_tracker_.TryCancel(task_id);
worker_thread.Stop();
}
void ExpectIsCanceled(
const CancelableTaskTracker::IsCanceledCallback& is_canceled,
bool expected_is_canceled) {
EXPECT_EQ(expected_is_canceled, is_canceled.Run());
}
// Create a new task ID and check its status on a separate thread
// before and after canceling. The is-canceled callback should be
// thread-safe (i.e., nothing should blow up).
TEST_F(CancelableTaskTrackerTest, NewTrackedTaskIdDifferentThread) {
CancelableTaskTracker::IsCanceledCallback is_canceled;
CancelableTaskTracker::TaskId task_id =
task_tracker_.NewTrackedTaskId(&is_canceled);
EXPECT_FALSE(is_canceled.Run());
Thread other_thread("other thread");
ASSERT_TRUE(other_thread.Start());
other_thread.task_runner()->PostTask(
FROM_HERE, BindOnce(&ExpectIsCanceled, is_canceled, false));
other_thread.Stop();
task_tracker_.TryCancel(task_id);
ASSERT_TRUE(other_thread.Start());
other_thread.task_runner()->PostTask(
FROM_HERE, BindOnce(&ExpectIsCanceled, is_canceled, true));
other_thread.Stop();
}
// With the task tracker, post a task, a task with a reply, get a new
// task id, and then cancel all of them. None of the tasks nor the
// reply should run and the "is canceled" callback should return
// true.
TEST_F(CancelableTaskTrackerTest, CancelAll) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
std::ignore = task_tracker_.PostTask(test_task_runner.get(), FROM_HERE,
MakeExpectedNotRunClosure(FROM_HERE));
std::ignore = task_tracker_.PostTaskAndReply(
test_task_runner.get(), FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE),
MakeExpectedNotRunClosure(FROM_HERE));
CancelableTaskTracker::IsCanceledCallback is_canceled;
std::ignore = task_tracker_.NewTrackedTaskId(&is_canceled);
task_tracker_.TryCancelAll();
test_task_runner->RunUntilIdle();
RunLoop().RunUntilIdle();
EXPECT_TRUE(is_canceled.Run());
}
// With the task tracker, post a task, a task with a reply, get a new
// task id, and then cancel all of them. None of the tasks nor the
// reply should run and the "is canceled" callback should return
// true.
TEST_F(CancelableTaskTrackerTest, DestructionCancelsAll) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
CancelableTaskTracker::IsCanceledCallback is_canceled;
{
// Create another task tracker with a smaller scope.
CancelableTaskTracker task_tracker;
std::ignore = task_tracker.PostTask(test_task_runner.get(), FROM_HERE,
MakeExpectedNotRunClosure(FROM_HERE));
std::ignore = task_tracker.PostTaskAndReply(
test_task_runner.get(), FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE),
MakeExpectedNotRunClosure(FROM_HERE));
std::ignore = task_tracker_.NewTrackedTaskId(&is_canceled);
}
test_task_runner->RunUntilIdle();
RunLoop().RunUntilIdle();
EXPECT_FALSE(is_canceled.Run());
}
// Post a task and cancel it. HasTrackedTasks() should return false as soon as
// TryCancel() returns, otherwise we may have leaked per-task state.
TEST_F(CancelableTaskTrackerTest, HasTrackedTasksCancelById) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
CancelableTaskTracker::TaskId task_id = task_tracker_.PostTask(
test_task_runner.get(), FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE));
EXPECT_TRUE(task_tracker_.HasTrackedTasks());
task_tracker_.TryCancel(task_id);
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
test_task_runner->RunUntilIdle();
RunLoop().RunUntilIdle();
}
// Post a task and then cancel all tasks. HasTrackedTasks() should return false
// as soon as TryCancelAll() is called.
TEST_F(CancelableTaskTrackerTest, HasTrackedTasksPostCancelAll) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
std::ignore = task_tracker_.PostTask(test_task_runner.get(), FROM_HERE,
MakeExpectedNotRunClosure(FROM_HERE));
task_tracker_.TryCancelAll();
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
test_task_runner->RunUntilIdle();
RunLoop().RunUntilIdle();
}
// Post a task with a reply and cancel it. HasTrackedTasks() should return false
// as soon as TryCancelAll() is called.
TEST_F(CancelableTaskTrackerTest, HasTrackedTasksPostWithReplyCancelAll) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
std::ignore = task_tracker_.PostTaskAndReply(
test_task_runner.get(), FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE),
MakeExpectedNotRunClosure(FROM_HERE));
task_tracker_.TryCancelAll();
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
test_task_runner->RunUntilIdle();
RunLoop().RunUntilIdle();
}
// Create a new tracked task ID. HasTrackedTasks() should return false as soon
// as TryCancelAll() is called.
TEST_F(CancelableTaskTrackerTest, HasTrackedTasksIsCancelledCancelAll) {
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
CancelableTaskTracker::IsCanceledCallback is_canceled;
std::ignore = task_tracker_.NewTrackedTaskId(&is_canceled);
task_tracker_.TryCancelAll();
EXPECT_FALSE(task_tracker_.HasTrackedTasks());
}
// The death tests below make sure that calling task tracker member
// functions from a thread different from its owner thread DCHECKs in
// debug mode.
class CancelableTaskTrackerDeathTest : public CancelableTaskTrackerTest {
protected:
CancelableTaskTrackerDeathTest() {
// The default style "fast" does not support multi-threaded tests.
::testing::FLAGS_gtest_death_test_style = "threadsafe";
}
};
// Runs |fn| with |task_tracker|, expecting it to crash in debug mode.
void MaybeRunDeadlyTaskTrackerMemberFunction(
CancelableTaskTracker* task_tracker,
OnceCallback<void(CancelableTaskTracker*)> fn) {
EXPECT_DCHECK_DEATH(std::move(fn).Run(task_tracker));
}
void PostDoNothingTask(CancelableTaskTracker* task_tracker) {
std::ignore = task_tracker->PostTask(
scoped_refptr<TestSimpleTaskRunner>(new TestSimpleTaskRunner()).get(),
FROM_HERE, DoNothing());
}
TEST_F(CancelableTaskTrackerDeathTest, PostFromDifferentThread) {
Thread bad_thread("bad thread");
ASSERT_TRUE(bad_thread.Start());
bad_thread.task_runner()->PostTask(
FROM_HERE,
BindOnce(&MaybeRunDeadlyTaskTrackerMemberFunction,
Unretained(&task_tracker_), BindOnce(&PostDoNothingTask)));
}
void TryCancel(CancelableTaskTracker::TaskId task_id,
CancelableTaskTracker* task_tracker) {
task_tracker->TryCancel(task_id);
}
TEST_F(CancelableTaskTrackerDeathTest, CancelOnDifferentThread) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
Thread bad_thread("bad thread");
ASSERT_TRUE(bad_thread.Start());
CancelableTaskTracker::TaskId task_id =
task_tracker_.PostTask(test_task_runner.get(), FROM_HERE, DoNothing());
EXPECT_NE(CancelableTaskTracker::kBadTaskId, task_id);
bad_thread.task_runner()->PostTask(
FROM_HERE,
BindOnce(&MaybeRunDeadlyTaskTrackerMemberFunction,
Unretained(&task_tracker_), BindOnce(&TryCancel, task_id)));
test_task_runner->RunUntilIdle();
}
TEST_F(CancelableTaskTrackerDeathTest, CancelAllOnDifferentThread) {
scoped_refptr<TestSimpleTaskRunner> test_task_runner(
new TestSimpleTaskRunner());
Thread bad_thread("bad thread");
ASSERT_TRUE(bad_thread.Start());
CancelableTaskTracker::TaskId task_id =
task_tracker_.PostTask(test_task_runner.get(), FROM_HERE, DoNothing());
EXPECT_NE(CancelableTaskTracker::kBadTaskId, task_id);
bad_thread.task_runner()->PostTask(
FROM_HERE, BindOnce(&MaybeRunDeadlyTaskTrackerMemberFunction,
Unretained(&task_tracker_),
BindOnce(&CancelableTaskTracker::TryCancelAll)));
test_task_runner->RunUntilIdle();
}
} // namespace base
|