evan@chromium.org | 3c0bc35 | 2012-02-14 09:29:14 +0900 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
license.bot | f003cfe | 2008-08-24 09:55:55 +0900 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 4 | |
dcheng | cc8e4d8 | 2016-04-05 06:25:51 +0900 | [diff] [blame] | 5 | #include "base/timer/timer.h" |
| 6 | |
avi | a6a6a68 | 2015-12-27 07:15:14 +0900 | [diff] [blame] | 7 | #include <stddef.h> |
| 8 | |
dcheng | cc8e4d8 | 2016-04-05 06:25:51 +0900 | [diff] [blame] | 9 | #include <memory> |
| 10 | |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 11 | #include "base/bind.h" |
| 12 | #include "base/bind_helpers.h" |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 13 | #include "base/callback.h" |
avi | a6a6a68 | 2015-12-27 07:15:14 +0900 | [diff] [blame] | 14 | #include "base/macros.h" |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 15 | #include "base/memory/ptr_util.h" |
pkotwicz | 55d7a1e | 2017-01-18 05:45:26 +0900 | [diff] [blame] | 16 | #include "base/memory/ref_counted.h" |
avi@chromium.org | a043a86 | 2013-07-18 17:12:40 +0900 | [diff] [blame] | 17 | #include "base/message_loop/message_loop.h" |
fdoray | 85919bb | 2016-07-01 03:17:39 +0900 | [diff] [blame] | 18 | #include "base/run_loop.h" |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 19 | #include "base/sequenced_task_runner.h" |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 20 | #include "base/synchronization/waitable_event.h" |
| 21 | #include "base/test/sequenced_worker_pool_owner.h" |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 22 | #include "base/test/test_mock_time_task_runner.h" |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 23 | #include "base/threading/platform_thread.h" |
| 24 | #include "base/threading/sequenced_task_runner_handle.h" |
| 25 | #include "base/threading/thread.h" |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 26 | #include "base/time/tick_clock.h" |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 27 | #include "base/time/time.h" |
avi | a6a6a68 | 2015-12-27 07:15:14 +0900 | [diff] [blame] | 28 | #include "build/build_config.h" |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 29 | #include "testing/gtest/include/gtest/gtest.h" |
| 30 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 31 | namespace base { |
dsh@google.com | 0f8dd26 | 2008-10-28 05:43:33 +0900 | [diff] [blame] | 32 | |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 33 | namespace { |
| 34 | |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 35 | // The message loops on which each timer should be tested. |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 36 | const MessageLoop::Type testing_message_loops[] = { |
| 37 | MessageLoop::TYPE_DEFAULT, MessageLoop::TYPE_IO, |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 38 | #if !defined(OS_IOS) // iOS does not allow direct running of the UI loop. |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 39 | MessageLoop::TYPE_UI, |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 40 | #endif |
| 41 | }; |
| 42 | |
| 43 | const int kNumTestingMessageLoops = arraysize(testing_message_loops); |
| 44 | |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 45 | class Receiver { |
| 46 | public: |
| 47 | Receiver() : count_(0) {} |
| 48 | void OnCalled() { count_++; } |
| 49 | bool WasCalled() { return count_ > 0; } |
| 50 | int TimesCalled() { return count_; } |
| 51 | |
| 52 | private: |
| 53 | int count_; |
| 54 | }; |
| 55 | |
ahest | 9a63aa2 | 2016-12-13 20:34:38 +0900 | [diff] [blame] | 56 | // A basic helper class that can start a one-shot timer and signal a |
| 57 | // WaitableEvent when this timer fires. |
| 58 | class OneShotTimerTesterBase { |
| 59 | public: |
| 60 | // |did_run|, if provided, will be signaled when Run() fires. |
| 61 | explicit OneShotTimerTesterBase( |
| 62 | WaitableEvent* did_run = nullptr, |
| 63 | const TimeDelta& delay = TimeDelta::FromMilliseconds(10)) |
| 64 | : did_run_(did_run), delay_(delay) {} |
| 65 | |
| 66 | virtual ~OneShotTimerTesterBase() = default; |
| 67 | |
| 68 | void Start() { |
| 69 | started_time_ = TimeTicks::Now(); |
| 70 | timer_->Start(FROM_HERE, delay_, this, &OneShotTimerTesterBase::Run); |
| 71 | } |
| 72 | |
| 73 | bool IsRunning() { return timer_->IsRunning(); } |
| 74 | |
| 75 | TimeTicks started_time() const { return started_time_; } |
| 76 | TimeDelta delay() const { return delay_; } |
| 77 | |
| 78 | protected: |
| 79 | virtual void Run() { |
| 80 | if (did_run_) { |
| 81 | EXPECT_FALSE(did_run_->IsSignaled()); |
| 82 | did_run_->Signal(); |
| 83 | } |
| 84 | } |
| 85 | |
| 86 | std::unique_ptr<OneShotTimer> timer_ = MakeUnique<OneShotTimer>(); |
| 87 | |
| 88 | private: |
| 89 | WaitableEvent* const did_run_; |
| 90 | const TimeDelta delay_; |
| 91 | TimeTicks started_time_; |
| 92 | |
| 93 | DISALLOW_COPY_AND_ASSIGN(OneShotTimerTesterBase); |
| 94 | }; |
| 95 | |
| 96 | // Extends functionality of OneShotTimerTesterBase with the abilities to wait |
| 97 | // until the timer fires and to change task runner for the timer. |
| 98 | class OneShotTimerTester : public OneShotTimerTesterBase { |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 99 | public: |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 100 | // |did_run|, if provided, will be signaled when Run() fires. |
| 101 | explicit OneShotTimerTester( |
| 102 | WaitableEvent* did_run = nullptr, |
| 103 | const TimeDelta& delay = TimeDelta::FromMilliseconds(10)) |
ahest | 9a63aa2 | 2016-12-13 20:34:38 +0900 | [diff] [blame] | 104 | : OneShotTimerTesterBase(did_run, delay), |
| 105 | quit_closure_(run_loop_.QuitClosure()) {} |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 106 | |
ahest | 9a63aa2 | 2016-12-13 20:34:38 +0900 | [diff] [blame] | 107 | ~OneShotTimerTester() override = default; |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 108 | |
gab | b4a7cd4 | 2017-06-02 01:23:36 +0900 | [diff] [blame^] | 109 | void SetTaskRunner(scoped_refptr<SequencedTaskRunner> task_runner) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 110 | timer_->SetTaskRunner(std::move(task_runner)); |
| 111 | |
| 112 | // Run() will be invoked on |task_runner| but |run_loop_|'s QuitClosure |
| 113 | // needs to run on this thread (where the MessageLoop lives). |
gab | b4a7cd4 | 2017-06-02 01:23:36 +0900 | [diff] [blame^] | 114 | quit_closure_ = Bind(IgnoreResult(&SequencedTaskRunner::PostTask), |
| 115 | SequencedTaskRunnerHandle::Get(), FROM_HERE, |
| 116 | run_loop_.QuitClosure()); |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 117 | } |
| 118 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 119 | // Blocks until Run() executes and confirms that Run() didn't fire before |
| 120 | // |delay_| expired. |
| 121 | void WaitAndConfirmTimerFiredAfterDelay() { |
| 122 | run_loop_.Run(); |
| 123 | |
ahest | 9a63aa2 | 2016-12-13 20:34:38 +0900 | [diff] [blame] | 124 | EXPECT_NE(TimeTicks(), started_time()); |
| 125 | EXPECT_GE(TimeTicks::Now() - started_time(), delay()); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 126 | } |
| 127 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 128 | protected: |
| 129 | // Overridable method to do things on Run() before signaling events/closures |
| 130 | // managed by this helper. |
| 131 | virtual void OnRun() {} |
| 132 | |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 133 | private: |
ahest | 9a63aa2 | 2016-12-13 20:34:38 +0900 | [diff] [blame] | 134 | void Run() override { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 135 | OnRun(); |
ahest | 9a63aa2 | 2016-12-13 20:34:38 +0900 | [diff] [blame] | 136 | OneShotTimerTesterBase::Run(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 137 | quit_closure_.Run(); |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 138 | } |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 139 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 140 | RunLoop run_loop_; |
| 141 | Closure quit_closure_; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 142 | |
| 143 | DISALLOW_COPY_AND_ASSIGN(OneShotTimerTester); |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 144 | }; |
| 145 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 146 | class OneShotSelfDeletingTimerTester : public OneShotTimerTester { |
| 147 | protected: |
| 148 | void OnRun() override { timer_.reset(); } |
| 149 | }; |
| 150 | |
| 151 | constexpr int kNumRepeats = 10; |
| 152 | |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 153 | class RepeatingTimerTester { |
| 154 | public: |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 155 | explicit RepeatingTimerTester(WaitableEvent* did_run, const TimeDelta& delay) |
| 156 | : counter_(kNumRepeats), |
| 157 | quit_closure_(run_loop_.QuitClosure()), |
| 158 | did_run_(did_run), |
| 159 | delay_(delay) {} |
erg@google.com | bf6ce9f | 2010-01-27 08:08:02 +0900 | [diff] [blame] | 160 | |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 161 | void Start() { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 162 | started_time_ = TimeTicks::Now(); |
qsr@chromium.org | 38b986c | 2013-12-07 00:22:35 +0900 | [diff] [blame] | 163 | timer_.Start(FROM_HERE, delay_, this, &RepeatingTimerTester::Run); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 164 | } |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 165 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 166 | void WaitAndConfirmTimerFiredRepeatedlyAfterDelay() { |
| 167 | run_loop_.Run(); |
| 168 | |
| 169 | EXPECT_NE(TimeTicks(), started_time_); |
| 170 | EXPECT_GE(TimeTicks::Now() - started_time_, kNumRepeats * delay_); |
| 171 | } |
| 172 | |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 173 | private: |
| 174 | void Run() { |
| 175 | if (--counter_ == 0) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 176 | if (did_run_) { |
| 177 | EXPECT_FALSE(did_run_->IsSignaled()); |
| 178 | did_run_->Signal(); |
| 179 | } |
qsr@chromium.org | 38b986c | 2013-12-07 00:22:35 +0900 | [diff] [blame] | 180 | timer_.Stop(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 181 | quit_closure_.Run(); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 182 | } |
| 183 | } |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 184 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 185 | RepeatingTimer timer_; |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 186 | int counter_; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 187 | |
| 188 | RunLoop run_loop_; |
| 189 | Closure quit_closure_; |
| 190 | WaitableEvent* const did_run_; |
| 191 | |
| 192 | const TimeDelta delay_; |
| 193 | TimeTicks started_time_; |
| 194 | |
| 195 | DISALLOW_COPY_AND_ASSIGN(RepeatingTimerTester); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 196 | }; |
| 197 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 198 | // Basic test with same setup as RunTest_OneShotTimers_Cancel below to confirm |
| 199 | // that |did_run_a| would be signaled in that test if it wasn't for the |
| 200 | // deletion. |
| 201 | void RunTest_OneShotTimers(MessageLoop::Type message_loop_type) { |
| 202 | MessageLoop loop(message_loop_type); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 203 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 204 | WaitableEvent did_run_a(WaitableEvent::ResetPolicy::MANUAL, |
| 205 | WaitableEvent::InitialState::NOT_SIGNALED); |
| 206 | OneShotTimerTester a(&did_run_a); |
| 207 | a.Start(); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 208 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 209 | OneShotTimerTester b; |
| 210 | b.Start(); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 211 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 212 | b.WaitAndConfirmTimerFiredAfterDelay(); |
| 213 | |
| 214 | EXPECT_TRUE(did_run_a.IsSignaled()); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 215 | } |
| 216 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 217 | void RunTest_OneShotTimers_Cancel(MessageLoop::Type message_loop_type) { |
| 218 | MessageLoop loop(message_loop_type); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 219 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 220 | WaitableEvent did_run_a(WaitableEvent::ResetPolicy::MANUAL, |
| 221 | WaitableEvent::InitialState::NOT_SIGNALED); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 222 | OneShotTimerTester* a = new OneShotTimerTester(&did_run_a); |
| 223 | |
| 224 | // This should run before the timer expires. |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 225 | SequencedTaskRunnerHandle::Get()->DeleteSoon(FROM_HERE, a); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 226 | |
| 227 | // Now start the timer. |
| 228 | a->Start(); |
maruel@chromium.org | 8fe7adc | 2009-03-04 00:01:12 +0900 | [diff] [blame] | 229 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 230 | OneShotTimerTester b; |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 231 | b.Start(); |
| 232 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 233 | b.WaitAndConfirmTimerFiredAfterDelay(); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 234 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 235 | EXPECT_FALSE(did_run_a.IsSignaled()); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 236 | } |
| 237 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 238 | void RunTest_OneShotSelfDeletingTimer(MessageLoop::Type message_loop_type) { |
| 239 | MessageLoop loop(message_loop_type); |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 240 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 241 | OneShotSelfDeletingTimerTester f; |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 242 | f.Start(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 243 | f.WaitAndConfirmTimerFiredAfterDelay(); |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 244 | } |
| 245 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 246 | void RunTest_RepeatingTimer(MessageLoop::Type message_loop_type, |
qsr@chromium.org | 38b986c | 2013-12-07 00:22:35 +0900 | [diff] [blame] | 247 | const TimeDelta& delay) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 248 | MessageLoop loop(message_loop_type); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 249 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 250 | RepeatingTimerTester f(nullptr, delay); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 251 | f.Start(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 252 | f.WaitAndConfirmTimerFiredRepeatedlyAfterDelay(); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 253 | } |
| 254 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 255 | void RunTest_RepeatingTimer_Cancel(MessageLoop::Type message_loop_type, |
qsr@chromium.org | 38b986c | 2013-12-07 00:22:35 +0900 | [diff] [blame] | 256 | const TimeDelta& delay) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 257 | MessageLoop loop(message_loop_type); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 258 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 259 | WaitableEvent did_run_a(WaitableEvent::ResetPolicy::MANUAL, |
| 260 | WaitableEvent::InitialState::NOT_SIGNALED); |
qsr@chromium.org | 38b986c | 2013-12-07 00:22:35 +0900 | [diff] [blame] | 261 | RepeatingTimerTester* a = new RepeatingTimerTester(&did_run_a, delay); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 262 | |
| 263 | // This should run before the timer expires. |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 264 | SequencedTaskRunnerHandle::Get()->DeleteSoon(FROM_HERE, a); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 265 | |
| 266 | // Now start the timer. |
| 267 | a->Start(); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 268 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 269 | RepeatingTimerTester b(nullptr, delay); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 270 | b.Start(); |
| 271 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 272 | b.WaitAndConfirmTimerFiredRepeatedlyAfterDelay(); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 273 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 274 | // |a| should not have fired despite |b| starting after it on the same |
| 275 | // sequence and being complete by now. |
| 276 | EXPECT_FALSE(did_run_a.IsSignaled()); |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 277 | } |
| 278 | |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 279 | class DelayTimerTarget { |
| 280 | public: |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 281 | bool signaled() const { return signaled_; } |
| 282 | |
| 283 | void Signal() { |
| 284 | ASSERT_FALSE(signaled_); |
| 285 | signaled_ = true; |
| 286 | } |
| 287 | |
| 288 | private: |
hashimoto | 9c17099 | 2015-01-23 00:21:41 +0900 | [diff] [blame] | 289 | bool signaled_ = false; |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 290 | }; |
| 291 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 292 | void RunTest_DelayTimer_NoCall(MessageLoop::Type message_loop_type) { |
| 293 | MessageLoop loop(message_loop_type); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 294 | |
| 295 | // If Delay is never called, the timer shouldn't go off. |
| 296 | DelayTimerTarget target; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 297 | DelayTimer timer(FROM_HERE, TimeDelta::FromMilliseconds(1), &target, |
| 298 | &DelayTimerTarget::Signal); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 299 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 300 | OneShotTimerTester tester; |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 301 | tester.Start(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 302 | tester.WaitAndConfirmTimerFiredAfterDelay(); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 303 | |
| 304 | ASSERT_FALSE(target.signaled()); |
| 305 | } |
| 306 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 307 | void RunTest_DelayTimer_OneCall(MessageLoop::Type message_loop_type) { |
| 308 | MessageLoop loop(message_loop_type); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 309 | |
| 310 | DelayTimerTarget target; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 311 | DelayTimer timer(FROM_HERE, TimeDelta::FromMilliseconds(1), &target, |
| 312 | &DelayTimerTarget::Signal); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 313 | timer.Reset(); |
| 314 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 315 | OneShotTimerTester tester(nullptr, TimeDelta::FromMilliseconds(100)); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 316 | tester.Start(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 317 | tester.WaitAndConfirmTimerFiredAfterDelay(); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 318 | |
| 319 | ASSERT_TRUE(target.signaled()); |
| 320 | } |
| 321 | |
| 322 | struct ResetHelper { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 323 | ResetHelper(DelayTimer* timer, DelayTimerTarget* target) |
danakj | 85d43f4 | 2015-09-24 16:53:00 +0900 | [diff] [blame] | 324 | : timer_(timer), target_(target) {} |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 325 | |
| 326 | void Reset() { |
| 327 | ASSERT_FALSE(target_->signaled()); |
| 328 | timer_->Reset(); |
| 329 | } |
| 330 | |
| 331 | private: |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 332 | DelayTimer* const timer_; |
danakj | 85d43f4 | 2015-09-24 16:53:00 +0900 | [diff] [blame] | 333 | DelayTimerTarget* const target_; |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 334 | }; |
| 335 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 336 | void RunTest_DelayTimer_Reset(MessageLoop::Type message_loop_type) { |
| 337 | MessageLoop loop(message_loop_type); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 338 | |
| 339 | // If Delay is never called, the timer shouldn't go off. |
| 340 | DelayTimerTarget target; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 341 | DelayTimer timer(FROM_HERE, TimeDelta::FromMilliseconds(50), &target, |
| 342 | &DelayTimerTarget::Signal); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 343 | timer.Reset(); |
| 344 | |
| 345 | ResetHelper reset_helper(&timer, &target); |
| 346 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 347 | OneShotTimer timers[20]; |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 348 | for (size_t i = 0; i < arraysize(timers); ++i) { |
jbates@chromium.org | ad6a345 | 2011-09-03 03:23:02 +0900 | [diff] [blame] | 349 | timers[i].Start(FROM_HERE, TimeDelta::FromMilliseconds(i * 10), |
| 350 | &reset_helper, &ResetHelper::Reset); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 351 | } |
| 352 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 353 | OneShotTimerTester tester(nullptr, TimeDelta::FromMilliseconds(300)); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 354 | tester.Start(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 355 | tester.WaitAndConfirmTimerFiredAfterDelay(); |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 356 | |
| 357 | ASSERT_TRUE(target.signaled()); |
| 358 | } |
| 359 | |
agl@chromium.org | f589086 | 2009-02-27 08:17:56 +0900 | [diff] [blame] | 360 | class DelayTimerFatalTarget { |
| 361 | public: |
| 362 | void Signal() { |
| 363 | ASSERT_TRUE(false); |
| 364 | } |
| 365 | }; |
| 366 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 367 | void RunTest_DelayTimer_Deleted(MessageLoop::Type message_loop_type) { |
| 368 | MessageLoop loop(message_loop_type); |
agl@chromium.org | f589086 | 2009-02-27 08:17:56 +0900 | [diff] [blame] | 369 | |
| 370 | DelayTimerFatalTarget target; |
| 371 | |
| 372 | { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 373 | DelayTimer timer(FROM_HERE, TimeDelta::FromMilliseconds(50), &target, |
| 374 | &DelayTimerFatalTarget::Signal); |
agl@chromium.org | f589086 | 2009-02-27 08:17:56 +0900 | [diff] [blame] | 375 | timer.Reset(); |
| 376 | } |
| 377 | |
| 378 | // When the timer is deleted, the DelayTimerFatalTarget should never be |
| 379 | // called. |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 380 | PlatformThread::Sleep(TimeDelta::FromMilliseconds(100)); |
agl@chromium.org | f589086 | 2009-02-27 08:17:56 +0900 | [diff] [blame] | 381 | } |
| 382 | |
darin@google.com | d936b5b | 2008-08-26 14:53:57 +0900 | [diff] [blame] | 383 | } // namespace |
| 384 | |
| 385 | //----------------------------------------------------------------------------- |
| 386 | // Each test is run against each type of MessageLoop. That way we are sure |
| 387 | // that timers work properly in all configurations. |
| 388 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 389 | TEST(TimerTest, OneShotTimers) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 390 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 391 | RunTest_OneShotTimers(testing_message_loops[i]); |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 392 | } |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 393 | } |
| 394 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 395 | TEST(TimerTest, OneShotTimers_Cancel) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 396 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 397 | RunTest_OneShotTimers_Cancel(testing_message_loops[i]); |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 398 | } |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 399 | } |
| 400 | |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 401 | // If underline timer does not handle properly, we will crash or fail |
jeanluc@chromium.org | 5fcf787 | 2011-08-18 02:41:02 +0900 | [diff] [blame] | 402 | // in full page heap environment. |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 403 | TEST(TimerTest, OneShotSelfDeletingTimer) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 404 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
| 405 | RunTest_OneShotSelfDeletingTimer(testing_message_loops[i]); |
| 406 | } |
huanr@chromium.org | 7d5b058 | 2009-02-07 09:37:01 +0900 | [diff] [blame] | 407 | } |
| 408 | |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 409 | TEST(TimerTest, OneShotTimer_CustomTaskRunner) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 410 | // A MessageLoop is required for the timer events on the other thread to |
| 411 | // communicate back to the Timer under test. |
| 412 | MessageLoop loop; |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 413 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 414 | Thread other_thread("OneShotTimer_CustomTaskRunner"); |
| 415 | other_thread.Start(); |
| 416 | |
| 417 | WaitableEvent did_run(WaitableEvent::ResetPolicy::MANUAL, |
| 418 | WaitableEvent::InitialState::NOT_SIGNALED); |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 419 | OneShotTimerTester f(&did_run); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 420 | f.SetTaskRunner(other_thread.task_runner()); |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 421 | f.Start(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 422 | EXPECT_TRUE(f.IsRunning()); |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 423 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 424 | f.WaitAndConfirmTimerFiredAfterDelay(); |
| 425 | EXPECT_TRUE(did_run.IsSignaled()); |
| 426 | |
| 427 | // |f| should already have communicated back to this |loop| before invoking |
| 428 | // Run() and as such this thread should already be aware that |f| is no longer |
| 429 | // running. |
| 430 | EXPECT_TRUE(loop.IsIdleForTesting()); |
| 431 | EXPECT_FALSE(f.IsRunning()); |
petrcermak | 4dec79e | 2014-11-06 11:17:57 +0900 | [diff] [blame] | 432 | } |
| 433 | |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 434 | TEST(TimerTest, OneShotTimerWithTickClock) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 435 | scoped_refptr<TestMockTimeTaskRunner> task_runner( |
| 436 | new TestMockTimeTaskRunner(Time::Now(), TimeTicks::Now())); |
| 437 | std::unique_ptr<TickClock> tick_clock(task_runner->GetMockTickClock()); |
| 438 | MessageLoop message_loop; |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 439 | message_loop.SetTaskRunner(task_runner); |
| 440 | Receiver receiver; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 441 | OneShotTimer timer(tick_clock.get()); |
| 442 | timer.Start(FROM_HERE, TimeDelta::FromSeconds(1), |
| 443 | Bind(&Receiver::OnCalled, Unretained(&receiver))); |
| 444 | task_runner->FastForwardBy(TimeDelta::FromSeconds(1)); |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 445 | EXPECT_TRUE(receiver.WasCalled()); |
| 446 | } |
| 447 | |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 448 | TEST(TimerTest, RepeatingTimer) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 449 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
qsr@chromium.org | 38b986c | 2013-12-07 00:22:35 +0900 | [diff] [blame] | 450 | RunTest_RepeatingTimer(testing_message_loops[i], |
| 451 | TimeDelta::FromMilliseconds(10)); |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 452 | } |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 453 | } |
| 454 | |
| 455 | TEST(TimerTest, RepeatingTimer_Cancel) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 456 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
qsr@chromium.org | 38b986c | 2013-12-07 00:22:35 +0900 | [diff] [blame] | 457 | RunTest_RepeatingTimer_Cancel(testing_message_loops[i], |
| 458 | TimeDelta::FromMilliseconds(10)); |
| 459 | } |
| 460 | } |
| 461 | |
| 462 | TEST(TimerTest, RepeatingTimerZeroDelay) { |
| 463 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
| 464 | RunTest_RepeatingTimer(testing_message_loops[i], |
| 465 | TimeDelta::FromMilliseconds(0)); |
| 466 | } |
| 467 | } |
| 468 | |
| 469 | TEST(TimerTest, RepeatingTimerZeroDelay_Cancel) { |
| 470 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
| 471 | RunTest_RepeatingTimer_Cancel(testing_message_loops[i], |
| 472 | TimeDelta::FromMilliseconds(0)); |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 473 | } |
darin@google.com | 0b8a30c | 2008-08-29 05:50:12 +0900 | [diff] [blame] | 474 | } |
mbelshe@google.com | e0efec8 | 2008-12-03 08:16:55 +0900 | [diff] [blame] | 475 | |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 476 | TEST(TimerTest, RepeatingTimerWithTickClock) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 477 | scoped_refptr<TestMockTimeTaskRunner> task_runner( |
| 478 | new TestMockTimeTaskRunner(Time::Now(), TimeTicks::Now())); |
| 479 | std::unique_ptr<TickClock> tick_clock(task_runner->GetMockTickClock()); |
| 480 | MessageLoop message_loop; |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 481 | message_loop.SetTaskRunner(task_runner); |
| 482 | Receiver receiver; |
| 483 | const int expected_times_called = 10; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 484 | RepeatingTimer timer(tick_clock.get()); |
| 485 | timer.Start(FROM_HERE, TimeDelta::FromSeconds(1), |
| 486 | Bind(&Receiver::OnCalled, Unretained(&receiver))); |
| 487 | task_runner->FastForwardBy(TimeDelta::FromSeconds(expected_times_called)); |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 488 | timer.Stop(); |
| 489 | EXPECT_EQ(expected_times_called, receiver.TimesCalled()); |
| 490 | } |
| 491 | |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 492 | TEST(TimerTest, DelayTimer_NoCall) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 493 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
| 494 | RunTest_DelayTimer_NoCall(testing_message_loops[i]); |
| 495 | } |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 496 | } |
| 497 | |
| 498 | TEST(TimerTest, DelayTimer_OneCall) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 499 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
| 500 | RunTest_DelayTimer_OneCall(testing_message_loops[i]); |
| 501 | } |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 502 | } |
| 503 | |
phajdan.jr@chromium.org | 0cafffe | 2009-10-17 00:26:16 +0900 | [diff] [blame] | 504 | // It's flaky on the buildbot, http://crbug.com/25038. |
evan@chromium.org | 3c0bc35 | 2012-02-14 09:29:14 +0900 | [diff] [blame] | 505 | TEST(TimerTest, DISABLED_DelayTimer_Reset) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 506 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
| 507 | RunTest_DelayTimer_Reset(testing_message_loops[i]); |
| 508 | } |
agl@chromium.org | 31de02e | 2009-02-20 11:00:04 +0900 | [diff] [blame] | 509 | } |
| 510 | |
agl@chromium.org | f589086 | 2009-02-27 08:17:56 +0900 | [diff] [blame] | 511 | TEST(TimerTest, DelayTimer_Deleted) { |
leng@chromium.org | 44fe4d7 | 2012-07-17 20:22:59 +0900 | [diff] [blame] | 512 | for (int i = 0; i < kNumTestingMessageLoops; i++) { |
| 513 | RunTest_DelayTimer_Deleted(testing_message_loops[i]); |
| 514 | } |
agl@chromium.org | f589086 | 2009-02-27 08:17:56 +0900 | [diff] [blame] | 515 | } |
| 516 | |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 517 | TEST(TimerTest, DelayTimerWithTickClock) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 518 | scoped_refptr<TestMockTimeTaskRunner> task_runner( |
| 519 | new TestMockTimeTaskRunner(Time::Now(), TimeTicks::Now())); |
| 520 | std::unique_ptr<TickClock> tick_clock(task_runner->GetMockTickClock()); |
| 521 | MessageLoop message_loop; |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 522 | message_loop.SetTaskRunner(task_runner); |
| 523 | Receiver receiver; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 524 | DelayTimer timer(FROM_HERE, TimeDelta::FromSeconds(1), &receiver, |
| 525 | &Receiver::OnCalled, tick_clock.get()); |
| 526 | task_runner->FastForwardBy(TimeDelta::FromMilliseconds(999)); |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 527 | EXPECT_FALSE(receiver.WasCalled()); |
| 528 | timer.Reset(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 529 | task_runner->FastForwardBy(TimeDelta::FromMilliseconds(999)); |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 530 | EXPECT_FALSE(receiver.WasCalled()); |
| 531 | timer.Reset(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 532 | task_runner->FastForwardBy(TimeDelta::FromSeconds(1)); |
jameswest | 9f1f3a0 | 2016-11-15 14:19:54 +0900 | [diff] [blame] | 533 | EXPECT_TRUE(receiver.WasCalled()); |
| 534 | } |
| 535 | |
mbelshe@google.com | e0efec8 | 2008-12-03 08:16:55 +0900 | [diff] [blame] | 536 | TEST(TimerTest, MessageLoopShutdown) { |
| 537 | // This test is designed to verify that shutdown of the |
| 538 | // message loop does not cause crashes if there were pending |
| 539 | // timers not yet fired. It may only trigger exceptions |
jeanluc@chromium.org | 5fcf787 | 2011-08-18 02:41:02 +0900 | [diff] [blame] | 540 | // if debug heap checking is enabled. |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 541 | WaitableEvent did_run(WaitableEvent::ResetPolicy::MANUAL, |
| 542 | WaitableEvent::InitialState::NOT_SIGNALED); |
mbelshe@google.com | e0efec8 | 2008-12-03 08:16:55 +0900 | [diff] [blame] | 543 | { |
ahest | 9a63aa2 | 2016-12-13 20:34:38 +0900 | [diff] [blame] | 544 | OneShotTimerTesterBase a(&did_run); |
| 545 | OneShotTimerTesterBase b(&did_run); |
| 546 | OneShotTimerTesterBase c(&did_run); |
| 547 | OneShotTimerTesterBase d(&did_run); |
mbelshe@google.com | e0efec8 | 2008-12-03 08:16:55 +0900 | [diff] [blame] | 548 | { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 549 | MessageLoop loop; |
mbelshe@google.com | e0efec8 | 2008-12-03 08:16:55 +0900 | [diff] [blame] | 550 | a.Start(); |
| 551 | b.Start(); |
| 552 | } // MessageLoop destructs by falling out of scope. |
| 553 | } // OneShotTimers destruct. SHOULD NOT CRASH, of course. |
| 554 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 555 | EXPECT_FALSE(did_run.IsSignaled()); |
mbelshe@google.com | e0efec8 | 2008-12-03 08:16:55 +0900 | [diff] [blame] | 556 | } |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 557 | |
pkotwicz | 55d7a1e | 2017-01-18 05:45:26 +0900 | [diff] [blame] | 558 | // Ref counted class which owns a Timer. The class passes a reference to itself |
| 559 | // via the |user_task| parameter in Timer::Start(). |Timer::user_task_| might |
| 560 | // end up holding the last reference to the class. |
| 561 | class OneShotSelfOwningTimerTester |
| 562 | : public RefCounted<OneShotSelfOwningTimerTester> { |
| 563 | public: |
| 564 | OneShotSelfOwningTimerTester() = default; |
| 565 | |
| 566 | void StartTimer() { |
| 567 | // Start timer with long delay in order to test the timer getting destroyed |
| 568 | // while a timer task is still pending. |
| 569 | timer_.Start(FROM_HERE, TimeDelta::FromDays(1), |
| 570 | base::Bind(&OneShotSelfOwningTimerTester::Run, this)); |
| 571 | } |
| 572 | |
| 573 | private: |
| 574 | friend class RefCounted<OneShotSelfOwningTimerTester>; |
| 575 | ~OneShotSelfOwningTimerTester() = default; |
| 576 | |
| 577 | void Run() { |
| 578 | ADD_FAILURE() << "Timer unexpectedly fired."; |
| 579 | } |
| 580 | |
| 581 | OneShotTimer timer_; |
| 582 | |
| 583 | DISALLOW_COPY_AND_ASSIGN(OneShotSelfOwningTimerTester); |
| 584 | }; |
| 585 | |
| 586 | TEST(TimerTest, MessageLoopShutdownSelfOwningTimer) { |
| 587 | // This test verifies that shutdown of the message loop does not cause crashes |
| 588 | // if there is a pending timer not yet fired and |Timer::user_task_| owns the |
| 589 | // timer. The test may only trigger exceptions if debug heap checking is |
| 590 | // enabled. |
| 591 | |
| 592 | MessageLoop loop; |
| 593 | scoped_refptr<OneShotSelfOwningTimerTester> tester = |
| 594 | new OneShotSelfOwningTimerTester(); |
| 595 | |
| 596 | std::move(tester)->StartTimer(); |
| 597 | // |Timer::user_task_| owns sole reference to |tester|. |
| 598 | |
| 599 | // MessageLoop destructs by falling out of scope. SHOULD NOT CRASH. |
| 600 | } |
| 601 | |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 602 | void TimerTestCallback() { |
| 603 | } |
| 604 | |
| 605 | TEST(TimerTest, NonRepeatIsRunning) { |
| 606 | { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 607 | MessageLoop loop; |
| 608 | Timer timer(false, false); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 609 | EXPECT_FALSE(timer.IsRunning()); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 610 | timer.Start(FROM_HERE, TimeDelta::FromDays(1), Bind(&TimerTestCallback)); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 611 | EXPECT_TRUE(timer.IsRunning()); |
| 612 | timer.Stop(); |
| 613 | EXPECT_FALSE(timer.IsRunning()); |
| 614 | EXPECT_TRUE(timer.user_task().is_null()); |
| 615 | } |
| 616 | |
| 617 | { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 618 | Timer timer(true, false); |
| 619 | MessageLoop loop; |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 620 | EXPECT_FALSE(timer.IsRunning()); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 621 | timer.Start(FROM_HERE, TimeDelta::FromDays(1), Bind(&TimerTestCallback)); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 622 | EXPECT_TRUE(timer.IsRunning()); |
| 623 | timer.Stop(); |
| 624 | EXPECT_FALSE(timer.IsRunning()); |
| 625 | ASSERT_FALSE(timer.user_task().is_null()); |
| 626 | timer.Reset(); |
| 627 | EXPECT_TRUE(timer.IsRunning()); |
| 628 | } |
| 629 | } |
| 630 | |
| 631 | TEST(TimerTest, NonRepeatMessageLoopDeath) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 632 | Timer timer(false, false); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 633 | { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 634 | MessageLoop loop; |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 635 | EXPECT_FALSE(timer.IsRunning()); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 636 | timer.Start(FROM_HERE, TimeDelta::FromDays(1), Bind(&TimerTestCallback)); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 637 | EXPECT_TRUE(timer.IsRunning()); |
| 638 | } |
| 639 | EXPECT_FALSE(timer.IsRunning()); |
| 640 | EXPECT_TRUE(timer.user_task().is_null()); |
| 641 | } |
| 642 | |
| 643 | TEST(TimerTest, RetainRepeatIsRunning) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 644 | MessageLoop loop; |
| 645 | Timer timer(FROM_HERE, TimeDelta::FromDays(1), Bind(&TimerTestCallback), |
| 646 | true); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 647 | EXPECT_FALSE(timer.IsRunning()); |
| 648 | timer.Reset(); |
| 649 | EXPECT_TRUE(timer.IsRunning()); |
| 650 | timer.Stop(); |
| 651 | EXPECT_FALSE(timer.IsRunning()); |
| 652 | timer.Reset(); |
| 653 | EXPECT_TRUE(timer.IsRunning()); |
| 654 | } |
| 655 | |
| 656 | TEST(TimerTest, RetainNonRepeatIsRunning) { |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 657 | MessageLoop loop; |
| 658 | Timer timer(FROM_HERE, TimeDelta::FromDays(1), Bind(&TimerTestCallback), |
| 659 | false); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 660 | EXPECT_FALSE(timer.IsRunning()); |
| 661 | timer.Reset(); |
| 662 | EXPECT_TRUE(timer.IsRunning()); |
| 663 | timer.Stop(); |
| 664 | EXPECT_FALSE(timer.IsRunning()); |
| 665 | timer.Reset(); |
| 666 | EXPECT_TRUE(timer.IsRunning()); |
| 667 | } |
| 668 | |
gab | b4a7cd4 | 2017-06-02 01:23:36 +0900 | [diff] [blame^] | 669 | //----------------------------------------------------------------------------- |
| 670 | |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 671 | namespace { |
| 672 | |
| 673 | bool g_callback_happened1 = false; |
| 674 | bool g_callback_happened2 = false; |
| 675 | |
| 676 | void ClearAllCallbackHappened() { |
| 677 | g_callback_happened1 = false; |
| 678 | g_callback_happened2 = false; |
| 679 | } |
| 680 | |
| 681 | void SetCallbackHappened1() { |
| 682 | g_callback_happened1 = true; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 683 | MessageLoop::current()->QuitWhenIdle(); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 684 | } |
| 685 | |
| 686 | void SetCallbackHappened2() { |
| 687 | g_callback_happened2 = true; |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 688 | MessageLoop::current()->QuitWhenIdle(); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 689 | } |
| 690 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 691 | } // namespace |
| 692 | |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 693 | TEST(TimerTest, ContinuationStopStart) { |
| 694 | { |
| 695 | ClearAllCallbackHappened(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 696 | MessageLoop loop; |
| 697 | Timer timer(false, false); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 698 | timer.Start(FROM_HERE, TimeDelta::FromMilliseconds(10), |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 699 | Bind(&SetCallbackHappened1)); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 700 | timer.Stop(); |
| 701 | timer.Start(FROM_HERE, TimeDelta::FromMilliseconds(40), |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 702 | Bind(&SetCallbackHappened2)); |
| 703 | RunLoop().Run(); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 704 | EXPECT_FALSE(g_callback_happened1); |
| 705 | EXPECT_TRUE(g_callback_happened2); |
| 706 | } |
| 707 | } |
| 708 | |
| 709 | TEST(TimerTest, ContinuationReset) { |
| 710 | { |
| 711 | ClearAllCallbackHappened(); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 712 | MessageLoop loop; |
| 713 | Timer timer(false, false); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 714 | timer.Start(FROM_HERE, TimeDelta::FromMilliseconds(10), |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 715 | Bind(&SetCallbackHappened1)); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 716 | timer.Reset(); |
| 717 | // Since Reset happened before task ran, the user_task must not be cleared: |
| 718 | ASSERT_FALSE(timer.user_task().is_null()); |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 719 | RunLoop().Run(); |
jbates@chromium.org | 1800183 | 2012-03-27 09:18:57 +0900 | [diff] [blame] | 720 | EXPECT_TRUE(g_callback_happened1); |
| 721 | } |
| 722 | } |
| 723 | |
gab | b4a7cd4 | 2017-06-02 01:23:36 +0900 | [diff] [blame^] | 724 | namespace { |
| 725 | |
| 726 | const size_t kNumWorkerThreads = 3; |
| 727 | |
| 728 | // Fixture for tests requiring a worker pool. Includes a WaitableEvent so |
| 729 | // that cases may Wait() on one thread and Signal() (explicitly, or implicitly |
| 730 | // via helper methods) on another. |
| 731 | class TimerSequenceTest : public testing::Test { |
| 732 | public: |
| 733 | TimerSequenceTest() |
| 734 | : event_(WaitableEvent::ResetPolicy::AUTOMATIC, |
| 735 | WaitableEvent::InitialState::NOT_SIGNALED) {} |
| 736 | |
| 737 | void SetUp() override { |
| 738 | pool1_owner_.reset( |
| 739 | new SequencedWorkerPoolOwner(kNumWorkerThreads, "test1")); |
| 740 | pool2_owner_.reset( |
| 741 | new SequencedWorkerPoolOwner(kNumWorkerThreads, "test2")); |
| 742 | } |
| 743 | |
| 744 | // Block until Signal() is called on another thread. |
| 745 | void Wait() { event_.Wait(); } |
| 746 | |
| 747 | void Signal() { event_.Signal(); } |
| 748 | |
| 749 | // Helper to augment a task with a subsequent call to Signal(). |
| 750 | Closure TaskWithSignal(const Closure& task) { |
| 751 | return Bind(&TimerSequenceTest::RunTaskAndSignal, Unretained(this), task); |
| 752 | } |
| 753 | |
| 754 | // Create the timer. |
| 755 | void CreateTimer() { timer_.reset(new OneShotTimer); } |
| 756 | |
| 757 | // Schedule an event on the timer. |
| 758 | void StartTimer(TimeDelta delay, const Closure& task) { |
| 759 | timer_->Start(FROM_HERE, delay, task); |
| 760 | } |
| 761 | |
| 762 | void SetTaskRunnerForTimer(scoped_refptr<SequencedTaskRunner> task_runner) { |
| 763 | timer_->SetTaskRunner(std::move(task_runner)); |
| 764 | } |
| 765 | |
| 766 | // Tell the timer to abandon the task. |
| 767 | void AbandonTask() { |
| 768 | EXPECT_TRUE(timer_->IsRunning()); |
| 769 | // Reset() to call Timer::AbandonScheduledTask() |
| 770 | timer_->Reset(); |
| 771 | EXPECT_TRUE(timer_->IsRunning()); |
| 772 | timer_->Stop(); |
| 773 | EXPECT_FALSE(timer_->IsRunning()); |
| 774 | } |
| 775 | |
| 776 | static void VerifyAffinity(const SequencedTaskRunner* task_runner) { |
| 777 | EXPECT_TRUE(task_runner->RunsTasksOnCurrentThread()); |
| 778 | } |
| 779 | |
| 780 | // Delete the timer. |
| 781 | void DeleteTimer() { timer_.reset(); } |
| 782 | |
| 783 | protected: |
| 784 | const scoped_refptr<SequencedWorkerPool>& pool1() { |
| 785 | return pool1_owner_->pool(); |
| 786 | } |
| 787 | const scoped_refptr<SequencedWorkerPool>& pool2() { |
| 788 | return pool2_owner_->pool(); |
| 789 | } |
| 790 | |
| 791 | private: |
| 792 | void RunTaskAndSignal(const Closure& task) { |
| 793 | task.Run(); |
| 794 | Signal(); |
| 795 | } |
| 796 | |
| 797 | WaitableEvent event_; |
| 798 | |
| 799 | MessageLoop message_loop_; |
| 800 | std::unique_ptr<SequencedWorkerPoolOwner> pool1_owner_; |
| 801 | std::unique_ptr<SequencedWorkerPoolOwner> pool2_owner_; |
| 802 | |
| 803 | std::unique_ptr<OneShotTimer> timer_; |
| 804 | |
| 805 | DISALLOW_COPY_AND_ASSIGN(TimerSequenceTest); |
| 806 | }; |
| 807 | |
| 808 | } // namespace |
| 809 | |
| 810 | TEST_F(TimerSequenceTest, OneShotTimerTaskOnPoolThread) { |
| 811 | scoped_refptr<SequencedTaskRunner> task_runner = |
| 812 | pool1()->GetSequencedTaskRunner(pool1()->GetSequenceToken()); |
| 813 | |
| 814 | base::RunLoop run_loop_; |
| 815 | |
| 816 | // Timer is created on this thread. |
| 817 | CreateTimer(); |
| 818 | |
| 819 | // Task will execute on a pool thread. |
| 820 | SetTaskRunnerForTimer(task_runner); |
| 821 | StartTimer(TimeDelta::FromMilliseconds(1), |
| 822 | Bind(IgnoreResult(&SequencedTaskRunner::PostTask), |
| 823 | SequencedTaskRunnerHandle::Get(), FROM_HERE, |
| 824 | run_loop_.QuitClosure())); |
| 825 | |
| 826 | // Spin the loop so that the delayed task fires on it, which will forward it |
| 827 | // to |task_runner|. And since the Timer's task is one that posts back to this |
| 828 | // MessageLoop to quit, we finally unblock. |
| 829 | run_loop_.Run(); |
| 830 | |
| 831 | // Timer will be destroyed on this thread. |
| 832 | DeleteTimer(); |
| 833 | } |
| 834 | |
| 835 | TEST_F(TimerSequenceTest, OneShotTimerUsedOnPoolThread) { |
| 836 | scoped_refptr<SequencedTaskRunner> task_runner = |
| 837 | pool1()->GetSequencedTaskRunner(pool1()->GetSequenceToken()); |
| 838 | |
| 839 | // Timer is created on this thread. |
| 840 | CreateTimer(); |
| 841 | |
| 842 | // Task will be scheduled from a pool thread. |
| 843 | task_runner->PostTask( |
| 844 | FROM_HERE, Bind(&TimerSequenceTest::StartTimer, Unretained(this), |
| 845 | TimeDelta::FromMilliseconds(1), |
| 846 | Bind(&TimerSequenceTest::Signal, Unretained(this)))); |
| 847 | Wait(); |
| 848 | |
| 849 | // Timer must be destroyed on pool thread, too. |
| 850 | task_runner->PostTask( |
| 851 | FROM_HERE, |
| 852 | TaskWithSignal(Bind(&TimerSequenceTest::DeleteTimer, Unretained(this)))); |
| 853 | Wait(); |
| 854 | } |
| 855 | |
| 856 | TEST_F(TimerSequenceTest, OneShotTimerTwoPoolsAbandonTask) { |
| 857 | scoped_refptr<SequencedTaskRunner> task_runner1 = |
| 858 | pool1()->GetSequencedTaskRunner(pool1()->GetSequenceToken()); |
| 859 | scoped_refptr<SequencedTaskRunner> task_runner2 = |
| 860 | pool2()->GetSequencedTaskRunner(pool2()->GetSequenceToken()); |
| 861 | |
| 862 | // Create timer on pool #1. |
| 863 | task_runner1->PostTask( |
| 864 | FROM_HERE, |
| 865 | TaskWithSignal(Bind(&TimerSequenceTest::CreateTimer, Unretained(this)))); |
| 866 | Wait(); |
| 867 | |
| 868 | // And tell it to execute on a different pool (#2). |
| 869 | task_runner1->PostTask( |
| 870 | FROM_HERE, TaskWithSignal(Bind(&TimerSequenceTest::SetTaskRunnerForTimer, |
| 871 | Unretained(this), task_runner2))); |
| 872 | Wait(); |
| 873 | |
| 874 | // Task will be scheduled from pool #1. |
| 875 | task_runner1->PostTask(FROM_HERE, |
| 876 | Bind(&TimerSequenceTest::StartTimer, Unretained(this), |
| 877 | TimeDelta::FromHours(1), Bind(&DoNothing))); |
| 878 | |
| 879 | // Abandon task - must be called from scheduling pool (#1). |
| 880 | task_runner1->PostTask( |
| 881 | FROM_HERE, |
| 882 | TaskWithSignal(Bind(&TimerSequenceTest::AbandonTask, Unretained(this)))); |
| 883 | Wait(); |
| 884 | |
| 885 | // Timer must be destroyed on the pool it was scheduled from (#1). |
| 886 | task_runner1->PostTask( |
| 887 | FROM_HERE, |
| 888 | TaskWithSignal(Bind(&TimerSequenceTest::DeleteTimer, Unretained(this)))); |
| 889 | Wait(); |
| 890 | } |
| 891 | |
| 892 | TEST_F(TimerSequenceTest, OneShotTimerUsedAndTaskedOnDifferentPools) { |
| 893 | scoped_refptr<SequencedTaskRunner> task_runner1 = |
| 894 | pool1()->GetSequencedTaskRunner(pool1()->GetSequenceToken()); |
| 895 | scoped_refptr<SequencedTaskRunner> task_runner2 = |
| 896 | pool2()->GetSequencedTaskRunner(pool2()->GetSequenceToken()); |
| 897 | |
| 898 | // Create timer on pool #1. |
| 899 | task_runner1->PostTask( |
| 900 | FROM_HERE, |
| 901 | TaskWithSignal(Bind(&TimerSequenceTest::CreateTimer, Unretained(this)))); |
| 902 | Wait(); |
| 903 | |
| 904 | // And tell it to execute on a different pool (#2). |
| 905 | task_runner1->PostTask( |
| 906 | FROM_HERE, TaskWithSignal(Bind(&TimerSequenceTest::SetTaskRunnerForTimer, |
| 907 | Unretained(this), task_runner2))); |
| 908 | Wait(); |
| 909 | |
| 910 | // Task will be scheduled from pool #1. |
| 911 | task_runner1->PostTask( |
| 912 | FROM_HERE, Bind(&TimerSequenceTest::StartTimer, Unretained(this), |
| 913 | TimeDelta::FromMilliseconds(1), |
| 914 | TaskWithSignal(Bind(&TimerSequenceTest::VerifyAffinity, |
| 915 | Unretained(task_runner2.get()))))); |
| 916 | |
| 917 | Wait(); |
| 918 | |
| 919 | // Timer must be destroyed on the pool it was scheduled from (#1). |
| 920 | task_runner1->PostTask( |
| 921 | FROM_HERE, |
| 922 | TaskWithSignal(Bind(&TimerSequenceTest::DeleteTimer, Unretained(this)))); |
| 923 | Wait(); |
| 924 | } |
| 925 | |
gab | ccd5b95 | 2016-11-29 08:01:33 +0900 | [diff] [blame] | 926 | } // namespace base |