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