2 * Copyright 2016 Facebook, Inc.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <folly/futures/Timekeeper.h>
18 #include <folly/portability/GTest.h>
19 #include <folly/portability/Unistd.h>
21 using namespace folly;
22 using std::chrono::milliseconds;
24 std::chrono::milliseconds const zero_ms(0);
25 std::chrono::milliseconds const one_ms(1);
26 std::chrono::milliseconds const awhile(10);
27 std::chrono::seconds const too_long(10);
29 std::chrono::steady_clock::time_point now() {
30 return std::chrono::steady_clock::now();
33 struct TimekeeperFixture : public testing::Test {
35 timeLord_(folly::detail::getTimekeeperSingleton())
38 std::shared_ptr<Timekeeper> timeLord_;
41 TEST_F(TimekeeperFixture, after) {
43 auto f = timeLord_->after(awhile);
44 EXPECT_FALSE(f.isReady());
48 EXPECT_GE(t2 - t1, awhile);
51 TEST(Timekeeper, futureGet) {
53 auto t = std::thread([&]{ p.setValue(42); });
54 EXPECT_EQ(42, p.getFuture().get());
58 TEST(Timekeeper, futureGetBeforeTimeout) {
60 auto t = std::thread([&]{ p.setValue(42); });
61 // Technically this is a race and if the test server is REALLY overloaded
62 // and it takes more than a second to do that thread it could be flaky. But
63 // I want a low timeout (in human terms) so if this regresses and someone
64 // runs it by hand they're not sitting there forever wondering why it's
65 // blocked, and get a useful error message instead. If it does get flaky,
66 // empirically increase the timeout to the point where it's very improbable.
67 EXPECT_EQ(42, p.getFuture().get(std::chrono::seconds(2)));
71 TEST(Timekeeper, futureGetTimeout) {
73 EXPECT_THROW(p.getFuture().get(one_ms), folly::TimedOut);
76 TEST(Timekeeper, futureSleep) {
78 futures::sleep(one_ms).get();
79 EXPECT_GE(now() - t1, one_ms);
82 TEST(Timekeeper, futureDelayed) {
84 auto dur = makeFuture()
86 .then([=]{ return now() - t1; })
89 EXPECT_GE(dur, one_ms);
92 TEST(Timekeeper, futureWithinThrows) {
94 auto f = p.getFuture()
96 .onError([](TimedOut&) { return -1; });
98 EXPECT_EQ(-1, f.get());
101 TEST(Timekeeper, futureWithinAlreadyComplete) {
102 auto f = makeFuture(42)
104 .onError([&](TimedOut&){ return -1; });
106 EXPECT_EQ(42, f.get());
109 TEST(Timekeeper, futureWithinFinishesInTime) {
111 auto f = p.getFuture()
112 .within(std::chrono::minutes(1))
113 .onError([&](TimedOut&){ return -1; });
116 EXPECT_EQ(42, f.get());
119 TEST(Timekeeper, futureWithinVoidSpecialization) {
120 makeFuture().within(one_ms);
123 TEST(Timekeeper, futureWithinException) {
125 auto f = p.getFuture().within(awhile, std::runtime_error("expected"));
126 EXPECT_THROW(f.get(), std::runtime_error);
129 TEST(Timekeeper, onTimeout) {
131 makeFuture(42).delayed(10 * one_ms)
132 .onTimeout(zero_ms, [&]{ flag = true; return -1; })
137 TEST(Timekeeper, onTimeoutReturnsFuture) {
139 makeFuture(42).delayed(10 * one_ms)
140 .onTimeout(zero_ms, [&]{ flag = true; return makeFuture(-1); })
145 TEST(Timekeeper, onTimeoutVoid) {
146 makeFuture().delayed(one_ms)
147 .onTimeout(zero_ms, [&]{
149 makeFuture().delayed(one_ms)
150 .onTimeout(zero_ms, [&]{
151 return makeFuture<Unit>(std::runtime_error("expected"));
153 // just testing compilation here
156 TEST(Timekeeper, interruptDoesntCrash) {
157 auto f = futures::sleep(too_long);
161 TEST(Timekeeper, chainedInterruptTest) {
163 auto f = futures::sleep(milliseconds(100)).then([&](){
171 TEST(Timekeeper, executor) {
172 class ExecutorTester : public Executor {
174 void add(Func f) override {
178 std::atomic<int> count{0};
181 auto f = makeFuture();
182 ExecutorTester tester;
183 f.via(&tester).within(one_ms).then([&](){}).wait();
184 EXPECT_EQ(2, tester.count);
189 TEST(Timekeeper, onTimeoutPropagates) {
192 makeFuture(42).delayed(one_ms)
193 .onTimeout(zero_ms, [&]{ flag = true; })
200 TEST_F(TimekeeperFixture, atBeforeNow) {
201 auto f = timeLord_->at(now() - too_long);
202 EXPECT_TRUE(f.isReady());
203 EXPECT_FALSE(f.hasException());
206 TEST_F(TimekeeperFixture, howToCastDuration) {
207 // I'm not sure whether this rounds up or down but it's irrelevant for the
208 // purpose of this example.
209 auto f = timeLord_->after(std::chrono::duration_cast<Duration>(
210 std::chrono::nanoseconds(1)));