blob: f79a971281df149796aa7a41cb8039df0ea27f37 [file] [log] [blame]
// Copyright 2017 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/test/scoped_task_environment.h"
#include <memory>
#include "base/atomicops.h"
#include "base/bind.h"
#include "base/bind_helpers.h"
#include "base/cancelable_callback.h"
#include "base/run_loop.h"
#include "base/synchronization/atomic_flag.h"
#include "base/synchronization/waitable_event.h"
#include "base/task/post_task.h"
#include "base/task/sequence_manager/time_domain.h"
#include "base/test/mock_callback.h"
#include "base/test/test_timeouts.h"
#include "base/threading/platform_thread.h"
#include "base/threading/sequence_local_storage_slot.h"
#include "base/threading/thread_task_runner_handle.h"
#include "base/time/clock.h"
#include "base/time/default_clock.h"
#include "base/time/tick_clock.h"
#include "base/win/com_init_util.h"
#include "build/build_config.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest-spi.h"
#include "testing/gtest/include/gtest/gtest.h"
#if defined(OS_POSIX)
#include <unistd.h>
#include "base/files/file_descriptor_watcher_posix.h"
#endif // defined(OS_POSIX)
namespace base {
namespace test {
namespace {
class ScopedTaskEnvironmentForTest : public ScopedTaskEnvironment {
public:
template <
class... ArgTypes,
class CheckArgumentsAreValid = std::enable_if_t<
base::trait_helpers::AreValidTraits<ScopedTaskEnvironment::ValidTrait,
ArgTypes...>::value>>
NOINLINE ScopedTaskEnvironmentForTest(const ArgTypes... args)
: ScopedTaskEnvironment(args...) {}
using ScopedTaskEnvironment::GetTimeDomain;
};
class ScopedTaskEnvironmentTest
: public testing::TestWithParam<ScopedTaskEnvironment::MainThreadType> {};
void VerifyRunUntilIdleDidNotReturnAndSetFlag(
AtomicFlag* run_until_idle_returned,
AtomicFlag* task_ran) {
EXPECT_FALSE(run_until_idle_returned->IsSet());
task_ran->Set();
}
void RunUntilIdleTest(
ScopedTaskEnvironment::MainThreadType main_thread_type,
ScopedTaskEnvironment::ExecutionMode execution_control_mode) {
AtomicFlag run_until_idle_returned;
ScopedTaskEnvironment scoped_task_environment(main_thread_type,
execution_control_mode);
AtomicFlag first_main_thread_task_ran;
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, BindOnce(&VerifyRunUntilIdleDidNotReturnAndSetFlag,
Unretained(&run_until_idle_returned),
Unretained(&first_main_thread_task_ran)));
AtomicFlag first_task_scheduler_task_ran;
PostTask(FROM_HERE, BindOnce(&VerifyRunUntilIdleDidNotReturnAndSetFlag,
Unretained(&run_until_idle_returned),
Unretained(&first_task_scheduler_task_ran)));
AtomicFlag second_task_scheduler_task_ran;
AtomicFlag second_main_thread_task_ran;
PostTaskAndReply(FROM_HERE,
BindOnce(&VerifyRunUntilIdleDidNotReturnAndSetFlag,
Unretained(&run_until_idle_returned),
Unretained(&second_task_scheduler_task_ran)),
BindOnce(&VerifyRunUntilIdleDidNotReturnAndSetFlag,
Unretained(&run_until_idle_returned),
Unretained(&second_main_thread_task_ran)));
scoped_task_environment.RunUntilIdle();
run_until_idle_returned.Set();
EXPECT_TRUE(first_main_thread_task_ran.IsSet());
EXPECT_TRUE(first_task_scheduler_task_ran.IsSet());
EXPECT_TRUE(second_task_scheduler_task_ran.IsSet());
EXPECT_TRUE(second_main_thread_task_ran.IsSet());
}
} // namespace
TEST_P(ScopedTaskEnvironmentTest, QueuedRunUntilIdle) {
RunUntilIdleTest(GetParam(), ScopedTaskEnvironment::ExecutionMode::QUEUED);
}
TEST_P(ScopedTaskEnvironmentTest, AsyncRunUntilIdle) {
RunUntilIdleTest(GetParam(), ScopedTaskEnvironment::ExecutionMode::ASYNC);
}
// Verify that tasks posted to an ExecutionMode::QUEUED ScopedTaskEnvironment do
// not run outside of RunUntilIdle().
TEST_P(ScopedTaskEnvironmentTest, QueuedTasksDoNotRunOutsideOfRunUntilIdle) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::QUEUED);
AtomicFlag run_until_idle_called;
PostTask(FROM_HERE, BindOnce(
[](AtomicFlag* run_until_idle_called) {
EXPECT_TRUE(run_until_idle_called->IsSet());
},
Unretained(&run_until_idle_called)));
PlatformThread::Sleep(TestTimeouts::tiny_timeout());
run_until_idle_called.Set();
scoped_task_environment.RunUntilIdle();
AtomicFlag other_run_until_idle_called;
PostTask(FROM_HERE, BindOnce(
[](AtomicFlag* other_run_until_idle_called) {
EXPECT_TRUE(other_run_until_idle_called->IsSet());
},
Unretained(&other_run_until_idle_called)));
PlatformThread::Sleep(TestTimeouts::tiny_timeout());
other_run_until_idle_called.Set();
scoped_task_environment.RunUntilIdle();
}
// Verify that a task posted to an ExecutionMode::ASYNC ScopedTaskEnvironment
// can run without a call to RunUntilIdle().
TEST_P(ScopedTaskEnvironmentTest, AsyncTasksRunAsTheyArePosted) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::ASYNC);
WaitableEvent task_ran(WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED);
PostTask(FROM_HERE,
BindOnce([](WaitableEvent* task_ran) { task_ran->Signal(); },
Unretained(&task_ran)));
task_ran.Wait();
}
// Verify that a task posted to an ExecutionMode::ASYNC ScopedTaskEnvironment
// after a call to RunUntilIdle() can run without another call to
// RunUntilIdle().
TEST_P(ScopedTaskEnvironmentTest,
AsyncTasksRunAsTheyArePostedAfterRunUntilIdle) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::ASYNC);
scoped_task_environment.RunUntilIdle();
WaitableEvent task_ran(WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED);
PostTask(FROM_HERE,
BindOnce([](WaitableEvent* task_ran) { task_ran->Signal(); },
Unretained(&task_ran)));
task_ran.Wait();
}
TEST_P(ScopedTaskEnvironmentTest, DelayedTasks) {
// Use a QUEUED execution-mode environment, so that no tasks are actually
// executed until RunUntilIdle()/FastForwardBy() are invoked.
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::QUEUED);
subtle::Atomic32 counter = 0;
constexpr base::TimeDelta kShortTaskDelay = TimeDelta::FromDays(1);
// Should run only in MOCK_TIME environment when time is fast-forwarded.
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
BindOnce(
[](subtle::Atomic32* counter) {
subtle::NoBarrier_AtomicIncrement(counter, 4);
},
Unretained(&counter)),
kShortTaskDelay);
// TODO(gab): This currently doesn't run because the TaskScheduler's clock
// isn't mocked but it should be.
PostDelayedTask(FROM_HERE,
BindOnce(
[](subtle::Atomic32* counter) {
subtle::NoBarrier_AtomicIncrement(counter, 128);
},
Unretained(&counter)),
kShortTaskDelay);
constexpr base::TimeDelta kLongTaskDelay = TimeDelta::FromDays(7);
// Same as first task, longer delays to exercise
// FastForwardUntilNoTasksRemain().
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
BindOnce(
[](subtle::Atomic32* counter) {
subtle::NoBarrier_AtomicIncrement(counter, 8);
},
Unretained(&counter)),
TimeDelta::FromDays(5));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
BindOnce(
[](subtle::Atomic32* counter) {
subtle::NoBarrier_AtomicIncrement(counter, 16);
},
Unretained(&counter)),
kLongTaskDelay);
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, BindOnce(
[](subtle::Atomic32* counter) {
subtle::NoBarrier_AtomicIncrement(counter, 1);
},
Unretained(&counter)));
PostTask(FROM_HERE, BindOnce(
[](subtle::Atomic32* counter) {
subtle::NoBarrier_AtomicIncrement(counter, 2);
},
Unretained(&counter)));
// This expectation will fail flakily if the preceding PostTask() is executed
// asynchronously, indicating a problem with the QUEUED execution mode.
int expected_value = 0;
EXPECT_EQ(expected_value, counter);
// RunUntilIdle() should process non-delayed tasks only in all queues.
scoped_task_environment.RunUntilIdle();
expected_value += 1;
expected_value += 2;
EXPECT_EQ(expected_value, counter);
if (GetParam() == ScopedTaskEnvironment::MainThreadType::MOCK_TIME) {
// Delay inferior to the delay of the first posted task.
constexpr base::TimeDelta kInferiorTaskDelay = TimeDelta::FromSeconds(1);
static_assert(kInferiorTaskDelay < kShortTaskDelay,
"|kInferiorTaskDelay| should be "
"set to a value inferior to the first posted task's delay.");
scoped_task_environment.FastForwardBy(kInferiorTaskDelay);
EXPECT_EQ(expected_value, counter);
scoped_task_environment.FastForwardBy(kShortTaskDelay - kInferiorTaskDelay);
expected_value += 4;
EXPECT_EQ(expected_value, counter);
scoped_task_environment.FastForwardUntilNoTasksRemain();
expected_value += 8;
expected_value += 16;
EXPECT_EQ(expected_value, counter);
}
}
// Regression test for https://crbug.com/824770.
TEST_P(ScopedTaskEnvironmentTest, SupportsSequenceLocalStorageOnMainThread) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::ASYNC);
SequenceLocalStorageSlot<int> sls_slot;
sls_slot.Set(5);
EXPECT_EQ(5, sls_slot.Get());
}
#if defined(OS_POSIX)
TEST_F(ScopedTaskEnvironmentTest, SupportsFileDescriptorWatcherOnIOMainThread) {
ScopedTaskEnvironment scoped_task_environment(
ScopedTaskEnvironment::MainThreadType::IO,
ScopedTaskEnvironment::ExecutionMode::ASYNC);
int pipe_fds_[2];
ASSERT_EQ(0, pipe(pipe_fds_));
RunLoop run_loop;
// The write end of a newly created pipe is immediately writable.
auto controller = FileDescriptorWatcher::WatchWritable(
pipe_fds_[1], run_loop.QuitClosure());
// This will hang if the notification doesn't occur as expected.
run_loop.Run();
}
#endif // defined(OS_POSIX)
// Verify that the TickClock returned by
// |ScopedTaskEnvironment::GetMockTickClock| gets updated when the
// FastForward(By|UntilNoTasksRemain) functions are called.
TEST_F(ScopedTaskEnvironmentTest, FastForwardAdvanceTickClock) {
// Use a QUEUED execution-mode environment, so that no tasks are actually
// executed until RunUntilIdle()/FastForwardBy() are invoked.
ScopedTaskEnvironment scoped_task_environment(
ScopedTaskEnvironment::MainThreadType::MOCK_TIME,
ScopedTaskEnvironment::ExecutionMode::QUEUED);
constexpr base::TimeDelta kShortTaskDelay = TimeDelta::FromDays(1);
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, base::DoNothing(),
kShortTaskDelay);
constexpr base::TimeDelta kLongTaskDelay = TimeDelta::FromDays(7);
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, base::DoNothing(),
kLongTaskDelay);
const base::TickClock* tick_clock =
scoped_task_environment.GetMockTickClock();
base::TimeTicks tick_clock_ref = tick_clock->NowTicks();
// Make sure that |FastForwardBy| advances the clock.
scoped_task_environment.FastForwardBy(kShortTaskDelay);
EXPECT_EQ(kShortTaskDelay, tick_clock->NowTicks() - tick_clock_ref);
// Make sure that |FastForwardUntilNoTasksRemain| advances the clock.
scoped_task_environment.FastForwardUntilNoTasksRemain();
EXPECT_EQ(kLongTaskDelay, tick_clock->NowTicks() - tick_clock_ref);
// Fast-forwarding to a time at which there's no tasks should also advance the
// clock.
scoped_task_environment.FastForwardBy(kLongTaskDelay);
EXPECT_EQ(kLongTaskDelay * 2, tick_clock->NowTicks() - tick_clock_ref);
}
TEST_F(ScopedTaskEnvironmentTest, FastForwardAdvanceMockClock) {
constexpr base::TimeDelta kDelay = TimeDelta::FromSeconds(42);
ScopedTaskEnvironment scoped_task_environment(
ScopedTaskEnvironment::MainThreadType::MOCK_TIME);
const Clock* clock = scoped_task_environment.GetMockClock();
const Time start_time = clock->Now();
scoped_task_environment.FastForwardBy(kDelay);
EXPECT_EQ(start_time + kDelay, clock->Now());
}
TEST_F(ScopedTaskEnvironmentTest, FastForwardAdvanceTime) {
constexpr base::TimeDelta kDelay = TimeDelta::FromSeconds(42);
ScopedTaskEnvironment scoped_task_environment(
ScopedTaskEnvironment::MainThreadType::MOCK_TIME,
ScopedTaskEnvironment::NowSource::MAIN_THREAD_MOCK_TIME);
const Time start_time = base::Time::Now();
scoped_task_environment.FastForwardBy(kDelay);
EXPECT_EQ(start_time + kDelay, base::Time::Now());
}
TEST_F(ScopedTaskEnvironmentTest, FastForwardAdvanceTimeTicks) {
constexpr base::TimeDelta kDelay = TimeDelta::FromSeconds(42);
ScopedTaskEnvironment scoped_task_environment(
ScopedTaskEnvironment::MainThreadType::MOCK_TIME,
ScopedTaskEnvironment::NowSource::MAIN_THREAD_MOCK_TIME);
const TimeTicks start_time = base::TimeTicks::Now();
scoped_task_environment.FastForwardBy(kDelay);
EXPECT_EQ(start_time + kDelay, base::TimeTicks::Now());
}
TEST_F(ScopedTaskEnvironmentTest, MockTimeDomain_MaybeFastForwardToNextTask) {
constexpr base::TimeDelta kDelay = TimeDelta::FromSeconds(42);
ScopedTaskEnvironmentForTest scoped_task_environment(
ScopedTaskEnvironment::MainThreadType::MOCK_TIME,
ScopedTaskEnvironment::NowSource::MAIN_THREAD_MOCK_TIME);
const TimeTicks start_time = base::TimeTicks::Now();
EXPECT_FALSE(
scoped_task_environment.GetTimeDomain()->MaybeFastForwardToNextTask(
false));
EXPECT_EQ(start_time, base::TimeTicks::Now());
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, base::DoNothing(),
kDelay);
EXPECT_TRUE(
scoped_task_environment.GetTimeDomain()->MaybeFastForwardToNextTask(
false));
EXPECT_EQ(start_time + kDelay, base::TimeTicks::Now());
}
TEST_F(ScopedTaskEnvironmentTest,
MockTimeDomain_MaybeFastForwardToNextTask_ImmediateTaskPending) {
constexpr base::TimeDelta kDelay = TimeDelta::FromSeconds(42);
ScopedTaskEnvironmentForTest scoped_task_environment(
ScopedTaskEnvironment::MainThreadType::MOCK_TIME,
ScopedTaskEnvironment::NowSource::MAIN_THREAD_MOCK_TIME);
const TimeTicks start_time = base::TimeTicks::Now();
EXPECT_FALSE(
scoped_task_environment.GetTimeDomain()->MaybeFastForwardToNextTask(
false));
EXPECT_EQ(start_time, base::TimeTicks::Now());
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, base::DoNothing(),
kDelay);
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, base::DoNothing());
EXPECT_FALSE(
scoped_task_environment.GetTimeDomain()->MaybeFastForwardToNextTask(
false));
EXPECT_EQ(start_time, base::TimeTicks::Now());
}
#if defined(OS_WIN)
// Regression test to ensure that ScopedTaskEnvironment enables the MTA in the
// thread pool (so that the test environment matches that of the browser process
// and com_init_util.h's assertions are happy in unit tests).
TEST_F(ScopedTaskEnvironmentTest, TaskSchedulerPoolAllowsMTA) {
ScopedTaskEnvironment scoped_task_environment;
PostTask(FROM_HERE,
BindOnce(&win::AssertComApartmentType, win::ComApartmentType::MTA));
scoped_task_environment.RunUntilIdle();
}
#endif // defined(OS_WIN)
TEST_F(ScopedTaskEnvironmentTest, SetsDefaultRunTimeout) {
const RunLoop::ScopedRunTimeoutForTest* old_run_timeout =
RunLoop::ScopedRunTimeoutForTest::Current();
{
ScopedTaskEnvironment scoped_task_environment;
// ScopedTaskEnvironment should set a default Run() timeout that fails the
// calling test.
const RunLoop::ScopedRunTimeoutForTest* run_timeout =
RunLoop::ScopedRunTimeoutForTest::Current();
ASSERT_NE(run_timeout, old_run_timeout);
EXPECT_EQ(run_timeout->timeout(), TestTimeouts::action_max_timeout());
EXPECT_NONFATAL_FAILURE({ run_timeout->on_timeout().Run(); },
"Run() timed out");
}
EXPECT_EQ(RunLoop::ScopedRunTimeoutForTest::Current(), old_run_timeout);
}
INSTANTIATE_TEST_SUITE_P(
MainThreadDefault,
ScopedTaskEnvironmentTest,
::testing::Values(ScopedTaskEnvironment::MainThreadType::DEFAULT));
INSTANTIATE_TEST_SUITE_P(
MainThreadMockTime,
ScopedTaskEnvironmentTest,
::testing::Values(ScopedTaskEnvironment::MainThreadType::MOCK_TIME));
INSTANTIATE_TEST_SUITE_P(
MainThreadUIMockTime,
ScopedTaskEnvironmentTest,
::testing::Values(ScopedTaskEnvironment::MainThreadType::UI_MOCK_TIME));
INSTANTIATE_TEST_SUITE_P(
MainThreadUI,
ScopedTaskEnvironmentTest,
::testing::Values(ScopedTaskEnvironment::MainThreadType::UI));
INSTANTIATE_TEST_SUITE_P(
MainThreadIO,
ScopedTaskEnvironmentTest,
::testing::Values(ScopedTaskEnvironment::MainThreadType::IO));
INSTANTIATE_TEST_SUITE_P(
MainThreadIOMockTime,
ScopedTaskEnvironmentTest,
::testing::Values(ScopedTaskEnvironment::MainThreadType::IO_MOCK_TIME));
class ScopedTaskEnvironmentMockedTime
: public testing::TestWithParam<ScopedTaskEnvironment::MainThreadType> {};
TEST_P(ScopedTaskEnvironmentMockedTime, Basic) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::QUEUED);
int counter = 0;
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE,
BindOnce([](int* counter) { *counter += 1; }, Unretained(&counter)));
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE,
BindOnce([](int* counter) { *counter += 32; }, Unretained(&counter)));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
BindOnce([](int* counter) { *counter += 256; }, Unretained(&counter)),
TimeDelta::FromSeconds(3));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
BindOnce([](int* counter) { *counter += 64; }, Unretained(&counter)),
TimeDelta::FromSeconds(1));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
BindOnce([](int* counter) { *counter += 1024; }, Unretained(&counter)),
TimeDelta::FromMinutes(20));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
BindOnce([](int* counter) { *counter += 4096; }, Unretained(&counter)),
TimeDelta::FromDays(20));
int expected_value = 0;
EXPECT_EQ(expected_value, counter);
scoped_task_environment.RunUntilIdle();
expected_value += 1;
expected_value += 32;
EXPECT_EQ(expected_value, counter);
scoped_task_environment.RunUntilIdle();
EXPECT_EQ(expected_value, counter);
scoped_task_environment.FastForwardBy(TimeDelta::FromSeconds(1));
expected_value += 64;
EXPECT_EQ(expected_value, counter);
scoped_task_environment.FastForwardBy(TimeDelta::FromSeconds(5));
expected_value += 256;
EXPECT_EQ(expected_value, counter);
scoped_task_environment.FastForwardUntilNoTasksRemain();
expected_value += 1024;
expected_value += 4096;
EXPECT_EQ(expected_value, counter);
}
TEST_P(ScopedTaskEnvironmentMockedTime, RunLoopDriveable) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::QUEUED);
int counter = 0;
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, base::BindOnce([](int* counter) { *counter += 1; },
Unretained(&counter)));
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, base::BindOnce([](int* counter) { *counter += 32; },
Unretained(&counter)));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
base::BindOnce([](int* counter) { *counter += 256; },
Unretained(&counter)),
TimeDelta::FromSeconds(3));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
base::BindOnce([](int* counter) { *counter += 64; },
Unretained(&counter)),
TimeDelta::FromSeconds(1));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
base::BindOnce([](int* counter) { *counter += 1024; },
Unretained(&counter)),
TimeDelta::FromMinutes(20));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
base::BindOnce([](int* counter) { *counter += 4096; },
Unretained(&counter)),
TimeDelta::FromDays(20));
int expected_value = 0;
EXPECT_EQ(expected_value, counter);
RunLoop().RunUntilIdle();
expected_value += 1;
expected_value += 32;
EXPECT_EQ(expected_value, counter);
RunLoop().RunUntilIdle();
EXPECT_EQ(expected_value, counter);
{
RunLoop run_loop;
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, run_loop.QuitClosure(), TimeDelta::FromSeconds(1));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
base::BindOnce([](int* counter) { *counter += 8192; },
Unretained(&counter)),
TimeDelta::FromSeconds(1));
// The QuitClosure() should be ordered between the 64 and the 8192
// increments and should preempt the latter.
run_loop.Run();
expected_value += 64;
EXPECT_EQ(expected_value, counter);
// Running until idle should process the 8192 increment whose delay has
// expired in the previous Run().
RunLoop().RunUntilIdle();
expected_value += 8192;
EXPECT_EQ(expected_value, counter);
}
{
RunLoop run_loop;
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, run_loop.QuitWhenIdleClosure(), TimeDelta::FromSeconds(5));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE,
base::BindOnce([](int* counter) { *counter += 16384; },
Unretained(&counter)),
TimeDelta::FromSeconds(5));
// The QuitWhenIdleClosure() shouldn't preempt equally delayed tasks and as
// such the 16384 increment should be processed before quitting.
run_loop.Run();
expected_value += 256;
expected_value += 16384;
EXPECT_EQ(expected_value, counter);
}
// Process the remaining tasks (note: do not mimic this elsewhere,
// TestMockTimeTaskRunner::FastForwardUntilNoTasksRemain() is a better API to
// do this, this is just done here for the purpose of extensively testing the
// RunLoop approach).
// Disable Run() timeout here, otherwise we'll fast-forward to it before we
// reach the quit task.
RunLoop::ScopedDisableRunTimeoutForTest disable_timeout;
RunLoop run_loop;
ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, run_loop.QuitWhenIdleClosure(), TimeDelta::FromDays(50));
run_loop.Run();
expected_value += 1024;
expected_value += 4096;
EXPECT_EQ(expected_value, counter);
}
TEST_P(ScopedTaskEnvironmentMockedTime, CancelPendingTask) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::QUEUED);
CancelableOnceClosure task1(BindOnce([]() {}));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, task1.callback(),
TimeDelta::FromSeconds(1));
EXPECT_TRUE(scoped_task_environment.MainThreadIsIdle());
EXPECT_EQ(1u, scoped_task_environment.GetPendingMainThreadTaskCount());
EXPECT_EQ(TimeDelta::FromSeconds(1),
scoped_task_environment.NextMainThreadPendingTaskDelay());
EXPECT_TRUE(scoped_task_environment.MainThreadIsIdle());
task1.Cancel();
EXPECT_TRUE(scoped_task_environment.MainThreadIsIdle());
EXPECT_EQ(TimeDelta::Max(),
scoped_task_environment.NextMainThreadPendingTaskDelay());
CancelableClosure task2(BindRepeating([]() {}));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, task2.callback(),
TimeDelta::FromSeconds(1));
task2.Cancel();
EXPECT_EQ(0u, scoped_task_environment.GetPendingMainThreadTaskCount());
CancelableClosure task3(BindRepeating([]() {}));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, task3.callback(),
TimeDelta::FromSeconds(1));
task3.Cancel();
EXPECT_EQ(TimeDelta::Max(),
scoped_task_environment.NextMainThreadPendingTaskDelay());
CancelableClosure task4(BindRepeating([]() {}));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, task4.callback(),
TimeDelta::FromSeconds(1));
task4.Cancel();
EXPECT_TRUE(scoped_task_environment.MainThreadIsIdle());
}
TEST_P(ScopedTaskEnvironmentMockedTime, CancelPendingImmediateTask) {
ScopedTaskEnvironment scoped_task_environment(GetParam());
EXPECT_TRUE(scoped_task_environment.MainThreadIsIdle());
CancelableOnceClosure task1(BindOnce([]() {}));
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, task1.callback());
EXPECT_FALSE(scoped_task_environment.MainThreadIsIdle());
task1.Cancel();
EXPECT_TRUE(scoped_task_environment.MainThreadIsIdle());
}
TEST_P(ScopedTaskEnvironmentMockedTime, NoFastForwardToCancelledTask) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::ExecutionMode::QUEUED);
TimeTicks start_time = scoped_task_environment.NowTicks();
CancelableClosure task(BindRepeating([]() {}));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, task.callback(),
TimeDelta::FromSeconds(1));
EXPECT_EQ(TimeDelta::FromSeconds(1),
scoped_task_environment.NextMainThreadPendingTaskDelay());
task.Cancel();
scoped_task_environment.FastForwardUntilNoTasksRemain();
EXPECT_EQ(start_time, scoped_task_environment.NowTicks());
}
TEST_P(ScopedTaskEnvironmentMockedTime, NowSource) {
ScopedTaskEnvironment scoped_task_environment(
GetParam(), ScopedTaskEnvironment::NowSource::MAIN_THREAD_MOCK_TIME);
TimeTicks start_time = scoped_task_environment.NowTicks();
EXPECT_EQ(TimeTicks::Now(), start_time);
constexpr TimeDelta delay = TimeDelta::FromSeconds(10);
scoped_task_environment.FastForwardBy(delay);
EXPECT_EQ(TimeTicks::Now(), start_time + delay);
}
TEST_P(ScopedTaskEnvironmentMockedTime, NextTaskIsDelayed) {
ScopedTaskEnvironment scoped_task_environment(GetParam());
EXPECT_FALSE(scoped_task_environment.NextTaskIsDelayed());
CancelableClosure task(BindRepeating([]() {}));
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, task.callback(),
TimeDelta::FromSeconds(1));
EXPECT_TRUE(scoped_task_environment.NextTaskIsDelayed());
task.Cancel();
EXPECT_FALSE(scoped_task_environment.NextTaskIsDelayed());
ThreadTaskRunnerHandle::Get()->PostDelayedTask(FROM_HERE, BindOnce([]() {}),
TimeDelta::FromSeconds(2));
EXPECT_TRUE(scoped_task_environment.NextTaskIsDelayed());
scoped_task_environment.FastForwardUntilNoTasksRemain();
EXPECT_FALSE(scoped_task_environment.NextTaskIsDelayed());
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, BindOnce([]() {}));
EXPECT_FALSE(scoped_task_environment.NextTaskIsDelayed());
}
TEST_P(ScopedTaskEnvironmentMockedTime,
NextMainThreadPendingTaskDelayWithImmediateTask) {
ScopedTaskEnvironment scoped_task_environment(GetParam());
EXPECT_EQ(TimeDelta::Max(),
scoped_task_environment.NextMainThreadPendingTaskDelay());
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, BindOnce([]() {}));
EXPECT_EQ(TimeDelta(),
scoped_task_environment.NextMainThreadPendingTaskDelay());
}
INSTANTIATE_TEST_SUITE_P(
MainThreadMockTime,
ScopedTaskEnvironmentMockedTime,
::testing::Values(ScopedTaskEnvironment::MainThreadType::MOCK_TIME));
INSTANTIATE_TEST_SUITE_P(
MainThreadUIMockTime,
ScopedTaskEnvironmentMockedTime,
::testing::Values(ScopedTaskEnvironment::MainThreadType::UI_MOCK_TIME));
INSTANTIATE_TEST_SUITE_P(
MainThreadIOMockTime,
ScopedTaskEnvironmentMockedTime,
::testing::Values(ScopedTaskEnvironment::MainThreadType::IO_MOCK_TIME));
} // namespace test
} // namespace base