Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 16 | #undef LOG_TAG |
| 17 | #define LOG_TAG "SchedulerUnittests" |
| 18 | |
| 19 | #include <gmock/gmock.h> |
| 20 | #include <gtest/gtest.h> |
| 21 | #include <utils/Log.h> |
| 22 | |
| 23 | #include "AsyncCallRecorder.h" |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 24 | #include "Scheduler/OneShotTimer.h" |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 25 | |
| 26 | using namespace std::chrono_literals; |
| 27 | |
| 28 | namespace android { |
| 29 | namespace scheduler { |
| 30 | |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 31 | class OneShotTimerTest : public testing::Test { |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 32 | protected: |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 33 | OneShotTimerTest() = default; |
| 34 | ~OneShotTimerTest() override = default; |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 35 | |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 36 | // This timeout should be used when a 3ms callback is expected. |
| 37 | // While the tests typically request a callback after 3ms, the scheduler |
| 38 | // does not always cooperate, at it can take significantly longer (observed |
| 39 | // 30ms). |
| 40 | static constexpr auto waitTimeForExpected3msCallback = 100ms; |
| 41 | |
| 42 | // This timeout should be used when an 3ms callback is not expected. |
| 43 | // Note that there can be false-negatives if the callback happens later. |
| 44 | static constexpr auto waitTimeForUnexpected3msCallback = 6ms; |
| 45 | |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 46 | AsyncCallRecorder<void (*)()> mResetTimerCallback; |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 47 | AsyncCallRecorder<void (*)()> mExpiredTimerCallback; |
| 48 | |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 49 | std::unique_ptr<OneShotTimer> mIdleTimer; |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 50 | |
| 51 | void clearPendingCallbacks() { |
| 52 | while (mExpiredTimerCallback.waitForCall(0us).has_value()) { |
| 53 | } |
| 54 | } |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 55 | }; |
| 56 | |
| 57 | namespace { |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 58 | TEST_F(OneShotTimerTest, createAndDestroyTest) { |
| 59 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>( |
| 60 | 3ms, [] {}, [] {}); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 61 | } |
| 62 | |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 63 | TEST_F(OneShotTimerTest, startStopTest) { |
| 64 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(30ms, mResetTimerCallback.getInvocable(), |
| 65 | mExpiredTimerCallback.getInvocable()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 66 | auto startTime = std::chrono::steady_clock::now(); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 67 | mIdleTimer->start(); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 68 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 69 | // The idle timer fires after 30ms, so there should be no callback within |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 70 | // 25ms (waiting for a callback for the full 30ms would be problematic). |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 71 | bool callbackCalled = mExpiredTimerCallback.waitForCall(25ms).has_value(); |
| 72 | // Under ideal conditions there should be no event. But occasionally |
| 73 | // it is possible that the wait just prior takes more than 30ms, and |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 74 | // a callback is observed. We check the elapsed time since before the OneShotTimer |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 75 | // thread was started as a sanity check to not have a flakey test. |
| 76 | EXPECT_FALSE(callbackCalled && std::chrono::steady_clock::now() - startTime < 30ms); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 77 | |
| 78 | std::this_thread::sleep_for(std::chrono::milliseconds(25)); |
| 79 | EXPECT_FALSE(mResetTimerCallback.waitForCall().has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 80 | mIdleTimer->stop(); |
| 81 | } |
| 82 | |
Lloyd Pique | c60bf70 | 2021-04-27 12:53:40 -0700 | [diff] [blame] | 83 | // TODO(b/186417847) This test is flaky. Reenable once fixed. |
| 84 | TEST_F(OneShotTimerTest, DISABLED_resetTest) { |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 85 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(20ms, mResetTimerCallback.getInvocable(), |
| 86 | mExpiredTimerCallback.getInvocable()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 87 | mIdleTimer->start(); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 88 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 89 | // Observe any event that happens in about 25ms. We don't care if one was |
| 90 | // observed or not. |
| 91 | mExpiredTimerCallback.waitForCall(25ms).has_value(); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 92 | mIdleTimer->reset(); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 93 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 94 | // There may have been a race with the reset. Clear any callbacks we |
| 95 | // received right afterwards. |
| 96 | clearPendingCallbacks(); |
| 97 | // A single callback should be generated after 30ms |
| 98 | EXPECT_TRUE( |
| 99 | mExpiredTimerCallback.waitForCall(waitTimeForExpected3msCallback + 30ms).has_value()); |
| 100 | // After one event, it should be idle, and not generate another. |
| 101 | EXPECT_FALSE( |
| 102 | mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback * 10).has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 103 | mIdleTimer->stop(); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 104 | // Final quick check that no more callback were observed. |
| 105 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(0ms).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 106 | EXPECT_FALSE(mResetTimerCallback.waitForCall(0ms).has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 107 | } |
| 108 | |
Lloyd Pique | c60bf70 | 2021-04-27 12:53:40 -0700 | [diff] [blame] | 109 | // TODO(b/186417847) This test is flaky. Reenable once fixed. |
| 110 | TEST_F(OneShotTimerTest, DISABLED_resetBackToBackTest) { |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 111 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(20ms, mResetTimerCallback.getInvocable(), |
| 112 | mExpiredTimerCallback.getInvocable()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 113 | mIdleTimer->start(); |
| 114 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
| 115 | |
| 116 | mIdleTimer->reset(); |
Alec Mouri | dc28b37 | 2019-04-18 21:17:13 -0700 | [diff] [blame] | 117 | EXPECT_FALSE(mResetTimerCallback.waitForCall(1ms).has_value()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 118 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 119 | |
| 120 | mIdleTimer->reset(); |
Alec Mouri | dc28b37 | 2019-04-18 21:17:13 -0700 | [diff] [blame] | 121 | EXPECT_FALSE(mResetTimerCallback.waitForCall(1ms).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 122 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
| 123 | |
| 124 | mIdleTimer->reset(); |
Alec Mouri | dc28b37 | 2019-04-18 21:17:13 -0700 | [diff] [blame] | 125 | EXPECT_FALSE(mResetTimerCallback.waitForCall(1ms).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 126 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
| 127 | |
| 128 | mIdleTimer->reset(); |
Alec Mouri | dc28b37 | 2019-04-18 21:17:13 -0700 | [diff] [blame] | 129 | EXPECT_FALSE(mResetTimerCallback.waitForCall(1ms).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 130 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
| 131 | |
| 132 | // A single callback should be generated after 30ms |
| 133 | EXPECT_TRUE( |
| 134 | mExpiredTimerCallback.waitForCall(waitTimeForExpected3msCallback + 30ms).has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 135 | mIdleTimer->stop(); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 136 | // Final quick check that no more callback were observed. |
| 137 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(0ms).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 138 | EXPECT_FALSE(mResetTimerCallback.waitForCall(0ms).has_value()); |
| 139 | } |
| 140 | |
Lloyd Pique | c60bf70 | 2021-04-27 12:53:40 -0700 | [diff] [blame] | 141 | // TODO(b/186417847) This test is flaky. Reenable once fixed. |
| 142 | TEST_F(OneShotTimerTest, DISABLED_startNotCalledTest) { |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 143 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(3ms, mResetTimerCallback.getInvocable(), |
| 144 | mExpiredTimerCallback.getInvocable()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 145 | // The start hasn't happened, so the callback does not happen. |
| 146 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
Ady Abraham | 51988ef | 2019-02-25 17:25:57 -0800 | [diff] [blame] | 147 | EXPECT_FALSE(mResetTimerCallback.waitForCall().has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 148 | mIdleTimer->stop(); |
| 149 | // Final quick check that no more callback were observed. |
| 150 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(0ms).has_value()); |
| 151 | EXPECT_FALSE(mResetTimerCallback.waitForCall(0ms).has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 152 | } |
| 153 | |
Lloyd Pique | c60bf70 | 2021-04-27 12:53:40 -0700 | [diff] [blame] | 154 | // TODO(b/186417847) This test is flaky. Reenable once fixed. |
| 155 | TEST_F(OneShotTimerTest, DISABLED_idleTimerIdlesTest) { |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 156 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(3ms, mResetTimerCallback.getInvocable(), |
| 157 | mExpiredTimerCallback.getInvocable()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 158 | mIdleTimer->start(); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 159 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
| 160 | |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 161 | // A callback should be generated after 3ms |
| 162 | EXPECT_TRUE(mExpiredTimerCallback.waitForCall(waitTimeForExpected3msCallback).has_value()); |
| 163 | // After one event, it should be idle, and not generate another. |
| 164 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
| 165 | // Once reset, it should generate another |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 166 | mIdleTimer->reset(); |
Ady Abraham | 51988ef | 2019-02-25 17:25:57 -0800 | [diff] [blame] | 167 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 168 | EXPECT_TRUE(mExpiredTimerCallback.waitForCall(waitTimeForExpected3msCallback).has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 169 | mIdleTimer->stop(); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 170 | // Final quick check that no more callback were observed. |
| 171 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(0ms).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 172 | EXPECT_FALSE(mResetTimerCallback.waitForCall(0ms).has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 173 | } |
| 174 | |
Lloyd Pique | c60bf70 | 2021-04-27 12:53:40 -0700 | [diff] [blame] | 175 | // TODO(b/186417847) This test is flaky. Reenable once fixed. |
| 176 | TEST_F(OneShotTimerTest, DISABLED_timeoutCallbackExecutionTest) { |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 177 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(3ms, mResetTimerCallback.getInvocable(), |
| 178 | mExpiredTimerCallback.getInvocable()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 179 | mIdleTimer->start(); |
Ady Abraham | 51988ef | 2019-02-25 17:25:57 -0800 | [diff] [blame] | 180 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 181 | EXPECT_TRUE(mExpiredTimerCallback.waitForCall(waitTimeForExpected3msCallback).has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 182 | mIdleTimer->stop(); |
| 183 | } |
| 184 | |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 185 | TEST_F(OneShotTimerTest, noCallbacksAfterStopAndResetTest) { |
| 186 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(3ms, mResetTimerCallback.getInvocable(), |
| 187 | mExpiredTimerCallback.getInvocable()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 188 | mIdleTimer->start(); |
Ady Abraham | 51988ef | 2019-02-25 17:25:57 -0800 | [diff] [blame] | 189 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 190 | EXPECT_TRUE(mExpiredTimerCallback.waitForCall(waitTimeForExpected3msCallback).has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 191 | |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 192 | mIdleTimer->stop(); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 193 | clearPendingCallbacks(); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 194 | mIdleTimer->reset(); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 195 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
Ady Abraham | 51988ef | 2019-02-25 17:25:57 -0800 | [diff] [blame] | 196 | EXPECT_FALSE(mResetTimerCallback.waitForCall().has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 197 | } |
| 198 | |
Ana Krulec | f2c006d | 2019-06-21 15:37:07 -0700 | [diff] [blame] | 199 | TEST_F(OneShotTimerTest, noCallbacksAfterStopTest) { |
| 200 | mIdleTimer = std::make_unique<scheduler::OneShotTimer>(3ms, mResetTimerCallback.getInvocable(), |
| 201 | mExpiredTimerCallback.getInvocable()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 202 | mIdleTimer->start(); |
Ady Abraham | 51988ef | 2019-02-25 17:25:57 -0800 | [diff] [blame] | 203 | EXPECT_TRUE(mResetTimerCallback.waitForCall().has_value()); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 204 | |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 205 | mIdleTimer->stop(); |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 206 | clearPendingCallbacks(); |
| 207 | mIdleTimer->reset(); |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 208 | |
Lloyd Pique | 1f9f1a4 | 2019-01-31 13:04:00 -0800 | [diff] [blame] | 209 | // No more idle events should be observed |
| 210 | EXPECT_FALSE(mExpiredTimerCallback.waitForCall(waitTimeForUnexpected3msCallback).has_value()); |
Ady Abraham | 51988ef | 2019-02-25 17:25:57 -0800 | [diff] [blame] | 211 | EXPECT_FALSE(mResetTimerCallback.waitForCall().has_value()); |
Ana Krulec | fb77282 | 2018-11-30 10:44:07 +0100 | [diff] [blame] | 212 | } |
| 213 | |
| 214 | } // namespace |
| 215 | } // namespace scheduler |
Ady Abraham | a1a49af | 2019-02-07 14:36:55 -0800 | [diff] [blame] | 216 | } // namespace android |