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