folly/test/IPAddressTest.cpp

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