folly/test/OptionalTest.cpp

   1 /*
   2  * Copyright 2015 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
  17 #include <folly/Optional.h>
  18
  19 #include <memory>
  20 #include <vector>
  21 #include <algorithm>
  22 #include <iomanip>
  23 #include <string>
  24
  25 #include <glog/logging.h>
  26 #include <gtest/gtest.h>
  27 #include <boost/optional.hpp>
  28
  29 using std::unique_ptr;
  30 using std::shared_ptr;
  31
  32 namespace folly {
  33
  34 template<class V>
  35 std::ostream& operator<<(std::ostream& os, const Optional<V>& v) {
  36   if (v) {
  37     os << "Optional(" << v.value() << ')';
  38   } else {
  39     os << "None";
  40   }
  41   return os;
  42 }
  43
  44 struct NoDefault {
  45   NoDefault(int, int) {}
  46   char a, b, c;
  47 };
  48
  49 static_assert(sizeof(Optional<char>) == 2, "");
  50 static_assert(sizeof(Optional<int>) == 8, "");
  51 static_assert(sizeof(Optional<NoDefault>) == 4, "");
  52 static_assert(sizeof(Optional<char>) == sizeof(boost::optional<char>), "");
  53 static_assert(sizeof(Optional<short>) == sizeof(boost::optional<short>), "");
  54 static_assert(sizeof(Optional<int>) == sizeof(boost::optional<int>), "");
  55 static_assert(sizeof(Optional<double>) == sizeof(boost::optional<double>), "");
  56
  57 TEST(Optional, NoDefault) {
  58   Optional<NoDefault> x;
  59   EXPECT_FALSE(x);
  60   x.emplace(4, 5);
  61   EXPECT_TRUE(bool(x));
  62   x.clear();
  63   EXPECT_FALSE(x);
  64 }
  65
  66 TEST(Optional, String) {
  67   Optional<std::string> maybeString;
  68   EXPECT_FALSE(maybeString);
  69   maybeString = "hello";
  70   EXPECT_TRUE(bool(maybeString));
  71 }
  72
  73 TEST(Optional, Const) {
  74   { // default construct
  75     Optional<const int> opt;
  76     EXPECT_FALSE(bool(opt));
  77     opt.emplace(4);
  78     EXPECT_EQ(*opt, 4);
  79     opt.emplace(5);
  80     EXPECT_EQ(*opt, 5);
  81     opt.clear();
  82     EXPECT_FALSE(bool(opt));
  83   }
  84   { // copy-constructed
  85     const int x = 6;
  86     Optional<const int> opt(x);
  87     EXPECT_EQ(*opt, 6);
  88   }
  89   { // move-constructed
  90     const int x = 7;
  91     Optional<const int> opt(std::move(x));
  92     EXPECT_EQ(*opt, 7);
  93   }
  94   // no assignment allowed
  95 }
  96
  97 TEST(Optional, Simple) {
  98   Optional<int> opt;
  99   EXPECT_FALSE(bool(opt));
 100   EXPECT_EQ(42, opt.value_or(42));
 101   opt = 4;
 102   EXPECT_TRUE(bool(opt));
 103   EXPECT_EQ(4, *opt);
 104   EXPECT_EQ(4, opt.value_or(42));
 105   opt = 5;
 106   EXPECT_EQ(5, *opt);
 107   opt.clear();
 108   EXPECT_FALSE(bool(opt));
 109 }
 110
 111 class MoveTester {
 112 public:
 113   /* implicit */ MoveTester(const char* s) : s_(s) {}
 114   MoveTester(const MoveTester&) = default;
 115   MoveTester(MoveTester&& other) noexcept {
 116     s_ = std::move(other.s_);
 117     other.s_ = "";
 118   }
 119   MoveTester& operator=(const MoveTester&) = default;
 120   MoveTester& operator=(MoveTester&&) = default;
 121 private:
 122   friend bool operator==(const MoveTester& o1, const MoveTester& o2);
 123   std::string s_;
 124 };
 125
 126 bool operator==(const MoveTester& o1, const MoveTester& o2) {
 127   return o1.s_ == o2.s_;
 128 }
 129
 130 TEST(Optional, value_or_rvalue_arg) {
 131   Optional<MoveTester> opt;
 132   MoveTester dflt = "hello";
 133   EXPECT_EQ("hello", opt.value_or(dflt));
 134   EXPECT_EQ("hello", dflt);
 135   EXPECT_EQ("hello", opt.value_or(std::move(dflt)));
 136   EXPECT_EQ("", dflt);
 137   EXPECT_EQ("world", opt.value_or("world"));
 138
 139   dflt = "hello";
 140   // Make sure that the const overload works on const objects
 141   const auto& optc = opt;
 142   EXPECT_EQ("hello", optc.value_or(dflt));
 143   EXPECT_EQ("hello", dflt);
 144   EXPECT_EQ("hello", optc.value_or(std::move(dflt)));
 145   EXPECT_EQ("", dflt);
 146   EXPECT_EQ("world", optc.value_or("world"));
 147
 148   dflt = "hello";
 149   opt = "meow";
 150   EXPECT_EQ("meow", opt.value_or(dflt));
 151   EXPECT_EQ("hello", dflt);
 152   EXPECT_EQ("meow", opt.value_or(std::move(dflt)));
 153   EXPECT_EQ("hello", dflt);  // only moved if used
 154 }
 155
 156 TEST(Optional, value_or_noncopyable) {
 157   Optional<std::unique_ptr<int>> opt;
 158   std::unique_ptr<int> dflt(new int(42));
 159   EXPECT_EQ(42, *std::move(opt).value_or(std::move(dflt)));
 160 }
 161
 162 struct ExpectingDeleter {
 163   explicit ExpectingDeleter(int expected) : expected(expected) { }
 164   int expected;
 165   void operator()(const int* ptr) {
 166     EXPECT_EQ(*ptr, expected);
 167     delete ptr;
 168   }
 169 };
 170
 171 TEST(Optional, value_life_extention) {
 172   // Extends the life of the value.
 173   const auto& ptr = Optional<std::unique_ptr<int, ExpectingDeleter>>(
 174       {new int(42), ExpectingDeleter{1337}}).value();
 175   *ptr = 1337;
 176 }
 177
 178 TEST(Optional, value_move) {
 179   auto ptr = Optional<std::unique_ptr<int, ExpectingDeleter>>(
 180       {new int(42), ExpectingDeleter{1337}}).value();
 181   *ptr = 1337;
 182 }
 183
 184 TEST(Optional, dereference_life_extention) {
 185   // Extends the life of the value.
 186   const auto& ptr = *Optional<std::unique_ptr<int, ExpectingDeleter>>(
 187       {new int(42), ExpectingDeleter{1337}});
 188   *ptr = 1337;
 189 }
 190
 191 TEST(Optional, dereference_move) {
 192   auto ptr = *Optional<std::unique_ptr<int, ExpectingDeleter>>(
 193       {new int(42), ExpectingDeleter{1337}});
 194   *ptr = 1337;
 195 }
 196
 197 TEST(Optional, EmptyConstruct) {
 198   Optional<int> opt;
 199   EXPECT_FALSE(bool(opt));
 200   Optional<int> test1(opt);
 201   EXPECT_FALSE(bool(test1));
 202   Optional<int> test2(std::move(opt));
 203   EXPECT_FALSE(bool(test2));
 204 }
 205
 206 TEST(Optional, Unique) {
 207   Optional<unique_ptr<int>> opt;
 208
 209   opt.clear();
 210   EXPECT_FALSE(bool(opt));
 211   // empty->emplaced
 212   opt.emplace(new int(5));
 213   EXPECT_TRUE(bool(opt));
 214   EXPECT_EQ(5, **opt);
 215
 216   opt.clear();
 217   // empty->moved
 218   opt = unique_ptr<int>(new int(6));
 219   EXPECT_EQ(6, **opt);
 220   // full->moved
 221   opt = unique_ptr<int>(new int(7));
 222   EXPECT_EQ(7, **opt);
 223
 224   // move it out by move construct
 225   Optional<unique_ptr<int>> moved(std::move(opt));
 226   EXPECT_TRUE(bool(moved));
 227   EXPECT_FALSE(bool(opt));
 228   EXPECT_EQ(7, **moved);
 229
 230   EXPECT_TRUE(bool(moved));
 231   opt = std::move(moved); // move it back by move assign
 232   EXPECT_FALSE(bool(moved));
 233   EXPECT_TRUE(bool(opt));
 234   EXPECT_EQ(7, **opt);
 235 }
 236
 237 TEST(Optional, Shared) {
 238   shared_ptr<int> ptr;
 239   Optional<shared_ptr<int>> opt;
 240   EXPECT_FALSE(bool(opt));
 241   // empty->emplaced
 242   opt.emplace(new int(5));
 243   EXPECT_TRUE(bool(opt));
 244   ptr = opt.value();
 245   EXPECT_EQ(ptr.get(), opt->get());
 246   EXPECT_EQ(2, ptr.use_count());
 247   opt.clear();
 248   EXPECT_EQ(1, ptr.use_count());
 249   // full->copied
 250   opt = ptr;
 251   EXPECT_EQ(2, ptr.use_count());
 252   EXPECT_EQ(ptr.get(), opt->get());
 253   opt.clear();
 254   EXPECT_EQ(1, ptr.use_count());
 255   // full->moved
 256   opt = std::move(ptr);
 257   EXPECT_EQ(1, opt->use_count());
 258   EXPECT_EQ(nullptr, ptr.get());
 259   {
 260     Optional<shared_ptr<int>> copied(opt);
 261     EXPECT_EQ(2, opt->use_count());
 262     Optional<shared_ptr<int>> moved(std::move(opt));
 263     EXPECT_EQ(2, moved->use_count());
 264     moved.emplace(new int(6));
 265     EXPECT_EQ(1, moved->use_count());
 266     copied = moved;
 267     EXPECT_EQ(2, moved->use_count());
 268   }
 269 }
 270
 271 TEST(Optional, Order) {
 272   std::vector<Optional<int>> vect{
 273     { none },
 274     { 3 },
 275     { 1 },
 276     { none },
 277     { 2 },
 278   };
 279   std::vector<Optional<int>> expected {
 280     { none },
 281     { none },
 282     { 1 },
 283     { 2 },
 284     { 3 },
 285   };
 286   std::sort(vect.begin(), vect.end());
 287   EXPECT_EQ(vect, expected);
 288 }
 289
 290 TEST(Optional, Swap) {
 291   Optional<std::string> a;
 292   Optional<std::string> b;
 293
 294   swap(a, b);
 295   EXPECT_FALSE(a.hasValue());
 296   EXPECT_FALSE(b.hasValue());
 297
 298   a = "hello";
 299   EXPECT_TRUE(a.hasValue());
 300   EXPECT_FALSE(b.hasValue());
 301   EXPECT_EQ("hello", a.value());
 302
 303   swap(a, b);
 304   EXPECT_FALSE(a.hasValue());
 305   EXPECT_TRUE(b.hasValue());
 306   EXPECT_EQ("hello", b.value());
 307
 308   a = "bye";
 309   EXPECT_TRUE(a.hasValue());
 310   EXPECT_EQ("bye", a.value());
 311
 312   swap(a, b);
 313 }
 314
 315 TEST(Optional, Comparisons) {
 316   Optional<int> o_;
 317   Optional<int> o1(1);
 318   Optional<int> o2(2);
 319
 320   EXPECT_TRUE(o_ <= (o_));
 321   EXPECT_TRUE(o_ == (o_));
 322   EXPECT_TRUE(o_ >= (o_));
 323
 324   EXPECT_TRUE(o1 < o2);
 325   EXPECT_TRUE(o1 <= o2);
 326   EXPECT_TRUE(o1 <= (o1));
 327   EXPECT_TRUE(o1 == (o1));
 328   EXPECT_TRUE(o1 != o2);
 329   EXPECT_TRUE(o1 >= (o1));
 330   EXPECT_TRUE(o2 >= o1);
 331   EXPECT_TRUE(o2 > o1);
 332
 333   EXPECT_FALSE(o2 < o1);
 334   EXPECT_FALSE(o2 <= o1);
 335   EXPECT_FALSE(o2 <= o1);
 336   EXPECT_FALSE(o2 == o1);
 337   EXPECT_FALSE(o1 != (o1));
 338   EXPECT_FALSE(o1 >= o2);
 339   EXPECT_FALSE(o1 >= o2);
 340   EXPECT_FALSE(o1 > o2);
 341
 342   /* folly::Optional explicitly doesn't support comparisons with contained value
 343   EXPECT_TRUE(1 < o2);
 344   EXPECT_TRUE(1 <= o2);
 345   EXPECT_TRUE(1 <= o1);
 346   EXPECT_TRUE(1 == o1);
 347   EXPECT_TRUE(2 != o1);
 348   EXPECT_TRUE(1 >= o1);
 349   EXPECT_TRUE(2 >= o1);
 350   EXPECT_TRUE(2 > o1);
 351
 352   EXPECT_FALSE(o2 < 1);
 353   EXPECT_FALSE(o2 <= 1);
 354   EXPECT_FALSE(o2 <= 1);
 355   EXPECT_FALSE(o2 == 1);
 356   EXPECT_FALSE(o2 != 2);
 357   EXPECT_FALSE(o1 >= 2);
 358   EXPECT_FALSE(o1 >= 2);
 359   EXPECT_FALSE(o1 > 2);
 360   */
 361
 362   // boost::optional does support comparison with contained value, which can
 363   // lead to confusion when a bool is contained
 364   boost::optional<int> boi(3);
 365   EXPECT_TRUE(boi < 5);
 366   EXPECT_TRUE(boi <= 4);
 367   EXPECT_TRUE(boi == 3);
 368   EXPECT_TRUE(boi != 2);
 369   EXPECT_TRUE(boi >= 1);
 370   EXPECT_TRUE(boi > 0);
 371   EXPECT_TRUE(1 <  boi);
 372   EXPECT_TRUE(2 <= boi);
 373   EXPECT_TRUE(3 == boi);
 374   EXPECT_TRUE(4 != boi);
 375   EXPECT_TRUE(5 >= boi);
 376   EXPECT_TRUE(6 >  boi);
 377
 378   boost::optional<bool> bob(false);
 379   EXPECT_TRUE((bool)bob);
 380   EXPECT_TRUE(bob == false); // well that was confusing
 381   EXPECT_FALSE(bob != false);
 382 }
 383
 384 TEST(Optional, Conversions) {
 385   Optional<bool> mbool;
 386   Optional<short> mshort;
 387   Optional<char*> mstr;
 388   Optional<int> mint;
 389
 390   //These don't compile
 391   //bool b = mbool;
 392   //short s = mshort;
 393   //char* c = mstr;
 394   //int x = mint;
 395   //char* c(mstr);
 396   //short s(mshort);
 397   //int x(mint);
 398
 399   // intended explicit operator bool, for if (opt).
 400   bool b(mbool);
 401
 402   // Truthy tests work and are not ambiguous
 403   if (mbool && mshort && mstr && mint) { // only checks not-empty
 404     if (*mbool && *mshort && *mstr && *mint) { // only checks value
 405       ;
 406     }
 407   }
 408
 409   mbool = false;
 410   EXPECT_TRUE(bool(mbool));
 411   EXPECT_FALSE(*mbool);
 412
 413   mbool = true;
 414   EXPECT_TRUE(bool(mbool));
 415   EXPECT_TRUE(*mbool);
 416
 417   mbool = none;
 418   EXPECT_FALSE(bool(mbool));
 419
 420   // No conversion allowed; does not compile
 421   // EXPECT_TRUE(mbool == false);
 422 }
 423
 424 TEST(Optional, Pointee) {
 425   Optional<int> x;
 426   EXPECT_FALSE(get_pointer(x));
 427   x = 1;
 428   EXPECT_TRUE(get_pointer(x));
 429   *get_pointer(x) = 2;
 430   EXPECT_TRUE(*x == 2);
 431   x = none;
 432   EXPECT_FALSE(get_pointer(x));
 433 }
 434
 435 TEST(Optional, MakeOptional) {
 436   // const L-value version
 437   const std::string s("abc");
 438   auto optStr = make_optional(s);
 439   ASSERT_TRUE(optStr.hasValue());
 440   EXPECT_EQ(*optStr, "abc");
 441   *optStr = "cde";
 442   EXPECT_EQ(s, "abc");
 443   EXPECT_EQ(*optStr, "cde");
 444
 445   // L-value version
 446   std::string s2("abc");
 447   auto optStr2 = make_optional(s2);
 448   ASSERT_TRUE(optStr2.hasValue());
 449   EXPECT_EQ(*optStr2, "abc");
 450   *optStr2 = "cde";
 451   // it's vital to check that s2 wasn't clobbered
 452   EXPECT_EQ(s2, "abc");
 453
 454   // L-value reference version
 455   std::string& s3(s2);
 456   auto optStr3 = make_optional(s3);
 457   ASSERT_TRUE(optStr3.hasValue());
 458   EXPECT_EQ(*optStr3, "abc");
 459   *optStr3 = "cde";
 460   EXPECT_EQ(s3, "abc");
 461
 462   // R-value ref version
 463   unique_ptr<int> pInt(new int(3));
 464   auto optIntPtr = make_optional(std::move(pInt));
 465   EXPECT_TRUE(pInt.get() == nullptr);
 466   ASSERT_TRUE(optIntPtr.hasValue());
 467   EXPECT_EQ(**optIntPtr, 3);
 468 }
 469
 470 #ifdef __clang__
 471 # pragma clang diagnostic push
 472 # if __clang_major__ > 3 || __clang_minor__ >= 6
 473 #  pragma clang diagnostic ignored "-Wself-move"
 474 # endif
 475 #endif
 476
 477 TEST(Optional, SelfAssignment) {
 478   Optional<int> a = 42;
 479   a = a;
 480   ASSERT_TRUE(a.hasValue() && a.value() == 42);
 481
 482   Optional<int> b = 23333333;
 483   b = std::move(b);
 484   ASSERT_TRUE(b.hasValue() && b.value() == 23333333);
 485 }
 486
 487 #ifdef __clang__
 488 #pragma clang diagnostic pop
 489 #endif
 490
 491 class ContainsOptional {
 492  public:
 493   ContainsOptional() { }
 494   explicit ContainsOptional(int x) : opt_(x) { }
 495   bool hasValue() const { return opt_.hasValue(); }
 496   int value() const { return opt_.value(); }
 497
 498   ContainsOptional(const ContainsOptional &other) = default;
 499   ContainsOptional& operator=(const ContainsOptional &other) = default;
 500   ContainsOptional(ContainsOptional &&other) = default;
 501   ContainsOptional& operator=(ContainsOptional &&other) = default;
 502
 503  private:
 504   Optional<int> opt_;
 505 };
 506
 507 /**
 508  * Test that a class containing an Optional can be copy and move assigned.
 509  * This was broken under gcc 4.7 until assignment operators were explicitly
 510  * defined.
 511  */
 512 TEST(Optional, AssignmentContained) {
 513   {
 514     ContainsOptional source(5), target;
 515     target = source;
 516     EXPECT_TRUE(target.hasValue());
 517     EXPECT_EQ(5, target.value());
 518   }
 519
 520   {
 521     ContainsOptional source(5), target;
 522     target = std::move(source);
 523     EXPECT_TRUE(target.hasValue());
 524     EXPECT_EQ(5, target.value());
 525     EXPECT_FALSE(source.hasValue());
 526   }
 527
 528   {
 529     ContainsOptional opt_uninit, target(10);
 530     target = opt_uninit;
 531     EXPECT_FALSE(target.hasValue());
 532   }
 533 }
 534
 535 TEST(Optional, Exceptions) {
 536   Optional<int> empty;
 537   EXPECT_THROW(empty.value(), OptionalEmptyException);
 538 }
 539
 540 }