folly/test/IPAddressTest.cpp

   1 /*
   2  * Copyright 2017 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 <sys/types.h>
  18
  19 #include <string>
  20
  21 #include <folly/Bits.h>
  22 #include <folly/Format.h>
  23 #include <folly/IPAddress.h>
  24 #include <folly/MacAddress.h>
  25 #include <folly/String.h>
  26 #include <folly/detail/IPAddressSource.h>
  27 #include <folly/portability/GMock.h>
  28 #include <folly/portability/GTest.h>
  29
  30 using namespace folly;
  31 using namespace std;
  32 using namespace testing;
  33
  34 typedef std::vector<uint8_t> ByteVector;
  35
  36 struct AddressData {
  37   std::string address;
  38   ByteVector bytes;
  39   uint8_t version;
  40
  41   AddressData(
  42       const std::string& address,
  43       const ByteVector& bytes,
  44       uint8_t version)
  45       : address(address), bytes(bytes), version(version) {}
  46   AddressData(const std::string& address, uint8_t version)
  47       : address(address), bytes(), version(version) {}
  48   explicit AddressData(const std::string& address)
  49       : address(address), bytes(), version(0) {}
  50   AddressData() : address(""), bytes(), version(0) {}
  51
  52   static in_addr parseAddress4(const std::string& src) {
  53     in_addr addr;
  54     inet_pton(AF_INET, src.c_str(), &addr);
  55     return addr;
  56   }
  57
  58   static in6_addr parseAddress6(const std::string& src) {
  59     in6_addr addr;
  60     inet_pton(AF_INET6, src.c_str(), &addr);
  61     return addr;
  62   }
  63 };
  64
  65 struct AddressFlags {
  66   std::string address;
  67   uint8_t flags;
  68   uint8_t version;
  69
  70   static const uint8_t IS_LOCAL = 1 << 0;
  71   static const uint8_t IS_NONROUTABLE = 1 << 1;
  72   static const uint8_t IS_PRIVATE = 1 << 2;
  73   static const uint8_t IS_ZERO = 1 << 3;
  74   static const uint8_t IS_LINK_LOCAL = 1 << 4;
  75   static const uint8_t IS_MULTICAST = 1 << 5;
  76   static const uint8_t IS_LINK_LOCAL_BROADCAST = 1 << 6;
  77
  78   AddressFlags(const std::string& addr, uint8_t version, uint8_t flags)
  79       : address(addr), flags(flags), version(version) {}
  80
  81   bool isLoopback() const {
  82     return (flags & IS_LOCAL);
  83   }
  84   bool isNonroutable() const {
  85     return (flags & IS_NONROUTABLE);
  86   }
  87   bool isPrivate() const {
  88     return (flags & IS_PRIVATE);
  89   }
  90   bool isZero() const {
  91     return (flags & IS_ZERO);
  92   }
  93   bool isLinkLocal() const {
  94     return (flags & IS_LINK_LOCAL);
  95   }
  96   bool isLinkLocalBroadcast() const {
  97     return (flags & IS_LINK_LOCAL_BROADCAST);
  98   }
  99 };
 100
 101 struct MaskData {
 102   std::string address;
 103   uint8_t mask;
 104   std::string subnet;
 105   MaskData(const std::string& addr, uint8_t mask, const std::string& subnet)
 106       : address(addr), mask(mask), subnet(subnet) {}
 107 };
 108
 109 struct MaskBoundaryData : MaskData {
 110   bool inSubnet;
 111   MaskBoundaryData(
 112       const std::string& addr,
 113       uint8_t mask,
 114       const std::string& subnet,
 115       bool inSubnet)
 116       : MaskData(addr, mask, subnet), inSubnet(inSubnet) {}
 117 };
 118
 119 struct SerializeData {
 120   std::string address;
 121   ByteVector bytes;
 122
 123   SerializeData(const std::string& addr, const ByteVector& bytes)
 124       : address(addr), bytes(bytes) {}
 125 };
 126
 127 struct IPAddressTest : TestWithParam<AddressData> {
 128   void ExpectIsValid(const IPAddress& addr) {
 129     AddressData param = GetParam();
 130     EXPECT_EQ(param.version, addr.version());
 131     EXPECT_EQ(param.address, addr.str());
 132     if (param.version == 4) {
 133       in_addr v4addr = AddressData::parseAddress4(param.address);
 134       EXPECT_EQ(0, memcmp(&v4addr, addr.asV4().toByteArray().data(), 4));
 135       EXPECT_TRUE(addr.isV4());
 136       EXPECT_FALSE(addr.isV6());
 137     } else {
 138       in6_addr v6addr = AddressData::parseAddress6(param.address);
 139       EXPECT_EQ(0, memcmp(&v6addr, addr.asV6().toByteArray().data(), 16));
 140       EXPECT_TRUE(addr.isV6());
 141       EXPECT_FALSE(addr.isV4());
 142     }
 143   }
 144 };
 145 struct IPAddressFlagTest : TestWithParam<AddressFlags> {};
 146 struct IPAddressCtorTest : TestWithParam<std::string> {};
 147 struct IPAddressCtorBinaryTest : TestWithParam<ByteVector> {};
 148 struct IPAddressMappedTest
 149     : TestWithParam<std::pair<std::string, std::string>> {};
 150 struct IPAddressMaskTest : TestWithParam<MaskData> {};
 151 struct IPAddressMaskBoundaryTest : TestWithParam<MaskBoundaryData> {};
 152 struct IPAddressSerializeTest : TestWithParam<SerializeData> {};
 153 struct IPAddressByteAccessorTest : TestWithParam<AddressData> {};
 154 struct IPAddressBitAccessorTest : TestWithParam<AddressData> {};
 155
 156 // tests code example
 157 TEST(IPAddress, CodeExample) {
 158   EXPECT_EQ(4, sizeof(IPAddressV4));
 159   EXPECT_EQ(20, sizeof(IPAddressV6));
 160   EXPECT_EQ(24, sizeof(IPAddress));
 161   IPAddress uninitaddr;
 162   IPAddress v4addr("192.0.2.129");
 163   IPAddress v6map("::ffff:192.0.2.129");
 164   ASSERT_TRUE(uninitaddr.empty());
 165   ASSERT_FALSE(v4addr.empty());
 166   ASSERT_FALSE(v6map.empty());
 167   EXPECT_TRUE(v4addr.inSubnet("192.0.2.0/24"));
 168   EXPECT_TRUE(v4addr.inSubnet(IPAddress("192.0.2.0"), 24));
 169   EXPECT_TRUE(v4addr.inSubnet("192.0.2.128/30"));
 170   EXPECT_FALSE(v4addr.inSubnet("192.0.2.128/32"));
 171   EXPECT_EQ(2164392128, v4addr.asV4().toLong());
 172   EXPECT_EQ(3221226113, v4addr.asV4().toLongHBO());
 173   ASSERT_FALSE(uninitaddr.isV4());
 174   ASSERT_FALSE(uninitaddr.isV6());
 175   ASSERT_TRUE(v4addr.isV4());
 176   ASSERT_TRUE(v6map.isV6());
 177   EXPECT_TRUE(v4addr == v6map);
 178   ASSERT_TRUE(v6map.isIPv4Mapped());
 179   EXPECT_TRUE(v4addr.asV4() == IPAddress::createIPv4(v6map));
 180   EXPECT_TRUE(IPAddress::createIPv6(v4addr) == v6map.asV6());
 181 }
 182
 183 TEST(IPAddress, Scope) {
 184   // Test that link-local scope is saved
 185   auto str = "fe80::62eb:69ff:fe9b:ba60%eth0";
 186   IPAddressV6 a2(str);
 187   EXPECT_EQ(str, a2.str());
 188
 189   sockaddr_in6 sock = a2.toSockAddr();
 190   EXPECT_NE(0, sock.sin6_scope_id);
 191
 192   IPAddress a1(str);
 193   EXPECT_EQ(str, a1.str());
 194
 195   a2.setScopeId(0);
 196   EXPECT_NE(a1, a2);
 197
 198   EXPECT_TRUE(a2 < a1);
 199 }
 200
 201 TEST(IPAddress, ScopeNumeric) {
 202   // it's very unlikely that the host running these
 203   // tests will have 42 network interfaces
 204   auto str = "fe80::62eb:69ff:fe9b:ba60%42";
 205   IPAddressV6 a2(str);
 206   EXPECT_EQ(str, a2.str());
 207
 208   sockaddr_in6 sock = a2.toSockAddr();
 209   EXPECT_NE(0, sock.sin6_scope_id);
 210
 211   IPAddress a1(str);
 212   EXPECT_EQ(str, a1.str());
 213
 214   a2.setScopeId(0);
 215   EXPECT_NE(a1, a2);
 216
 217   EXPECT_TRUE(a2 < a1);
 218 }
 219
 220 TEST(IPAddress, Ordering) {
 221   IPAddress a1("0.1.1.1");
 222   IPAddress a2("1.1.1.0");
 223   EXPECT_TRUE(a1 < a2);
 224
 225   IPAddress b1("::ffff:0.1.1.1");
 226   IPAddress b2("::ffff:1.1.1.0");
 227   EXPECT_TRUE(b1 < b2);
 228 }
 229
 230 TEST(IPAddress, InvalidAddressFamilyExceptions) {
 231   // asV4
 232   {
 233     IPAddress addr;
 234     EXPECT_THROW(addr.asV4(), InvalidAddressFamilyException);
 235   }
 236   // asV6
 237   {
 238     IPAddress addr;
 239     EXPECT_THROW(addr.asV6(), InvalidAddressFamilyException);
 240   }
 241   // sockaddr ctor
 242   {
 243     // setup
 244     sockaddr_in addr;
 245     addr.sin_family = AF_UNSPEC;
 246
 247     EXPECT_THROW(IPAddress((sockaddr *)&addr), InvalidAddressFamilyException);
 248   }
 249 }
 250
 251 TEST(IPAddress, CreateNetwork) {
 252   // test valid IPv4 network
 253   {
 254     auto net = IPAddress::createNetwork("192.168.0.1/24");
 255     ASSERT_TRUE(net.first.isV4());
 256     EXPECT_EQ("192.168.0.0", net.first.str());
 257     EXPECT_EQ(24, net.second);
 258     EXPECT_EQ("192.168.0.0/24", IPAddress::networkToString(net));
 259   }
 260   // test valid IPv4 network without applying mask
 261   {
 262     auto net = IPAddress::createNetwork("192.168.0.1/24", -1, false);
 263     ASSERT_TRUE(net.first.isV4());
 264     EXPECT_EQ("192.168.0.1", net.first.str());
 265     EXPECT_EQ(24, net.second);
 266     EXPECT_EQ("192.168.0.1/24", IPAddress::networkToString(net));
 267   }
 268   // test valid IPv6 network
 269   {
 270     auto net = IPAddress::createNetwork("1999::1/24");
 271     ASSERT_TRUE(net.first.isV6());
 272     EXPECT_EQ("1999::", net.first.str());
 273     EXPECT_EQ(24, net.second);
 274     EXPECT_EQ("1999::/24", IPAddress::networkToString(net));
 275   }
 276   // test valid IPv6 network without applying mask
 277   {
 278     auto net = IPAddress::createNetwork("1999::1/24", -1, false);
 279     ASSERT_TRUE(net.first.isV6());
 280     EXPECT_EQ("1999::1", net.first.str());
 281     EXPECT_EQ(24, net.second);
 282     EXPECT_EQ("1999::1/24", IPAddress::networkToString(net));
 283   }
 284   // test empty string
 285   EXPECT_THROW(IPAddress::createNetwork(""), IPAddressFormatException);
 286   // test multi slash string
 287   EXPECT_THROW(IPAddress::createNetwork("192.168.0.1/24/36"),
 288                                         IPAddressFormatException);
 289   // test no slash string with default IPv4
 290   {
 291     auto net = IPAddress::createNetwork("192.168.0.1");
 292     ASSERT_TRUE(net.first.isV4());
 293     EXPECT_EQ("192.168.0.1", net.first.str());
 294     EXPECT_EQ(32, net.second);  // auto-detected
 295     net = IPAddress::createNetwork("192.168.0.1", -1, false);
 296     ASSERT_TRUE(net.first.isV4());
 297     EXPECT_EQ("192.168.0.1", net.first.str());
 298     EXPECT_EQ(32, net.second);
 299   }
 300   // test no slash string with default IPv6
 301   {
 302     auto net = IPAddress::createNetwork("1999::1");
 303     ASSERT_TRUE(net.first.isV6());
 304     EXPECT_EQ("1999::1", net.first.str());
 305     EXPECT_EQ(128, net.second);
 306   }
 307   // test no slash string with invalid default
 308   EXPECT_THROW(IPAddress::createNetwork("192.168.0.1", 33),
 309                IPAddressFormatException);
 310
 311 }
 312
 313 // test assignment operators
 314 TEST(IPAddress, Assignment) {
 315   static const string kIPv4Addr = "69.63.189.16";
 316   static const string kIPv6Addr = "2620:0:1cfe:face:b00c::3";
 317
 318   // Test assigning IPAddressV6 addr to IPAddress (was V4)
 319   {
 320     IPAddress addr(kIPv4Addr);
 321     IPAddressV6 addrV6 = IPAddress(kIPv6Addr).asV6();
 322     EXPECT_TRUE(addr.isV4());
 323     EXPECT_EQ(kIPv4Addr, addr.str());
 324     addr = addrV6;
 325     EXPECT_TRUE(addr.isV6());
 326     EXPECT_EQ(kIPv6Addr, addr.str());
 327   }
 328   // Test assigning IPAddressV4 addr to IPAddress (was V6)
 329   {
 330     IPAddress addr(kIPv6Addr);
 331     IPAddressV4 addrV4 = IPAddress(kIPv4Addr).asV4();
 332     EXPECT_TRUE(addr.isV6());
 333     EXPECT_EQ(kIPv6Addr, addr.str());
 334     addr = addrV4;
 335     EXPECT_TRUE(addr.isV4());
 336     EXPECT_EQ(kIPv4Addr, addr.str());
 337   }
 338   // Test assigning IPAddress(v6) to IPAddress (was v4)
 339   {
 340     IPAddress addr(kIPv4Addr);
 341     IPAddress addrV6 = IPAddress(kIPv6Addr);
 342     EXPECT_TRUE(addr.isV4());
 343     EXPECT_EQ(kIPv4Addr, addr.str());
 344     addr = addrV6;
 345     EXPECT_TRUE(addr.isV6());
 346     EXPECT_EQ(kIPv6Addr, addr.str());
 347   }
 348   // Test assigning IPAddress(v4) to IPAddress (was v6)
 349   {
 350     IPAddress addr(kIPv6Addr);
 351     IPAddress addrV4 = IPAddress(kIPv4Addr);
 352     EXPECT_TRUE(addr.isV6());
 353     EXPECT_EQ(kIPv6Addr, addr.str());
 354     addr = addrV4;
 355     EXPECT_TRUE(addr.isV4());
 356     EXPECT_EQ(kIPv4Addr, addr.str());
 357   }
 358 }
 359
 360 // Test the default constructors
 361 TEST(IPAddress, CtorDefault) {
 362   IPAddressV4 v4;
 363   EXPECT_EQ(IPAddressV4("0.0.0.0"), v4);
 364   IPAddressV6 v6;
 365   EXPECT_EQ(IPAddressV6("::0"), v6);
 366 }
 367
 368 TEST(IPAddressV4, validate) {
 369   EXPECT_TRUE(IPAddressV4::validate("0.0.0.0"));
 370   EXPECT_FALSE(IPAddressV4::validate("0.0.0."));
 371   EXPECT_TRUE(IPAddressV4::validate("127.127.127.127"));
 372 }
 373
 374 TEST(IPAddressV6, validate) {
 375   EXPECT_TRUE(IPAddressV6::validate("2620:0:1cfe:face:b00c::3"));
 376   EXPECT_FALSE(IPAddressV6::validate("0.0.0.0"));
 377   EXPECT_TRUE(IPAddressV6::validate("[2620:0:1cfe:face:b00c::3]"));
 378   EXPECT_TRUE(IPAddressV6::validate("::ffff:0.1.1.1"));
 379   EXPECT_TRUE(IPAddressV6::validate("2620:0000:1cfe:face:b00c:0000:0000:0003"));
 380   EXPECT_TRUE(
 381       IPAddressV6::validate("2620:0000:1cfe:face:b00c:0000:127.127.127.127"));
 382 }
 383
 384 TEST(IPAddress, validate) {
 385   EXPECT_TRUE(IPAddress::validate("0.0.0.0"));
 386   EXPECT_TRUE(IPAddress::validate("::"));
 387   EXPECT_FALSE(IPAddress::validate("asdf"));
 388 }
 389
 390 // Test addresses constructed using a in[6]_addr value
 391 TEST_P(IPAddressTest, CtorAddress) {
 392   AddressData param = GetParam();
 393   IPAddress strAddr(param.address);
 394   IPAddress address;
 395
 396   if (param.version == 4) {
 397     in_addr v4addr = detail::Bytes::mkAddress4(&param.bytes[0]);
 398     address = IPAddress(v4addr);
 399   } else {
 400     in6_addr v6addr = detail::Bytes::mkAddress6(&param.bytes[0]);
 401     address = IPAddress(v6addr);
 402   }
 403   ExpectIsValid(address);
 404   EXPECT_EQ(strAddr, address);
 405 }
 406
 407 // Test addresses constructed using a binary address
 408 TEST_P(IPAddressTest, CtorBinary) {
 409   AddressData param = GetParam();
 410   IPAddress address;
 411
 412   if (param.version == 4) {
 413     in_addr v4addr = AddressData::parseAddress4(param.address);
 414     address = IPAddress::fromBinary(ByteRange((unsigned char*)&v4addr, 4));
 415   } else {
 416     in6_addr v6addr = AddressData::parseAddress6(param.address);
 417     address = IPAddress::fromBinary(ByteRange((unsigned char*)&v6addr, 16));
 418   }
 419
 420   ExpectIsValid(address);
 421   EXPECT_EQ(IPAddress(param.address), address);
 422 }
 423
 424 // Test addresses constructed using a string
 425 TEST_P(IPAddressTest, CtorString) {
 426   AddressData param = GetParam();
 427   IPAddress address(param.address);
 428
 429   ExpectIsValid(address);
 430
 431   // Test the direct version-specific constructor
 432   if (param.version == 4) {
 433     IPAddressV4 v4(param.address);
 434     ExpectIsValid(IPAddress(v4));
 435     EXPECT_THROW(IPAddressV6 v6(param.address), IPAddressFormatException);
 436   } else if (param.version == 6) {
 437     IPAddressV6 v6(param.address);
 438     ExpectIsValid(IPAddress(v6));
 439     EXPECT_THROW(IPAddressV4 v4(param.address), IPAddressFormatException);
 440   }
 441 }
 442
 443 TEST(IPAddress, CtorSockaddr) {
 444   // test v4 address
 445   {
 446     // setup
 447     sockaddr_in addr;
 448     in_addr sin_addr;
 449     sin_addr.s_addr = htonl(2122547223);
 450     addr.sin_family = AF_INET;
 451     addr.sin_addr = sin_addr;
 452
 453     IPAddress ipAddr((sockaddr *)&addr);
 454     EXPECT_TRUE(ipAddr.isV4());
 455     EXPECT_EQ("126.131.128.23", ipAddr.str());
 456   }
 457   // test v6 address
 458   {
 459     // setup
 460     sockaddr_in6 addr;
 461     memset(&addr, 0, sizeof(addr));
 462     in6_addr sin_addr;
 463     ByteArray16 sec{{
 464       // 2620:0:1cfe:face:b00c::3
 465       38,32,0,0,28,254,250,206,176,12,0,0,0,0,0,3
 466     }};
 467     std::memcpy(sin_addr.s6_addr, sec.data(), 16);
 468     addr.sin6_family = AF_INET6;
 469     addr.sin6_addr = sin_addr;
 470
 471     IPAddress ipAddr((sockaddr *)&addr);
 472     EXPECT_TRUE(ipAddr.isV6());
 473     EXPECT_EQ("2620:0:1cfe:face:b00c::3", ipAddr.str());
 474   }
 475   // test nullptr exception
 476   {
 477     sockaddr *addr = nullptr;
 478     EXPECT_THROW(IPAddress((const sockaddr*)addr), IPAddressFormatException);
 479   }
 480   // test invalid family exception
 481   {
 482     // setup
 483     sockaddr_in addr;
 484     in_addr sin_addr;
 485     sin_addr.s_addr = htonl(2122547223);
 486     addr.sin_family = AF_UNSPEC;
 487     addr.sin_addr = sin_addr;
 488
 489     EXPECT_THROW(IPAddress((sockaddr *)&addr), IPAddressFormatException);
 490   }
 491 }
 492
 493 TEST(IPAddress, ToSockaddrStorage) {
 494   // test v4 address
 495   {
 496     string strAddr("126.131.128.23");
 497     IPAddress addr(strAddr);
 498     sockaddr_storage out;
 499
 500     ASSERT_TRUE(addr.isV4()); // test invariant
 501     EXPECT_GT(addr.toSockaddrStorage(&out), 0);
 502
 503     IPAddress sockAddr((sockaddr*)&out);
 504     ASSERT_TRUE(sockAddr.isV4());
 505     EXPECT_EQ(strAddr, sockAddr.str());
 506   }
 507   // test v6 address
 508   {
 509     string strAddr("2620:0:1cfe:face:b00c::3");
 510     IPAddress addr(strAddr);
 511     sockaddr_storage out;
 512
 513     ASSERT_TRUE(addr.isV6()); // test invariant
 514     EXPECT_GT(addr.toSockaddrStorage(&out), 0);
 515
 516     IPAddress sockAddr((sockaddr*)&out);
 517     ASSERT_TRUE(sockAddr.isV6());
 518     EXPECT_EQ(strAddr, sockAddr.str());
 519   }
 520   // test nullptr exception
 521   {
 522     sockaddr_storage *out = nullptr;
 523     IPAddress addr("127.0.0.1");
 524     EXPECT_THROW(addr.toSockaddrStorage(out), IPAddressFormatException);
 525   }
 526   // test invalid family exception
 527   {
 528     IPAddress addr;
 529     sockaddr_storage out;
 530     ASSERT_EQ(AF_UNSPEC, addr.family());
 531     EXPECT_THROW(addr.toSockaddrStorage(&out), InvalidAddressFamilyException);
 532   }
 533 }
 534
 535 TEST(IPAddress, ToString) {
 536   // Test with IPAddressV4
 537   IPAddressV4 addr_10_0_0_1("10.0.0.1");
 538   EXPECT_EQ("10.0.0.1", folly::to<string>(addr_10_0_0_1));
 539   // Test with IPAddressV6
 540   IPAddressV6 addr_1("::1");
 541   EXPECT_EQ("::1", folly::to<string>(addr_1));
 542   // Test with IPAddress, both V4 and V6
 543   IPAddress addr_10_1_2_3("10.1.2.3");
 544   EXPECT_EQ("10.1.2.3", folly::to<string>(addr_10_1_2_3));
 545   IPAddress addr_1_2_3("1:2::3");
 546   EXPECT_EQ("1:2::3", folly::to<string>(addr_1_2_3));
 547
 548   // Test a combination of all the above arguments
 549   EXPECT_EQ("1:2::3 - 10.0.0.1 - ::1 - 10.1.2.3",
 550             folly::to<string>(addr_1_2_3, " - ", addr_10_0_0_1,
 551                               " - ", addr_1, " - ", addr_10_1_2_3));
 552 }
 553
 554 TEST(IPaddress, toInverseArpaName) {
 555   IPAddressV4 addr_ipv4("10.0.0.1");
 556   EXPECT_EQ("1.0.0.10.in-addr.arpa", addr_ipv4.toInverseArpaName());
 557   IPAddressV6 addr_ipv6("2620:0000:1cfe:face:b00c:0000:0000:0003");
 558   EXPECT_EQ(
 559       sformat(
 560           "{}.ip6.arpa",
 561           "3.0.0.0.0.0.0.0.0.0.0.0.c.0.0.b.e.c.a.f.e.f.c.1.0.0.0.0.0.2.6.2"),
 562       addr_ipv6.toInverseArpaName());
 563 }
 564
 565 TEST(IPaddress, fromInverseArpaName) {
 566   EXPECT_EQ(
 567       IPAddressV4("10.0.0.1"),
 568       IPAddressV4::fromInverseArpaName("1.0.0.10.in-addr.arpa"));
 569   EXPECT_EQ(
 570       IPAddressV6("2620:0000:1cfe:face:b00c:0000:0000:0003"),
 571       IPAddressV6::fromInverseArpaName(sformat(
 572           "{}.ip6.arpa",
 573           "3.0.0.0.0.0.0.0.0.0.0.0.c.0.0.b.e.c.a.f.e.f.c.1.0.0.0.0.0.2.6.2")));
 574 }
 575
 576 // Test that invalid string values are killed
 577 TEST_P(IPAddressCtorTest, InvalidCreation) {
 578   string addr = GetParam();
 579   EXPECT_THROW(IPAddress((const string)addr), IPAddressFormatException)
 580       << "IPAddress(" << addr << ") "
 581       << "should have thrown an IPAddressFormatException";
 582 }
 583
 584 // Test that invalid binary values throw an exception
 585 TEST_P(IPAddressCtorBinaryTest, InvalidBinary) {
 586   auto bin = GetParam();
 587   EXPECT_THROW(IPAddress::fromBinary(ByteRange(&bin[0], bin.size())),
 588                IPAddressFormatException);
 589 }
 590
 591 TEST(IPAddressSource, ToHex) {
 592   vector<std::uint8_t> data = {{0xff, 0x20, 0x45}};
 593   EXPECT_EQ(detail::Bytes::toHex(data.data(), 0), "");
 594   EXPECT_EQ(detail::Bytes::toHex(data.data(), 1), "ff");
 595   EXPECT_EQ(detail::Bytes::toHex(data.data(), 2), "ff20");
 596   EXPECT_EQ(detail::Bytes::toHex(data.data(), 3), "ff2045");
 597 }
 598
 599 // Test toFullyQualified()
 600 TEST(IPAddress, ToFullyQualifiedFb) {
 601   IPAddress ip("2620:0:1cfe:face:b00c::3");
 602   EXPECT_EQ("2620:0000:1cfe:face:b00c:0000:0000:0003", ip.toFullyQualified())
 603       << ip;
 604 }
 605 TEST(IPAddress, ToFullyQualifiedLocal) {
 606   IPAddress ip("::1");
 607   EXPECT_EQ("0000:0000:0000:0000:0000:0000:0000:0001", ip.toFullyQualified())
 608       << ip;
 609 }
 610 TEST(IPAddress, ToFullyQualifiedAppendV6) {
 611   IPAddress ip("2620:0:1cfe:face:b00c::3");
 612   std::string result;
 613   ip.toFullyQualifiedAppend(result);
 614   EXPECT_EQ("2620:0000:1cfe:face:b00c:0000:0000:0003", result) << ip;
 615 }
 616 TEST(IPAddress, ToFullyQualifiedAppendV4) {
 617   IPAddress ip("127.0.0.1");
 618   std::string result;
 619   ip.toFullyQualifiedAppend(result);
 620   EXPECT_EQ("127.0.0.1", result) << ip;
 621 }
 622 TEST(IPAddress, ToFullyQualifiedSizeV6) {
 623   auto actual = IPAddressV6::kToFullyQualifiedSize;
 624   auto expected = IPAddress("::").toFullyQualified().size();
 625   EXPECT_EQ(expected, actual);
 626 }
 627 TEST(IPAddress, MaxToFullyQualifiedSizeV4) {
 628   auto actual = IPAddressV4::kMaxToFullyQualifiedSize;
 629   auto expected = IPAddress("255.255.255.255").toFullyQualified().size();
 630   EXPECT_EQ(expected, actual);
 631 }
 632
 633 // test v4-v6 mapped addresses
 634 TEST_P(IPAddressMappedTest, MappedEqual) {
 635   auto param = GetParam();
 636   string mappedIp = param.first;
 637   string otherIp = param.second;
 638
 639   auto mapped = IPAddress(mappedIp);
 640   auto expected = IPAddress(otherIp);
 641
 642   EXPECT_EQ(expected, mapped);
 643
 644   IPAddress v6addr;
 645   if (mapped.isV4()) {
 646     v6addr = mapped.asV4().createIPv6();
 647   } else if (expected.isV4()) {
 648     v6addr = expected.asV4().createIPv6();
 649   }
 650   EXPECT_TRUE(v6addr.isV6());
 651   EXPECT_TRUE(mapped == v6addr);
 652   EXPECT_TRUE(expected == v6addr);
 653 }
 654
 655 // Test subnet mask calculations
 656 TEST_P(IPAddressMaskTest, Masks) {
 657   auto param = GetParam();
 658
 659   IPAddress ip(param.address);
 660   IPAddress masked = ip.mask(param.mask);
 661   EXPECT_EQ(param.subnet, masked.str())
 662       << param.address << "/" << folly::to<std::string>(param.mask) << " -> "
 663       << param.subnet;
 664 }
 665
 666 // Test inSubnet calculations
 667 TEST_P(IPAddressMaskTest, InSubnet) {
 668   auto param = GetParam();
 669
 670   IPAddress ip(param.address);
 671   IPAddress subnet(param.subnet);
 672   EXPECT_TRUE(ip.inSubnet(subnet, param.mask));
 673 }
 674
 675 // Test boundary conditions for subnet calculations
 676 TEST_P(IPAddressMaskBoundaryTest, NonMaskedSubnet) {
 677   auto param = GetParam();
 678   IPAddress ip(param.address);
 679   IPAddress subnet(param.subnet);
 680   EXPECT_EQ(param.inSubnet, ip.inSubnet(subnet, param.mask));
 681 }
 682
 683 TEST(IPAddress, UnitializedEqual) {
 684   IPAddress addrEmpty;
 685   IPAddress ip4("127.0.0.1");
 686   EXPECT_FALSE(addrEmpty == ip4);
 687   EXPECT_FALSE(ip4 == addrEmpty);
 688   IPAddress ip6("::1");
 689   EXPECT_FALSE(addrEmpty == ip6);
 690   EXPECT_FALSE(ip6 == addrEmpty);
 691   IPAddress ip6Map("::ffff:192.0.2.129");
 692   EXPECT_FALSE(addrEmpty == ip6Map);
 693   EXPECT_FALSE(ip6Map == addrEmpty);
 694   IPAddress ip4Zero("0.0.0.0");
 695   EXPECT_FALSE(addrEmpty == ip4Zero);
 696   EXPECT_FALSE(ip4Zero == addrEmpty);
 697   IPAddress ip6Zero("::");
 698   EXPECT_FALSE(addrEmpty == ip6Zero);
 699   EXPECT_FALSE(ip6Zero == addrEmpty);
 700   EXPECT_EQ(addrEmpty, addrEmpty);
 701 }
 702
 703 // Test subnet calcs with 6to4 addresses
 704 TEST(IPAddress, InSubnetWith6to4) {
 705   auto ip = IPAddress("2002:c000:022a::"); // 192.0.2.42
 706   auto subnet = IPAddress("192.0.0.0");
 707   EXPECT_TRUE(ip.inSubnet(subnet, 16));
 708
 709   auto ip2 = IPAddress("192.0.0.1");
 710   auto subnet2 = IPAddress("2002:c000:0000::"); // 192.0.0.0
 711   EXPECT_TRUE(ip2.inSubnet(subnet2, 14));
 712
 713   auto ip3 = IPAddress("2002:c000:022a::"); // 192.0.2.42
 714   auto subnet3 = IPAddress("2002:c000:0000::"); // 192.0.0.0
 715   EXPECT_TRUE(ip3.inSubnet(subnet3, 16));
 716 }
 717
 718 static const vector<string> ipv4Strs = {
 719   "127.0.0.1",
 720   "198.168.0.1",
 721   "8.8.0.0",
 722 };
 723 TEST(IPAddress, getIPv6For6To4) {
 724   for (auto ipv4Str : ipv4Strs) {
 725     auto ip = IPAddress(ipv4Str);
 726     EXPECT_TRUE(ip.isV4());
 727     IPAddressV4 ipv4 = ip.asV4();
 728     auto ipv6 = ipv4.getIPv6For6To4();
 729     EXPECT_EQ(ipv6.type(), IPAddressV6::Type::T6TO4);
 730     auto ipv4New = ipv6.getIPv4For6To4();
 731     EXPECT_TRUE(ipv4Str.compare(ipv4New.str()) == 0);
 732   }
 733 }
 734
 735 static const vector<pair<string, uint8_t> > invalidMasks = {
 736   {"127.0.0.1", 33},
 737   {"::1", 129},
 738 };
 739 TEST(IPAddress, InvalidMask) {
 740   for (auto& tc : invalidMasks) {
 741     auto ip = IPAddress(tc.first);
 742     EXPECT_THROW(ip.mask(tc.second), IPAddressFormatException);
 743   }
 744 }
 745
 746 static const vector<pair<string, IPAddressV6::Type> > v6types = {
 747   {"::1", IPAddressV6::Type::NORMAL},
 748   {"2620:0:1cfe:face:b00c::3", IPAddressV6::Type::NORMAL},
 749   {"2001:0000:4136:e378:8000:63bf:3fff:fdd2", IPAddressV6::Type::TEREDO},
 750   {"2002:c000:022a::", IPAddressV6::Type::T6TO4},
 751 };
 752 TEST(IPAddress, V6Types) {
 753   auto mkName = [&](const IPAddressV6::Type t) -> string {
 754     switch (t) {
 755       case IPAddressV6::Type::TEREDO:
 756         return "teredo";
 757       case IPAddressV6::Type::T6TO4:
 758         return "6to4";
 759       default:
 760         return "default";
 761     }
 762   };
 763
 764   for (auto& tc : v6types) {
 765     auto ip = IPAddress(tc.first);
 766     EXPECT_TRUE(ip.isV6());
 767     IPAddressV6 ipv6 = ip.asV6();
 768     EXPECT_EQ(tc.second, ipv6.type())
 769         << "expected " << mkName(tc.second) << ", got " << mkName(ipv6.type());
 770     switch (tc.second) {
 771       case IPAddressV6::Type::TEREDO:
 772         EXPECT_TRUE(ipv6.isTeredo()) << "isTeredo was false";
 773         EXPECT_FALSE(ipv6.is6To4()) << "is6To4 was true";
 774         break;
 775       case IPAddressV6::Type::T6TO4:
 776         EXPECT_TRUE(ipv6.is6To4()) << "is6To4 was false";
 777         EXPECT_FALSE(ipv6.isTeredo()) << "isTeredo was true";
 778         break;
 779       case IPAddressV6::Type::NORMAL:
 780         EXPECT_FALSE(ipv6.is6To4()) << "is6To4 was true";
 781         EXPECT_FALSE(ipv6.isTeredo()) << "isTeredo was true";
 782         break;
 783       default:
 784         FAIL() << "Invalid expected type: " << to<std::string>(tc.second);
 785     }
 786   }
 787 }
 788
 789 static const vector<pair<string, uint32_t> > provideToLong = {
 790   {"0.0.0.0", 0},
 791   {"10.0.0.0", 167772160},
 792   {"126.131.128.23", 2122547223},
 793   {"192.168.0.0", 3232235520},
 794 };
 795 TEST(IPAddress, ToLong) {
 796   for (auto& tc : provideToLong) {
 797     auto ip = IPAddress(tc.first);
 798     EXPECT_TRUE(ip.isV4());
 799     IPAddressV4 ipv4 = ip.asV4();
 800     EXPECT_EQ(tc.second, ipv4.toLongHBO());
 801
 802     auto ip2 = IPAddress::fromLongHBO(tc.second);
 803     EXPECT_TRUE(ip2.isV4());
 804     EXPECT_TRUE(tc.first.compare(ip2.str()) == 0);
 805     EXPECT_EQ(tc.second, ip2.asV4().toLongHBO());
 806
 807     auto nla = htonl(tc.second);
 808     auto ip3 = IPAddress::fromLong(nla);
 809     EXPECT_TRUE(ip3.isV4());
 810     EXPECT_TRUE(tc.first.compare(ip3.str()) == 0);
 811     EXPECT_EQ(nla, ip3.asV4().toLong());
 812   }
 813 }
 814
 815 TEST(IPAddress, fromBinaryV4) {
 816   for (auto& tc : provideToLong) {
 817     SCOPED_TRACE(tc.first);
 818     union {
 819       uint8_t u8[4];
 820       uint32_t u32;
 821     } data;
 822     data.u32 = Endian::big(tc.second);
 823     ByteRange bytes(data.u8, 4);
 824
 825     auto fromBin = IPAddressV4::fromBinary(bytes);
 826     IPAddressV4 fromStr(tc.first);
 827     EXPECT_EQ(fromStr, fromBin);
 828
 829     IPAddressV4 addr2("0.0.0.0");
 830     addr2 = IPAddressV4::fromBinary(bytes);
 831     EXPECT_EQ(fromStr, addr2);
 832
 833     IPAddress genericAddr = IPAddress::fromBinary(bytes);
 834     ASSERT_TRUE(genericAddr.isV4());
 835     EXPECT_EQ(fromStr, genericAddr.asV4());
 836     EXPECT_EQ(ByteRange(genericAddr.bytes(), genericAddr.byteCount()), bytes);
 837   }
 838
 839   uint8_t data[20];
 840   EXPECT_THROW(IPAddressV4::fromBinary(ByteRange(data, 3)),
 841                IPAddressFormatException);
 842   EXPECT_THROW(IPAddressV4::fromBinary(ByteRange(data, 16)),
 843                IPAddressFormatException);
 844   EXPECT_THROW(IPAddressV4::fromBinary(ByteRange(data, 20)),
 845                IPAddressFormatException);
 846 }
 847
 848 TEST(IPAddress, toBinaryV4) {
 849   for (auto& tc : provideToLong) {
 850     SCOPED_TRACE(tc.first);
 851     union {
 852       uint8_t u8[4];
 853       uint32_t u32;
 854     } data;
 855     data.u32 = Endian::big(tc.second);
 856     ByteRange bytes(data.u8, 4);
 857
 858     auto fromBin = IPAddressV4::fromBinary(bytes);
 859     auto toBin = fromBin.toBinary();
 860     EXPECT_EQ(bytes, toBin);
 861   }
 862 }
 863
 864 static const vector<pair<string, vector<uint8_t> > > provideBinary16Bytes = {
 865   {"::0",
 866     {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 867      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
 868   {"1::2",
 869     {0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 870      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}},
 871   {"fe80::0012:34ff:fe56:78ab",
 872     {0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 873      0x00, 0x12, 0x34, 0xff, 0xfe, 0x56, 0x78, 0xab}},
 874   {"2001:db8:1234:5678:90ab:cdef:8765:4321",
 875     {0x20, 0x01, 0x0d, 0xb8, 0x12, 0x34, 0x56, 0x78,
 876      0x90, 0xab, 0xcd, 0xef, 0x87, 0x65, 0x43, 0x21}},
 877   {"::ffff:0:c0a8:1",
 878     {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 879      0xff, 0xff, 0x00, 0x00, 0xc0, 0xa8, 0x00, 0x01}},
 880 };
 881
 882 TEST(IPAddress, fromBinaryV6) {
 883   for (auto& tc : provideBinary16Bytes) {
 884     SCOPED_TRACE(tc.first);
 885     ByteRange bytes(&tc.second.front(), tc.second.size());
 886
 887     auto fromBin = IPAddressV6::fromBinary(bytes);
 888     IPAddressV6 fromStr(tc.first);
 889     EXPECT_EQ(fromStr, fromBin);
 890
 891     IPAddressV6 addr2("::0");
 892     addr2 = IPAddressV6::fromBinary(bytes);
 893     EXPECT_EQ(fromStr, addr2);
 894
 895     IPAddress genericAddr = IPAddress::fromBinary(bytes);
 896     ASSERT_TRUE(genericAddr.isV6());
 897     EXPECT_EQ(fromStr, genericAddr.asV6());
 898     EXPECT_EQ(ByteRange(genericAddr.bytes(), genericAddr.byteCount()), bytes);
 899   }
 900
 901   uint8_t data[20];
 902   EXPECT_THROW(IPAddressV6::fromBinary(ByteRange(data, 3)),
 903                IPAddressFormatException);
 904   EXPECT_THROW(IPAddressV6::fromBinary(ByteRange(data, 4)),
 905                IPAddressFormatException);
 906   EXPECT_THROW(IPAddressV6::fromBinary(ByteRange(data, 20)),
 907                IPAddressFormatException);
 908 }
 909
 910 TEST(IPAddress, toBinaryV6) {
 911   for (auto& tc : provideBinary16Bytes) {
 912     SCOPED_TRACE(tc.first);
 913     ByteRange bytes(&tc.second.front(), tc.second.size());
 914
 915     auto fromBin = IPAddressV6::fromBinary(bytes);
 916     auto toBin = fromBin.toBinary();
 917     EXPECT_EQ(bytes, toBin);
 918   }
 919 }
 920
 921 TEST_P(IPAddressFlagTest, IsLoopback) {
 922   AddressFlags param = GetParam();
 923   IPAddress addr(param.address);
 924
 925   EXPECT_EQ(param.version, addr.version());
 926   EXPECT_EQ(param.isLoopback(), addr.isLoopback());
 927 }
 928
 929 TEST_P(IPAddressFlagTest, IsPrivate) {
 930   AddressFlags param = GetParam();
 931   IPAddress addr(param.address);
 932
 933   EXPECT_EQ(param.version, addr.version());
 934   EXPECT_EQ(param.isPrivate(), addr.isPrivate()) << addr;
 935 }
 936
 937 TEST_P(IPAddressFlagTest, IsNonroutable) {
 938   AddressFlags param = GetParam();
 939   IPAddress addr(param.address);
 940
 941   EXPECT_EQ(param.version, addr.version());
 942   EXPECT_EQ(param.isNonroutable(), addr.isNonroutable()) << addr;
 943 }
 944
 945 TEST_P(IPAddressFlagTest, IsZero) {
 946   AddressFlags param = GetParam();
 947   IPAddress addr(param.address);
 948
 949   EXPECT_EQ(param.version, addr.version());
 950   EXPECT_EQ(param.isZero(), addr.isZero()) << addr;
 951 }
 952
 953 TEST_P(IPAddressFlagTest, IsLinkLocal) {
 954   AddressFlags param = GetParam();
 955   IPAddress addr(param.address);
 956   EXPECT_EQ(param.isLinkLocal(), addr.isLinkLocal()) << addr;
 957 }
 958
 959 TEST(IPAddress, CreateLinkLocal) {
 960   IPAddressV6 addr(IPAddressV6::LINK_LOCAL, MacAddress("00:05:73:f9:46:fc"));
 961   EXPECT_EQ(IPAddressV6("fe80::0205:73ff:fef9:46fc"), addr);
 962
 963   addr = IPAddressV6(IPAddressV6::LINK_LOCAL, MacAddress("02:00:00:12:34:56"));
 964   EXPECT_EQ(IPAddressV6("fe80::ff:fe12:3456"), addr);
 965 }
 966
 967 TEST_P(IPAddressFlagTest, IsLinkLocalBroadcast) {
 968   AddressFlags param = GetParam();
 969   IPAddress addr(param.address);
 970   EXPECT_EQ(param.version, addr.version());
 971   EXPECT_EQ(param.isLinkLocalBroadcast(), addr.isLinkLocalBroadcast());
 972 }
 973
 974 TEST(IPAddress, SolicitedNodeAddress) {
 975   // An example from RFC 4291 section 2.7.1
 976   EXPECT_EQ(IPAddressV6("ff02::1:ff0e:8c6c"),
 977             IPAddressV6("4037::01:800:200e:8c6c").getSolicitedNodeAddress());
 978
 979   // An example from wikipedia
 980   // (http://en.wikipedia.org/wiki/Solicited-node_multicast_address)
 981   EXPECT_EQ(IPAddressV6("ff02::1:ff28:9c5a"),
 982             IPAddressV6("fe80::2aa:ff:fe28:9c5a").getSolicitedNodeAddress());
 983 }
 984
 985 TEST_P(IPAddressByteAccessorTest, CheckBytes) {
 986   auto addrData = GetParam();
 987   IPAddress ip(addrData.address);
 988   size_t i = 0;
 989   for (auto byitr = addrData.bytes.begin(); i < ip.byteCount(); ++i, ++byitr) {
 990     EXPECT_EQ(*byitr, ip.getNthMSByte(i));
 991     EXPECT_EQ(*byitr, ip.isV4() ?
 992           ip.asV4().getNthMSByte(i) : ip.asV6().getNthMSByte(i));
 993   }
 994   i = 0;
 995   for (auto byritr = addrData.bytes.rbegin(); i < ip.byteCount(); ++i,
 996       ++byritr) {
 997     EXPECT_EQ(*byritr, ip.getNthLSByte(i));
 998     EXPECT_EQ(*byritr, ip.isV4() ?
 999         ip.asV4().getNthLSByte(i) : ip.asV6().getNthLSByte(i));
1000   }
1001 }
1002
1003 TEST_P(IPAddressBitAccessorTest, CheckBits) {
1004   auto addrData = GetParam();
1005   auto littleEndianAddrData = addrData.bytes;
1006   //IPAddress stores address data in n/w byte order.
1007   reverse(littleEndianAddrData.begin(), littleEndianAddrData.end());
1008   //Bit iterator goes from LSBit to MSBit
1009   //We will traverse the IPAddress bits from 0 to bitCount -1
1010   auto bitr = folly::makeBitIterator(littleEndianAddrData.begin());
1011   IPAddress ip(addrData.address);
1012   for (size_t i = 0; i < ip.bitCount(); ++i) {
1013     auto msbIndex = ip.bitCount() - i - 1;
1014     EXPECT_EQ(*bitr, ip.getNthMSBit(msbIndex));
1015     EXPECT_EQ(*bitr, ip.isV4() ? ip.asV4().getNthMSBit(msbIndex) :
1016           ip.asV6().getNthMSBit(msbIndex));
1017     EXPECT_EQ(*bitr, ip.getNthLSBit(i));
1018     EXPECT_EQ(*bitr, ip.isV4() ? ip.asV4().getNthLSBit(i) :
1019         ip.asV6().getNthLSBit(i));
1020     ++bitr;
1021   }
1022 }
1023
1024 TEST(IPAddress, InvalidByteAccess) {
1025   IPAddress ip4("10.10.10.10");
1026   //MSByte, LSByte accessors are 0 indexed
1027   EXPECT_THROW(ip4.getNthMSByte(ip4.byteCount()), std::invalid_argument);
1028   EXPECT_THROW(ip4.getNthLSByte(ip4.byteCount()), std::invalid_argument);
1029   EXPECT_THROW(ip4.getNthMSByte(-1), std::invalid_argument);
1030   EXPECT_THROW(ip4.getNthLSByte(-1), std::invalid_argument);
1031   auto asV4 = ip4.asV4();
1032   EXPECT_THROW(asV4.getNthMSByte(asV4.byteCount()), std::invalid_argument);
1033   EXPECT_THROW(asV4.getNthLSByte(asV4.byteCount()), std::invalid_argument);
1034   EXPECT_THROW(asV4.getNthMSByte(-1), std::invalid_argument);
1035   EXPECT_THROW(asV4.getNthLSByte(-1), std::invalid_argument);
1036
1037   IPAddress ip6("2620:0:1cfe:face:b00c::3");
1038   EXPECT_THROW(ip6.getNthMSByte(ip6.byteCount()), std::invalid_argument);
1039   EXPECT_THROW(ip6.getNthLSByte(ip6.byteCount()), std::invalid_argument);
1040   EXPECT_THROW(ip6.getNthMSByte(-1), std::invalid_argument);
1041   EXPECT_THROW(ip6.getNthLSByte(-1), std::invalid_argument);
1042   auto asV6 = ip6.asV6();
1043   EXPECT_THROW(asV6.getNthMSByte(asV6.byteCount()), std::invalid_argument);
1044   EXPECT_THROW(asV6.getNthLSByte(asV6.byteCount()), std::invalid_argument);
1045   EXPECT_THROW(asV6.getNthMSByte(-1), std::invalid_argument);
1046   EXPECT_THROW(asV6.getNthLSByte(-1), std::invalid_argument);
1047
1048 }
1049
1050 TEST(IPAddress, InvalidBBitAccess) {
1051   IPAddress ip4("10.10.10.10");
1052   //MSByte, LSByte accessors are 0 indexed
1053   EXPECT_THROW(ip4.getNthMSBit(ip4.bitCount()), std::invalid_argument);
1054   EXPECT_THROW(ip4.getNthLSBit(ip4.bitCount()), std::invalid_argument);
1055   EXPECT_THROW(ip4.getNthMSBit(-1), std::invalid_argument);
1056   EXPECT_THROW(ip4.getNthLSBit(-1), std::invalid_argument);
1057   auto asV4 = ip4.asV4();
1058   EXPECT_THROW(asV4.getNthMSBit(asV4.bitCount()), std::invalid_argument);
1059   EXPECT_THROW(asV4.getNthLSBit(asV4.bitCount()), std::invalid_argument);
1060   EXPECT_THROW(asV4.getNthMSBit(-1), std::invalid_argument);
1061   EXPECT_THROW(asV4.getNthLSBit(-1), std::invalid_argument);
1062
1063   IPAddress ip6("2620:0:1cfe:face:b00c::3");
1064   EXPECT_THROW(ip6.getNthMSBit(ip6.bitCount()), std::invalid_argument);
1065   EXPECT_THROW(ip6.getNthLSBit(ip6.bitCount()), std::invalid_argument);
1066   EXPECT_THROW(ip6.getNthMSBit(-1), std::invalid_argument);
1067   EXPECT_THROW(ip6.getNthLSBit(-1), std::invalid_argument);
1068   auto asV6 = ip6.asV6();
1069   EXPECT_THROW(asV6.getNthMSBit(asV6.bitCount()), std::invalid_argument);
1070   EXPECT_THROW(asV6.getNthLSBit(asV6.bitCount()), std::invalid_argument);
1071   EXPECT_THROW(asV6.getNthMSBit(-1), std::invalid_argument);
1072   EXPECT_THROW(asV6.getNthLSBit(-1), std::invalid_argument);
1073 }
1074
1075 TEST(IPAddress, StringFormat) {
1076   in6_addr a6;
1077   for (int i = 0; i < 8; ++i) {
1078     auto t = htons(0x0123 + ((i % 4) * 0x4444));
1079 #ifdef _WIN32
1080     a6.u.Word[i] = t;
1081 #else
1082     a6.s6_addr16[i] = t;
1083 #endif
1084   }
1085   EXPECT_EQ("0123:4567:89ab:cdef:0123:4567:89ab:cdef",
1086             detail::fastIpv6ToString(a6));
1087
1088   in_addr a4;
1089   a4.s_addr = htonl(0x01020304);
1090   EXPECT_EQ("1.2.3.4", detail::fastIpv4ToString(a4));
1091 }
1092
1093 TEST(IPAddress, getMacAddressFromLinkLocal) {
1094   IPAddressV6 ip6("fe80::f652:14ff:fec5:74d8");
1095   EXPECT_TRUE(ip6.getMacAddressFromLinkLocal().hasValue());
1096   EXPECT_EQ("f4:52:14:c5:74:d8", ip6.getMacAddressFromLinkLocal()->toString());
1097 }
1098
1099 TEST(IPAddress, getMacAddressFromLinkLocal_Negative) {
1100   IPAddressV6 no_link_local_ip6("2803:6082:a2:4447::1");
1101   EXPECT_FALSE(no_link_local_ip6.getMacAddressFromLinkLocal().hasValue());
1102   no_link_local_ip6 = IPAddressV6("fe80::f652:14ff:ccc5:74d8");
1103   EXPECT_FALSE(no_link_local_ip6.getMacAddressFromLinkLocal().hasValue());
1104   no_link_local_ip6 = IPAddressV6("fe80::f652:14ff:ffc5:74d8");
1105   EXPECT_FALSE(no_link_local_ip6.getMacAddressFromLinkLocal().hasValue());
1106   no_link_local_ip6 = IPAddressV6("fe81::f652:14ff:ffc5:74d8");
1107   EXPECT_FALSE(no_link_local_ip6.getMacAddressFromLinkLocal().hasValue());
1108 }
1109
1110 TEST(IPAddress, LongestCommonPrefix) {
1111   IPAddress ip10("10.0.0.0");
1112   IPAddress ip11("11.0.0.0");
1113   IPAddress ip12("12.0.0.0");
1114   IPAddress ip128("128.0.0.0");
1115   IPAddress ip10dot10("10.10.0.0");
1116   auto prefix = IPAddress::longestCommonPrefix({ip10, 8}, {ip128, 8});
1117   auto prefix4 = IPAddressV4::longestCommonPrefix({ip10.asV4(), 8},
1118                                                   {ip128.asV4(), 8});
1119   // No bits match b/w 128/8 and 10/8
1120   EXPECT_EQ(IPAddress("0.0.0.0"), prefix.first);
1121   EXPECT_EQ(0, prefix.second);
1122   EXPECT_EQ(IPAddressV4("0.0.0.0"), prefix4.first);
1123   EXPECT_EQ(0, prefix4.second);
1124
1125   prefix = IPAddress::longestCommonPrefix({ip10, 8}, {ip10dot10, 16});
1126   prefix4 = IPAddressV4::longestCommonPrefix({ip10.asV4(), 8},
1127                                              {ip10dot10.asV4(), 16});
1128   // Between 10/8 and 10.10/16, 10/8 is the longest common match
1129   EXPECT_EQ(ip10, prefix.first);
1130   EXPECT_EQ(8, prefix.second);
1131   EXPECT_EQ(ip10.asV4(), prefix4.first);
1132   EXPECT_EQ(8, prefix4.second);
1133
1134   prefix = IPAddress::longestCommonPrefix({ip11, 8}, {ip12, 8});
1135   prefix4 = IPAddressV4::longestCommonPrefix({ip11.asV4(), 8},
1136                                              {ip12.asV4(), 8});
1137   // 12 = 1100, 11 = 1011, longest match - 1000 = 8
1138   EXPECT_EQ(IPAddress("8.0.0.0"), prefix.first);
1139   EXPECT_EQ(5, prefix.second);
1140   EXPECT_EQ(IPAddressV4("8.0.0.0"), prefix4.first);
1141   EXPECT_EQ(5, prefix4.second);
1142
1143   // Between 128/1 and 128/2, longest match 128/1
1144   prefix = IPAddress::longestCommonPrefix({ip128, 1}, {ip128, 2});
1145   prefix4 = IPAddressV4::longestCommonPrefix({ip128.asV4(), 1},
1146                                              {ip128.asV4(), 2});
1147   EXPECT_EQ(ip128, prefix.first);
1148   EXPECT_EQ(1, prefix.second);
1149   EXPECT_EQ(ip128.asV4(), prefix4.first);
1150   EXPECT_EQ(1, prefix4.second);
1151
1152   IPAddress ip6("2620:0:1cfe:face:b00c::3");
1153   prefix = IPAddress::longestCommonPrefix({ip6, ip6.bitCount()},
1154                                           {ip6, ip6.bitCount()});
1155   auto prefix6 = IPAddressV6::longestCommonPrefix(
1156     {ip6.asV6(), IPAddressV6::bitCount()},
1157     {ip6.asV6(), IPAddressV6::bitCount()});
1158   // Longest common b/w me and myself is myself
1159   EXPECT_EQ(ip6, prefix.first);
1160   EXPECT_EQ(ip6.bitCount(), prefix.second);
1161   EXPECT_EQ(ip6.asV6(), prefix6.first);
1162   EXPECT_EQ(ip6.asV6().bitCount(), prefix6.second);
1163
1164   IPAddress ip6Zero("::");
1165   prefix = IPAddress::longestCommonPrefix({ip6, ip6.bitCount()}, {ip6Zero, 0});
1166   prefix6 = IPAddressV6::longestCommonPrefix(
1167     {ip6.asV6(), IPAddressV6::bitCount()},
1168     {ip6Zero.asV6(), 0});
1169   // Longest common b/w :: (ipv6 equivalent of 0/0) is ::
1170   EXPECT_EQ(ip6Zero, prefix.first);
1171   EXPECT_EQ(0, prefix.second);
1172
1173   // Exceptional cases
1174   EXPECT_THROW(IPAddress::longestCommonPrefix({ip10, 8}, {ip6, 128}),
1175                std::invalid_argument);
1176   EXPECT_THROW(IPAddress::longestCommonPrefix({ip10, ip10.bitCount() + 1},
1177                                               {ip10, 8}),
1178                std::invalid_argument);
1179   EXPECT_THROW(IPAddressV4::longestCommonPrefix(
1180                  {ip10.asV4(), IPAddressV4::bitCount() + 1},
1181                  {ip10.asV4(), 8}),
1182                std::invalid_argument);
1183   EXPECT_THROW(IPAddress::longestCommonPrefix({ip6, ip6.bitCount() + 1},
1184                                               {ip6, ip6.bitCount()}),
1185                std::invalid_argument);
1186   EXPECT_THROW(IPAddressV6::longestCommonPrefix(
1187                  {ip6.asV6(), IPAddressV6::bitCount() + 1},
1188                  {ip6.asV6(), IPAddressV6::bitCount()}),
1189                std::invalid_argument);
1190
1191 }
1192
1193 static const vector<AddressData> validAddressProvider = {
1194   AddressData("127.0.0.1", {127,0,0,1}, 4),
1195   AddressData("69.63.189.16", {69,63,189,16}, 4),
1196   AddressData("0.0.0.0", {0,0,0,0}, 4),
1197   AddressData("::1",
1198               {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1}, 6),
1199   AddressData("2620:0:1cfe:face:b00c::3",
1200               {38,32,0,0,28,254,250,206,176,12,0,0,0,0,0,3}, 6),
1201 };
1202
1203 static const vector<string> invalidAddressProvider = {
1204   "",
1205   "foo",
1206   "1.1.1.256",
1207   "1",
1208   ":1",
1209   "127.0.0.1,127.0.0.1",
1210   "[1234]",
1211 };
1212
1213 static const vector<ByteVector> invalidBinaryProvider = {
1214   {0x31, 0x32, 0x37, 0x2e, 0x30, 0x30, 0x2e, 0x30, 0x2e, 0x31},
1215   // foo
1216   {0x66, 0x6f, 0x6f},
1217   {0x00},
1218   {0x00, 0x00},
1219   {0x00, 0x00, 0x00},
1220   {0x00, 0x00, 0x00, 0x00, 0x00},
1221   {0xff},
1222 };
1223
1224 static const uint8_t IS_LOCAL = AddressFlags::IS_LOCAL;
1225 static const uint8_t IS_NONROUTABLE = AddressFlags::IS_NONROUTABLE;
1226 static const uint8_t IS_PRIVATE = AddressFlags::IS_PRIVATE;
1227 static const uint8_t IS_ZERO = AddressFlags::IS_ZERO;
1228 static const uint8_t IS_LINK_LOCAL =
1229   AddressFlags::IS_LINK_LOCAL | IS_NONROUTABLE;
1230 static const uint8_t IS_PVT_NONROUTE = IS_NONROUTABLE | IS_PRIVATE;
1231 static const uint8_t IS_MULTICAST = AddressFlags::IS_MULTICAST;
1232 static const uint8_t IS_LINK_LOCAL_BROADCAST =
1233 AddressFlags::IS_LINK_LOCAL_BROADCAST;
1234
1235 static vector<AddressFlags> flagProvider = {
1236   // public v4
1237   AddressFlags("69.63.176.1", 4, 0),
1238   AddressFlags("128.12.65.3", 4, 0),
1239   AddressFlags("192.0.1.0", 4, 0),
1240   AddressFlags("198.51.101.0", 4, 0),
1241   AddressFlags("203.0.114.0", 4, 0),
1242   AddressFlags("128.12.64.115", 4, 0),
1243
1244   // public v6
1245   AddressFlags("2620:0:1cfe:face:b00c::3", 6, 0),
1246
1247   // localhost
1248   AddressFlags("127.0.0.1", 4, IS_LOCAL | IS_PVT_NONROUTE),
1249   AddressFlags("::1", 6, IS_LOCAL | IS_PVT_NONROUTE),
1250
1251   // link-local v4
1252   AddressFlags("169.254.0.1", 4, IS_LINK_LOCAL | IS_PVT_NONROUTE),
1253
1254   // private v4
1255   AddressFlags("10.0.0.0", 4, IS_PVT_NONROUTE),
1256   AddressFlags("10.11.12.13", 4, IS_PVT_NONROUTE),
1257   AddressFlags("10.255.255.255", 4, IS_PVT_NONROUTE),
1258   AddressFlags("127.128.129.200", 4, IS_LOCAL | IS_PVT_NONROUTE),
1259   AddressFlags("127.255.255.255", 4, IS_LOCAL | IS_PVT_NONROUTE),
1260   AddressFlags("169.254.0.0", 4, IS_LINK_LOCAL | IS_PVT_NONROUTE),
1261   AddressFlags("192.168.0.0", 4, IS_PVT_NONROUTE),
1262   AddressFlags("192.168.200.255", 4, IS_PVT_NONROUTE),
1263   AddressFlags("192.168.255.255", 4, IS_PVT_NONROUTE),
1264
1265   // private v6
1266   AddressFlags("fd01:1637:1c56:66af::", 6, IS_PVT_NONROUTE),
1267
1268   // non routable v4
1269   AddressFlags("0.0.0.0", 4, IS_NONROUTABLE | IS_ZERO),
1270   AddressFlags("0.255.255.255", 4, IS_NONROUTABLE),
1271   AddressFlags("192.0.0.0", 4, IS_NONROUTABLE),
1272   AddressFlags("192.0.2.0", 4, IS_NONROUTABLE),
1273   AddressFlags("198.18.0.0", 4, IS_NONROUTABLE),
1274   AddressFlags("198.19.255.255", 4, IS_NONROUTABLE),
1275   AddressFlags("198.51.100.0", 4, IS_NONROUTABLE),
1276   AddressFlags("198.51.100.255", 4, IS_NONROUTABLE),
1277   AddressFlags("203.0.113.0", 4, IS_NONROUTABLE),
1278   AddressFlags("203.0.113.255", 4, IS_NONROUTABLE),
1279   AddressFlags("224.0.0.0", 4, IS_NONROUTABLE | IS_MULTICAST),
1280   AddressFlags("240.0.0.0", 4, IS_NONROUTABLE),
1281   AddressFlags("224.0.0.0", 4, IS_NONROUTABLE),
1282   // v4 link local broadcast
1283   AddressFlags("255.255.255.255", 4, IS_NONROUTABLE | IS_LINK_LOCAL_BROADCAST),
1284
1285   // non routable v6
1286   AddressFlags("1999::1", 6, IS_NONROUTABLE),
1287   AddressFlags("0::0", 6, IS_NONROUTABLE | IS_ZERO),
1288   AddressFlags("0::0:0", 6, IS_NONROUTABLE | IS_ZERO),
1289   AddressFlags("0:0:0::0", 6, IS_NONROUTABLE | IS_ZERO),
1290
1291   // link-local v6
1292   AddressFlags("fe80::0205:73ff:fef9:46fc", 6, IS_LINK_LOCAL),
1293   AddressFlags("fe80::0012:34ff:fe56:7890", 6, IS_LINK_LOCAL),
1294
1295   // multicast v4
1296   AddressFlags("224.0.0.1", 4, IS_MULTICAST | IS_NONROUTABLE) ,
1297   AddressFlags("224.0.0.251", 4, IS_MULTICAST | IS_NONROUTABLE),
1298   AddressFlags("239.12.34.56", 4, IS_MULTICAST | IS_NONROUTABLE),
1299
1300   // multicast v6
1301   AddressFlags("ff00::", 6, IS_MULTICAST | IS_NONROUTABLE),
1302   AddressFlags("ff02:ffff::1", 6, IS_MULTICAST | IS_NONROUTABLE),
1303   AddressFlags("ff02::101", 6, IS_MULTICAST | IS_NONROUTABLE),
1304   AddressFlags("ff0e::101", 6, IS_MULTICAST),
1305   // v6 link local broadcast
1306   AddressFlags("ff02::1", 6, IS_NONROUTABLE | IS_LINK_LOCAL_BROADCAST),
1307 };
1308
1309 static const vector<pair<string, string> > mapProvider = {
1310   {"::ffff:192.0.2.128", "192.0.2.128"},
1311   {"192.0.2.128", "::ffff:192.0.2.128"},
1312   {"::FFFF:129.144.52.38", "129.144.52.38"},
1313   {"129.144.52.38", "::FFFF:129.144.52.38"},
1314   {"0:0:0:0:0:FFFF:222.1.41.90", "222.1.41.90"},
1315   {"::FFFF:222.1.41.90", "222.1.41.90"},
1316 };
1317
1318 static const vector<MaskData> masksProvider = {
1319   MaskData("255.255.255.255", 1, "128.0.0.0"),
1320   MaskData("255.255.255.255", 2, "192.0.0.0"),
1321   MaskData("192.0.2.42", 16, "192.0.0.0"),
1322   MaskData("255.255.255.255", 24, "255.255.255.0"),
1323   MaskData("255.255.255.255", 32, "255.255.255.255"),
1324   MaskData("10.10.10.10", 0, "0.0.0.0"),
1325   MaskData("::1", 64, "::"),
1326   MaskData("2620:0:1cfe:face:b00c::3", 1, "::"),
1327   MaskData("2620:0:1cfe:face:b00c::3", 3, "2000::"),
1328   MaskData("2620:0:1cfe:face:b00c::3", 6, "2400::"),
1329   MaskData("2620:0:1cfe:face:b00c::3", 7, "2600::"),
1330   MaskData("2620:0:1cfe:face:b00c::3", 11, "2620::"),
1331   MaskData("2620:0:1cfe:face:b00c::3", 36, "2620:0:1000::"),
1332   MaskData("2620:0:1cfe:face:b00c::3", 37, "2620:0:1800::"),
1333   MaskData("2620:0:1cfe:face:b00c::3", 38, "2620:0:1c00::"),
1334   MaskData("2620:0:1cfe:face:b00c::3", 41, "2620:0:1c80::"),
1335   MaskData("2620:0:1cfe:face:b00c::3", 42, "2620:0:1cc0::"),
1336   MaskData("2620:0:1cfe:face:b00c::3", 43, "2620:0:1ce0::"),
1337   MaskData("2620:0:1cfe:face:b00c::3", 44, "2620:0:1cf0::"),
1338   MaskData("2620:0:1cfe:face:b00c::3", 45, "2620:0:1cf8::"),
1339   MaskData("2620:0:1cfe:face:b00c::3", 46, "2620:0:1cfc::"),
1340   MaskData("2620:0:1cfe:face:b00c::3", 47, "2620:0:1cfe::"),
1341   MaskData("2620:0:1cfe:face:b00c::3", 49, "2620:0:1cfe:8000::"),
1342   MaskData("2620:0:1cfe:face:b00c::3", 50, "2620:0:1cfe:c000::"),
1343   MaskData("2620:0:1cfe:face:b00c::3", 51, "2620:0:1cfe:e000::"),
1344   MaskData("2620:0:1cfe:face:b00c::3", 52, "2620:0:1cfe:f000::"),
1345   MaskData("2620:0:1cfe:face:b00c::3", 53, "2620:0:1cfe:f800::"),
1346   MaskData("2620:0:1cfe:face:b00c::3", 55, "2620:0:1cfe:fa00::"),
1347   MaskData("2620:0:1cfe:face:b00c::3", 57, "2620:0:1cfe:fa80::"),
1348   MaskData("2620:0:1cfe:face:b00c::3", 58, "2620:0:1cfe:fac0::"),
1349   MaskData("2620:0:1cfe:face:b00c::3", 61, "2620:0:1cfe:fac8::"),
1350   MaskData("2620:0:1cfe:face:b00c::3", 62, "2620:0:1cfe:facc::"),
1351   MaskData("2620:0:1cfe:face:b00c::3", 63, "2620:0:1cfe:face::"),
1352   MaskData("2620:0:1cfe:face:b00c::3", 65, "2620:0:1cfe:face:8000::"),
1353   MaskData("2620:0:1cfe:face:b00c::3", 67, "2620:0:1cfe:face:a000::"),
1354   MaskData("2620:0:1cfe:face:b00c::3", 68, "2620:0:1cfe:face:b000::"),
1355   MaskData("2620:0:1cfe:face:b00c::3", 77, "2620:0:1cfe:face:b008::"),
1356   MaskData("2620:0:1cfe:face:b00c::3", 78, "2620:0:1cfe:face:b00c::"),
1357   MaskData("2620:0:1cfe:face:b00c::3", 127, "2620:0:1cfe:face:b00c::2"),
1358   MaskData("2620:0:1cfe:face:b00c::3", 128, "2620:0:1cfe:face:b00c::3"),
1359   MaskData("2620:0:1cfe:face:b00c::3", 0, "::")
1360 };
1361
1362 static const vector<MaskBoundaryData> maskBoundaryProvider = {
1363   MaskBoundaryData("10.1.1.1", 24, "10.1.1.1", true),
1364   MaskBoundaryData("10.1.1.1", 8, "10.1.2.3", true),
1365   MaskBoundaryData("2620:0:1cfe:face:b00c::1", 48, "2620:0:1cfe::", true),
1366   // addresses that are NOT in the same subnet once mask is applied
1367   MaskBoundaryData("10.1.1.1", 24, "10.1.2.1", false),
1368   MaskBoundaryData("10.1.1.1", 16, "10.2.3.4", false),
1369   MaskBoundaryData("2620:0:1cfe:face:b00c::1", 48, "2620:0:1cfc::", false),
1370 };
1371
1372 INSTANTIATE_TEST_CASE_P(IPAddress,
1373                         IPAddressTest,
1374                         ::testing::ValuesIn(validAddressProvider));
1375 INSTANTIATE_TEST_CASE_P(IPAddress,
1376                         IPAddressFlagTest,
1377                         ::testing::ValuesIn(flagProvider));
1378 INSTANTIATE_TEST_CASE_P(IPAddress,
1379                         IPAddressMappedTest,
1380                         ::testing::ValuesIn(mapProvider));
1381 INSTANTIATE_TEST_CASE_P(IPAddress,
1382                         IPAddressCtorTest,
1383                         ::testing::ValuesIn(invalidAddressProvider));
1384 INSTANTIATE_TEST_CASE_P(IPAddress,
1385                         IPAddressCtorBinaryTest,
1386                         ::testing::ValuesIn(invalidBinaryProvider));
1387 INSTANTIATE_TEST_CASE_P(IPAddress,
1388                         IPAddressMaskTest,
1389                         ::testing::ValuesIn(masksProvider));
1390 INSTANTIATE_TEST_CASE_P(IPAddress,
1391                         IPAddressMaskBoundaryTest,
1392                         ::testing::ValuesIn(maskBoundaryProvider));
1393 INSTANTIATE_TEST_CASE_P(IPAddress,
1394                         IPAddressByteAccessorTest,
1395                         ::testing::ValuesIn(validAddressProvider));
1396 INSTANTIATE_TEST_CASE_P(IPAddress,
1397                         IPAddressBitAccessorTest,
1398                         ::testing::ValuesIn(validAddressProvider));
1399
1400 TEST(IPAddressV4, fetchMask) {
1401   struct X : private IPAddressV4 {
1402     using IPAddressV4::fetchMask;
1403   };
1404
1405   EXPECT_THAT(
1406       X::fetchMask(0),
1407       ::testing::ElementsAreArray(ByteArray4{{0x00, 0x00, 0x00, 0x00}}));
1408
1409   EXPECT_THAT(
1410       X::fetchMask(1),
1411       ::testing::ElementsAreArray(ByteArray4{{0x80, 0x00, 0x00, 0x00}}));
1412
1413   EXPECT_THAT(
1414       X::fetchMask(31),
1415       ::testing::ElementsAreArray(ByteArray4{{0xff, 0xff, 0xff, 0xfe}}));
1416
1417   EXPECT_THAT(
1418       X::fetchMask(32),
1419       ::testing::ElementsAreArray(ByteArray4{{0xff, 0xff, 0xff, 0xff}}));
1420 }
1421
1422 TEST(IPAddressV6, fetchMask) {
1423   using ByteArray8 = std::array<uint8_t, 8>;
1424
1425   struct X : private IPAddressV6 {
1426     using IPAddressV6::fetchMask;
1427   };
1428
1429   auto join = [](std::array<ByteArray8, 2> parts) {
1430     ByteArray16 _return;
1431     std::memcpy(_return.data(), parts.data(), _return.size());
1432     return _return;
1433   };
1434
1435   EXPECT_THAT(
1436       X::fetchMask(0),
1437       ::testing::ElementsAreArray(join({{
1438           ByteArray8{{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
1439           ByteArray8{{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
1440       }})));
1441
1442   EXPECT_THAT(
1443       X::fetchMask(1),
1444       ::testing::ElementsAreArray(join({{
1445           ByteArray8{{0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
1446           ByteArray8{{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
1447       }})));
1448
1449   EXPECT_THAT(
1450       X::fetchMask(63),
1451       ::testing::ElementsAreArray(join({{
1452           ByteArray8{{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfe}},
1453           ByteArray8{{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
1454       }})));
1455
1456   EXPECT_THAT(
1457       X::fetchMask(64),
1458       ::testing::ElementsAreArray(join({{
1459           ByteArray8{{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}},
1460           ByteArray8{{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
1461       }})));
1462
1463   EXPECT_THAT(
1464       X::fetchMask(65),
1465       ::testing::ElementsAreArray(join({{
1466           ByteArray8{{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}},
1467           ByteArray8{{0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
1468       }})));
1469
1470   EXPECT_THAT(
1471       X::fetchMask(127),
1472       ::testing::ElementsAreArray(join({{
1473           ByteArray8{{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}},
1474           ByteArray8{{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfe}},
1475       }})));
1476
1477   EXPECT_THAT(
1478       X::fetchMask(128),
1479       ::testing::ElementsAreArray(join({{
1480           ByteArray8{{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}},
1481           ByteArray8{{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}},
1482       }})));
1483 }