Future::within
[folly.git] / folly / wangle / futures / test / TimekeeperTest.cpp
1 /*
2  * Copyright 2014 Facebook, Inc.
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  */
16 #include <gtest/gtest.h>
17
18 #include <folly/wangle/futures/Timekeeper.h>
19 #include <unistd.h>
20
21 using namespace folly::wangle;
22 using namespace std::chrono;
23 using folly::wangle::Timekeeper;
24 using Duration = folly::wangle::Duration;
25
26 std::chrono::milliseconds const one_ms(1);
27 std::chrono::milliseconds const awhile(10);
28
29 std::chrono::steady_clock::time_point now() {
30   return std::chrono::steady_clock::now();
31 }
32
33 struct TimekeeperFixture : public testing::Test {
34   TimekeeperFixture() :
35     timeLord_(folly::wangle::detail::getTimekeeperSingleton())
36   {}
37
38   Timekeeper* timeLord_;
39 };
40
41 TEST_F(TimekeeperFixture, after) {
42   Duration waited(0);
43
44   auto t1 = now();
45   auto f = timeLord_->after(awhile);
46   EXPECT_FALSE(f.isReady());
47   f.get();
48   auto t2 = now();
49
50   EXPECT_GE(t2 - t1, awhile);
51 }
52
53 TEST(Timekeeper, futureGet) {
54   Promise<int> p;
55   std::thread([&]{ p.setValue(42); }).detach();
56   EXPECT_EQ(42, p.getFuture().get());
57 }
58
59 TEST(Timekeeper, futureGetBeforeTimeout) {
60   Promise<int> p;
61   std::thread([&]{ p.setValue(42); }).detach();
62   // Technically this is a race and if the test server is REALLY overloaded
63   // and it takes more than a second to do that thread it could be flaky. But
64   // I want a low timeout (in human terms) so if this regresses and someone
65   // runs it by hand they're not sitting there forever wondering why it's
66   // blocked, and get a useful error message instead. If it does get flaky,
67   // empirically increase the timeout to the point where it's very improbable.
68   EXPECT_EQ(42, p.getFuture().get(seconds(2)));
69 }
70
71 TEST(Timekeeper, futureGetTimeout) {
72   Promise<int> p;
73   EXPECT_THROW(p.getFuture().get(Duration(1)), folly::wangle::TimedOut);
74 }
75
76 TEST(Timekeeper, futureSleep) {
77   auto t1 = now();
78   futures::sleep(one_ms).get();
79   EXPECT_GE(now() - t1, one_ms);
80 }
81
82 TEST(Timekeeper, futureDelayed) {
83   auto t1 = now();
84   auto dur = makeFuture()
85     .delayed(one_ms)
86     .then([=]{ return now() - t1; })
87     .get();
88
89   EXPECT_GE(dur, one_ms);
90 }
91
92 TEST(Timekeeper, futureWithinThrows) {
93   Promise<int> p;
94   auto f = p.getFuture()
95     .within(one_ms)
96     .onError([](TimedOut&) { return -1; });
97
98   EXPECT_EQ(-1, f.get());
99 }
100
101 TEST(Timekeeper, futureWithinAlreadyComplete) {
102   auto f = makeFuture(42)
103     .within(one_ms)
104     .onError([&](TimedOut&){ return -1; });
105
106   EXPECT_EQ(42, f.get());
107 }
108
109 TEST(Timekeeper, futureWithinFinishesInTime) {
110   Promise<int> p;
111   auto f = p.getFuture()
112     .within(std::chrono::minutes(1))
113     .onError([&](TimedOut&){ return -1; });
114   p.setValue(42);
115
116   EXPECT_EQ(42, f.get());
117 }
118
119 TEST(Timekeeper, futureWithinVoidSpecialization) {
120   makeFuture().within(one_ms);
121 }
122
123 TEST(Timekeeper, futureWithinException) {
124   Promise<void> p;
125   auto f = p.getFuture().within(awhile, std::runtime_error("expected"));
126   EXPECT_THROW(f.get(), std::runtime_error);
127 }