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