folly/test/IPAddressTest.cpp

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