2 * Copyright 2014 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.
18 #include <folly/small_vector.h>
19 #include <gtest/gtest.h>
22 #include <type_traits>
24 #include "folly/wangle/Executor.h"
25 #include "folly/wangle/Future.h"
27 using namespace folly::wangle;
30 using std::unique_ptr;
33 #define EXPECT_TYPE(x, T) \
34 EXPECT_TRUE((std::is_same<decltype(x), T>::value))
36 typedef WangleException eggs_t;
37 static eggs_t eggs("eggs");
54 Try<A> t_a(std::move(a));
58 EXPECT_EQ(5, t_a.value().x());
61 TEST(Future, special) {
62 EXPECT_FALSE(std::is_copy_constructible<Future<int>>::value);
63 EXPECT_FALSE(std::is_copy_assignable<Future<int>>::value);
64 EXPECT_TRUE(std::is_move_constructible<Future<int>>::value);
65 EXPECT_TRUE(std::is_move_assignable<Future<int>>::value);
71 makeFuture<int>(42).then([&](Try<int>&& t) {
73 EXPECT_EQ(42, t.value());
75 EXPECT_TRUE(flag); flag = false;
78 .then([](Try<int>&& t) { return t.value(); })
79 .then([&](Try<int>&& t) { flag = true; EXPECT_EQ(42, t.value()); });
80 EXPECT_TRUE(flag); flag = false;
82 makeFuture().then([&](Try<void>&& t) { flag = true; t.value(); });
83 EXPECT_TRUE(flag); flag = false;
86 auto f = p.getFuture().then([&](Try<void>&& t) { flag = true; });
88 EXPECT_FALSE(f.isReady());
91 EXPECT_TRUE(f.isReady());
95 auto f = makeFuture(unique_ptr<int>(new int(42)));
96 auto up = std::move(f.value());
99 EXPECT_THROW(makeFuture<int>(eggs).value(), eggs_t);
102 TEST(Future, isReady) {
104 auto f = p.getFuture();
105 EXPECT_FALSE(f.isReady());
107 EXPECT_TRUE(f.isReady());
110 TEST(Future, hasException) {
111 EXPECT_TRUE(makeFuture<int>(eggs).getTry().hasException());
112 EXPECT_FALSE(makeFuture(42).getTry().hasException());
115 TEST(Future, hasValue) {
116 EXPECT_TRUE(makeFuture(42).getTry().hasValue());
117 EXPECT_FALSE(makeFuture<int>(eggs).getTry().hasValue());
120 TEST(Future, makeFuture) {
121 EXPECT_TYPE(makeFuture(42), Future<int>);
122 EXPECT_EQ(42, makeFuture(42).value());
124 EXPECT_TYPE(makeFuture<float>(42), Future<float>);
125 EXPECT_EQ(42, makeFuture<float>(42).value());
127 auto fun = [] { return 42; };
128 EXPECT_TYPE(makeFutureTry(fun), Future<int>);
129 EXPECT_EQ(42, makeFutureTry(fun).value());
131 auto failfun = []() -> int { throw eggs; };
132 EXPECT_TYPE(makeFutureTry(failfun), Future<int>);
133 EXPECT_THROW(makeFutureTry(failfun).value(), eggs_t);
135 EXPECT_TYPE(makeFuture(), Future<void>);
140 TEST(Promise, special) {
141 EXPECT_FALSE(std::is_copy_constructible<Promise<int>>::value);
142 EXPECT_FALSE(std::is_copy_assignable<Promise<int>>::value);
143 EXPECT_TRUE(std::is_move_constructible<Promise<int>>::value);
144 EXPECT_TRUE(std::is_move_assignable<Promise<int>>::value);
147 TEST(Promise, getFuture) {
149 Future<int> f = p.getFuture();
150 EXPECT_FALSE(f.isReady());
153 TEST(Promise, setValue) {
155 auto ffund = fund.getFuture();
157 EXPECT_EQ(42, ffund.value());
165 auto fpod = pod.getFuture();
166 Foo f = {"the answer", 42};
168 Foo f2 = fpod.value();
169 EXPECT_EQ(f.name, f2.name);
170 EXPECT_EQ(f.value, f2.value);
172 pod = Promise<Foo>();
173 fpod = pod.getFuture();
174 pod.setValue(std::move(f2));
175 Foo f3 = fpod.value();
176 EXPECT_EQ(f.name, f3.name);
177 EXPECT_EQ(f.value, f3.value);
179 Promise<unique_ptr<int>> mov;
180 auto fmov = mov.getFuture();
181 mov.setValue(unique_ptr<int>(new int(42)));
182 unique_ptr<int> ptr = std::move(fmov.value());
186 auto fv = v.getFuture();
188 EXPECT_TRUE(fv.isReady());
191 TEST(Promise, setException) {
194 auto f = p.getFuture();
195 p.setException(eggs);
196 EXPECT_THROW(f.value(), eggs_t);
200 auto f = p.getFuture();
204 p.setException(std::current_exception());
206 EXPECT_THROW(f.value(), eggs_t);
210 TEST(Promise, fulfil) {
213 auto f = p.getFuture();
214 p.fulfil([] { return 42; });
215 EXPECT_EQ(42, f.value());
219 auto f = p.getFuture();
220 p.fulfil([]() -> int { throw eggs; });
221 EXPECT_THROW(f.value(), eggs_t);
225 TEST(Future, finish) {
226 auto x = std::make_shared<int>(0);
228 auto f = p.getFuture().then([x](Try<int>&& t) { *x = t.value(); });
230 // The continuation hasn't executed
233 // The continuation has a reference to x
234 EXPECT_EQ(2, x.use_count());
238 // the continuation has executed
241 // the continuation has been destructed
242 // and has released its reference to x
243 EXPECT_EQ(1, x.use_count());
246 TEST(Future, unwrap) {
250 auto fa = a.getFuture();
251 auto fb = b.getFuture();
256 // do a, then do b, and get the result of a + b.
257 Future<int> f = fa.then([&](Try<int>&& ta) {
258 auto va = ta.value();
260 return fb.then([va, &flag2](Try<int>&& tb) {
262 return va + tb.value();
268 EXPECT_FALSE(f.isReady());
273 EXPECT_FALSE(f.isReady());
278 EXPECT_EQ(7, f.value());
281 TEST(Future, whenAll) {
282 // returns a vector variant
284 vector<Promise<int>> promises(10);
285 vector<Future<int>> futures;
287 for (auto& p : promises)
288 futures.push_back(p.getFuture());
290 auto allf = whenAll(futures.begin(), futures.end());
292 random_shuffle(promises.begin(), promises.end());
293 for (auto& p : promises) {
294 EXPECT_FALSE(allf.isReady());
298 EXPECT_TRUE(allf.isReady());
299 auto& results = allf.value();
300 for (auto& t : results) {
301 EXPECT_EQ(42, t.value());
305 // check error semantics
307 vector<Promise<int>> promises(4);
308 vector<Future<int>> futures;
310 for (auto& p : promises)
311 futures.push_back(p.getFuture());
313 auto allf = whenAll(futures.begin(), futures.end());
316 promises[0].setValue(42);
317 promises[1].setException(eggs);
319 EXPECT_FALSE(allf.isReady());
321 promises[2].setValue(42);
323 EXPECT_FALSE(allf.isReady());
325 promises[3].setException(eggs);
327 EXPECT_TRUE(allf.isReady());
328 EXPECT_FALSE(allf.getTry().hasException());
330 auto& results = allf.value();
331 EXPECT_EQ(42, results[0].value());
332 EXPECT_TRUE(results[1].hasException());
333 EXPECT_EQ(42, results[2].value());
334 EXPECT_TRUE(results[3].hasException());
337 // check that futures are ready in then()
339 vector<Promise<void>> promises(10);
340 vector<Future<void>> futures;
342 for (auto& p : promises)
343 futures.push_back(p.getFuture());
345 auto allf = whenAll(futures.begin(), futures.end())
346 .then([](Try<vector<Try<void>>>&& ts) {
347 for (auto& f : ts.value())
351 random_shuffle(promises.begin(), promises.end());
352 for (auto& p : promises)
354 EXPECT_TRUE(allf.isReady());
359 TEST(Future, whenAny) {
361 vector<Promise<int>> promises(10);
362 vector<Future<int>> futures;
364 for (auto& p : promises)
365 futures.push_back(p.getFuture());
367 for (auto& f : futures) {
368 EXPECT_FALSE(f.isReady());
371 auto anyf = whenAny(futures.begin(), futures.end());
373 /* futures were moved in, so these are invalid now */
374 EXPECT_FALSE(anyf.isReady());
376 promises[7].setValue(42);
377 EXPECT_TRUE(anyf.isReady());
378 auto& idx_fut = anyf.value();
380 auto i = idx_fut.first;
383 auto& f = idx_fut.second;
384 EXPECT_EQ(42, f.value());
389 vector<Promise<void>> promises(10);
390 vector<Future<void>> futures;
392 for (auto& p : promises)
393 futures.push_back(p.getFuture());
395 for (auto& f : futures) {
396 EXPECT_FALSE(f.isReady());
399 auto anyf = whenAny(futures.begin(), futures.end());
401 EXPECT_FALSE(anyf.isReady());
403 promises[3].setException(eggs);
404 EXPECT_TRUE(anyf.isReady());
405 EXPECT_TRUE(anyf.value().second.hasException());
410 vector<Promise<int>> promises(10);
411 vector<Future<int>> futures;
413 for (auto& p : promises)
414 futures.push_back(p.getFuture());
416 auto anyf = whenAny(futures.begin(), futures.end())
417 .then([](Try<pair<size_t, Try<int>>>&& f) {
418 EXPECT_EQ(42, f.value().second.value());
421 promises[3].setValue(42);
422 EXPECT_TRUE(anyf.isReady());
427 TEST(when, already_completed) {
429 vector<Future<void>> fs;
430 for (int i = 0; i < 10; i++)
431 fs.push_back(makeFuture());
433 whenAll(fs.begin(), fs.end())
434 .then([&](Try<vector<Try<void>>>&& t) {
435 EXPECT_EQ(fs.size(), t.value().size());
439 vector<Future<int>> fs;
440 for (int i = 0; i < 10; i++)
441 fs.push_back(makeFuture(i));
443 whenAny(fs.begin(), fs.end())
444 .then([&](Try<pair<size_t, Try<int>>>&& t) {
446 EXPECT_EQ(p.first, p.second.value());
452 vector<Promise<void>> promises(10);
453 vector<Future<void>> futures;
455 for (auto& p : promises)
456 futures.push_back(p.getFuture());
460 whenN(futures.begin(), futures.end(), n)
461 .then([&](Try<vector<pair<size_t, Try<void>>>>&& t) {
464 EXPECT_EQ(n, v.size());
466 EXPECT_TRUE(tt.second.hasValue());
469 promises[0].setValue();
471 promises[1].setValue();
473 promises[2].setValue();
477 /* Ensure that we can compile when_{all,any} with folly::small_vector */
478 TEST(when, small_vector) {
479 using folly::small_vector;
481 small_vector<Future<void>> futures;
483 for (int i = 0; i < 10; i++)
484 futures.push_back(makeFuture());
486 auto anyf = whenAny(futures.begin(), futures.end());
490 small_vector<Future<void>> futures;
492 for (int i = 0; i < 10; i++)
493 futures.push_back(makeFuture());
495 auto allf = whenAll(futures.begin(), futures.end());
499 TEST(Future, whenAllVariadic) {
502 Future<bool> fb = pb.getFuture();
503 Future<int> fi = pi.getFuture();
505 whenAll(std::move(fb), std::move(fi))
506 .then([&](Try<std::tuple<Try<bool>, Try<int>>>&& t) {
508 EXPECT_TRUE(t.hasValue());
509 EXPECT_TRUE(std::get<0>(t.value()).hasValue());
510 EXPECT_EQ(std::get<0>(t.value()).value(), true);
511 EXPECT_TRUE(std::get<1>(t.value()).hasValue());
512 EXPECT_EQ(std::get<1>(t.value()).value(), 42);
520 TEST(Future, whenAllVariadicReferences) {
523 Future<bool> fb = pb.getFuture();
524 Future<int> fi = pi.getFuture();
527 .then([&](Try<std::tuple<Try<bool>, Try<int>>>&& t) {
529 EXPECT_TRUE(t.hasValue());
530 EXPECT_TRUE(std::get<0>(t.value()).hasValue());
531 EXPECT_EQ(std::get<0>(t.value()).value(), true);
532 EXPECT_TRUE(std::get<1>(t.value()).hasValue());
533 EXPECT_EQ(std::get<1>(t.value()).value(), 42);
541 TEST(Future, whenAll_none) {
542 vector<Future<int>> fs;
543 auto f = whenAll(fs.begin(), fs.end());
544 EXPECT_TRUE(f.isReady());
547 TEST(Future, throwCaughtInImmediateThen) {
548 // Neither of these should throw "Promise already satisfied"
550 [=](Try<void>&&) -> int { throw std::exception(); });
552 [=](Try<void>&&) -> Future<int> { throw std::exception(); });
555 TEST(Future, throwIfFailed) {
556 makeFuture<void>(eggs)
557 .then([=](Try<void>&& t) {
558 EXPECT_THROW(t.throwIfFailed(), eggs_t);
561 .then([=](Try<void>&& t) {
562 EXPECT_NO_THROW(t.throwIfFailed());
565 makeFuture<int>(eggs)
566 .then([=](Try<int>&& t) {
567 EXPECT_THROW(t.throwIfFailed(), eggs_t);
570 .then([=](Try<int>&& t) {
571 EXPECT_NO_THROW(t.throwIfFailed());