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