salt/tests/utils/test_ipaddress.py

"""
Python 2.[67] port of Python 3.4's test_ipaddress.

Almost verbatim copy of core lib w/compatibility fixes
"""
# pylint: skip-file

# List of compatibility changes:

# This backport uses bytearray instead of bytes, as bytes is the same
# as str in Python 2.7.
# bytes = bytearray
# s/\(b'[^']\+'\)/bytearray(\1)/g
# plus manual fixes for implicit string concatenation.

# Python 3.4 has assertRaisesRegex where Python 2.7 only has assertRaisesRegexp.
# s/\.assertRaisesRegexp(/.assertRaisesRegexp(/

# Python 2.6 carries assertRaisesRegexp and others in unittest2

# Python 2.6 wants unicode into bytes.fromhex
# s/bytes.fromhex\("/bytes.fromhex(u"/g

# Further compatibility changes are marked "Compatibility", below.

# ----------------------------------------------------------------------------


# Copyright 2007 Google Inc.
#  Licensed to PSF under a Contributor Agreement.

"""Unittest for ipaddress module."""

import contextlib
import operator

# Import python libs
import re
import sys

# Import salt libs
from salt._compat import ipaddress

# Import salt test libs
from tests.support.unit import TestCase, skipIf

if sys.version_info < (3,):
    bytes = bytearray


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class BaseTestCase(TestCase):
    # One big change in ipaddress over the original ipaddr module is
    # error reporting that tries to assume users *don't know the rules*
    # for what constitutes an RFC compliant IP address

    # Ensuring these errors are emitted correctly in all relevant cases
    # meant moving to a more systematic test structure that allows the
    # test structure to map more directly to the module structure

    # Note that if the constructors are refactored so that addresses with
    # multiple problems get classified differently, that's OK - just
    # move the affected examples to the newly appropriate test case.

    # There is some duplication between the original relatively ad hoc
    # test suite and the new systematic tests. While some redundancy in
    # testing is considered preferable to accidentally deleting a valid
    # test, the original test suite will likely be reduced over time as
    # redundant tests are identified.

    @property
    def factory(self):
        raise NotImplementedError

    @contextlib.contextmanager
    def assertCleanError(self, exc_type, details, *args):
        """
        Ensure exception does not display a context by default

        Wraps TestCase.assertRaisesRegex
        """
        if args:
            details = details % args
        cm = self.assertRaisesRegex(exc_type, details)
        with cm as exc:
            yield exc

        # Compatibility: Python 2.7 does not support exception chaining
        ## Ensure we produce clean tracebacks on failure
        # if exc.exception.__context__ is not None:
        #    self.assertTrue(exc.exception.__suppress_context__)

    def assertAddressError(self, details, *args):
        """Ensure a clean AddressValueError"""
        return self.assertCleanError(ipaddress.AddressValueError, details, *args)

    def assertNetmaskError(self, details, *args):
        """Ensure a clean NetmaskValueError"""
        return self.assertCleanError(ipaddress.NetmaskValueError, details, *args)

    def assertInstancesEqual(self, lhs, rhs):
        """Check constructor arguments produce equivalent instances"""
        self.assertEqual(self.factory(lhs), self.factory(rhs))


class CommonTestMixin:
    def test_empty_address(self):
        with self.assertAddressError("Address cannot be empty"):
            self.factory("")

    def test_floats_rejected(self):
        with self.assertAddressError(re.escape(repr("1.0"))):
            self.factory(1.0)

    def test_not_an_index_issue15559(self):
        # Implementing __index__ makes for a very nasty interaction with the
        # bytes constructor. Thus, we disallow implicit use as an integer
        self.assertRaises(TypeError, operator.index, self.factory(1))
        self.assertRaises(TypeError, hex, self.factory(1))
        self.assertRaises(TypeError, bytes, self.factory(1))


class CommonTestMixin_v4(CommonTestMixin):
    def test_leading_zeros(self):
        self.assertInstancesEqual("000.000.000.000", "0.0.0.0")
        self.assertInstancesEqual("192.168.000.001", "192.168.0.1")

    def test_int(self):
        self.assertInstancesEqual(0, "0.0.0.0")
        self.assertInstancesEqual(3232235521, "192.168.0.1")

    def test_packed(self):
        self.assertInstancesEqual(bytes.fromhex(u"00000000"), "0.0.0.0")
        self.assertInstancesEqual(bytes.fromhex(u"c0a80001"), "192.168.0.1")

    def test_negative_ints_rejected(self):
        msg = "-1 (< 0) is not permitted as an IPv4 address"
        with self.assertAddressError(re.escape(msg)):
            self.factory(-1)

    def test_large_ints_rejected(self):
        msg = "%d (>= 2**32) is not permitted as an IPv4 address"
        with self.assertAddressError(re.escape(msg % 2 ** 32)):
            self.factory(2 ** 32)

    def test_bad_packed_length(self):
        def assertBadLength(length):
            addr = bytes(length)
            msg = "%r (len %d != 4) is not permitted as an IPv4 address"
            with self.assertAddressError(re.escape(msg % (addr, length))):
                self.factory(addr)

        assertBadLength(3)
        assertBadLength(5)


class CommonTestMixin_v6(CommonTestMixin):
    def test_leading_zeros(self):
        self.assertInstancesEqual("0000::0000", "::")
        self.assertInstancesEqual("000::c0a8:0001", "::c0a8:1")

    def test_int(self):
        self.assertInstancesEqual(0, "::")
        self.assertInstancesEqual(3232235521, "::c0a8:1")

    def test_packed(self):
        addr = bytes(12) + bytes.fromhex(u"00000000")
        self.assertInstancesEqual(addr, "::")
        addr = bytes(12) + bytes.fromhex(u"c0a80001")
        self.assertInstancesEqual(addr, "::c0a8:1")
        addr = bytes.fromhex(u"c0a80001") + bytes(12)
        self.assertInstancesEqual(addr, "c0a8:1::")

    def test_negative_ints_rejected(self):
        msg = "-1 (< 0) is not permitted as an IPv6 address"
        with self.assertAddressError(re.escape(msg)):
            self.factory(-1)

    def test_large_ints_rejected(self):
        msg = "%d (>= 2**128) is not permitted as an IPv6 address"
        with self.assertAddressError(re.escape(msg % 2 ** 128)):
            self.factory(2 ** 128)

    def test_bad_packed_length(self):
        def assertBadLength(length):
            addr = bytes(length)
            msg = "%r (len %d != 16) is not permitted as an IPv6 address"
            with self.assertAddressError(re.escape(msg % (addr, length))):
                self.factory(addr)
                self.factory(addr)

        assertBadLength(15)
        assertBadLength(17)


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class AddressTestCase_v4(BaseTestCase, CommonTestMixin_v4):
    factory = ipaddress.IPv4Address

    def test_network_passed_as_address(self):
        addr = "127.0.0.1/24"
        with self.assertAddressError("Unexpected '/' in %r", addr):
            ipaddress.IPv4Address(addr)

    def test_bad_address_split(self):
        def assertBadSplit(addr):
            with self.assertAddressError("Expected 4 octets in %r", addr):
                ipaddress.IPv4Address(addr)

        assertBadSplit("127.0.1")
        assertBadSplit("42.42.42.42.42")
        assertBadSplit("42.42.42")
        assertBadSplit("42.42")
        assertBadSplit("42")
        assertBadSplit("42..42.42.42")
        assertBadSplit("42.42.42.42.")
        assertBadSplit("42.42.42.42...")
        assertBadSplit(".42.42.42.42")
        assertBadSplit("...42.42.42.42")
        assertBadSplit("016.016.016")
        assertBadSplit("016.016")
        assertBadSplit("016")
        assertBadSplit("000")
        assertBadSplit("0x0a.0x0a.0x0a")
        assertBadSplit("0x0a.0x0a")
        assertBadSplit("0x0a")
        assertBadSplit(".")
        assertBadSplit("bogus")
        assertBadSplit("bogus.com")
        assertBadSplit("1000")
        assertBadSplit("1000000000000000")
        assertBadSplit("192.168.0.1.com")

    def test_empty_octet(self):
        def assertBadOctet(addr):
            with self.assertAddressError("Empty octet not permitted in %r", addr):
                ipaddress.IPv4Address(addr)

        assertBadOctet("42..42.42")
        assertBadOctet("...")

    def test_invalid_characters(self):
        def assertBadOctet(addr, octet):
            msg = "Only decimal digits permitted in %r in %r" % (octet, addr)
            with self.assertAddressError(re.escape(msg)):
                ipaddress.IPv4Address(addr)

        assertBadOctet("0x0a.0x0a.0x0a.0x0a", "0x0a")
        assertBadOctet("0xa.0x0a.0x0a.0x0a", "0xa")
        assertBadOctet("42.42.42.-0", "-0")
        assertBadOctet("42.42.42.+0", "+0")
        assertBadOctet("42.42.42.-42", "-42")
        assertBadOctet("+1.+2.+3.4", "+1")
        assertBadOctet("1.2.3.4e0", "4e0")
        assertBadOctet("1.2.3.4::", "4::")
        assertBadOctet("1.a.2.3", "a")

    def test_octal_decimal_ambiguity(self):
        def assertBadOctet(addr, octet):
            msg = "Ambiguous (octal/decimal) value in %r not permitted in %r"
            with self.assertAddressError(re.escape(msg % (octet, addr))):
                ipaddress.IPv4Address(addr)

        assertBadOctet("016.016.016.016", "016")
        assertBadOctet("001.000.008.016", "008")

    def test_octet_length(self):
        def assertBadOctet(addr, octet):
            msg = "At most 3 characters permitted in %r in %r"
            with self.assertAddressError(re.escape(msg % (octet, addr))):
                ipaddress.IPv4Address(addr)

        assertBadOctet("0000.000.000.000", "0000")
        assertBadOctet("12345.67899.-54321.-98765", "12345")

    def test_octet_limit(self):
        def assertBadOctet(addr, octet):
            msg = "Octet %d (> 255) not permitted in %r" % (octet, addr)
            with self.assertAddressError(re.escape(msg)):
                ipaddress.IPv4Address(addr)

        assertBadOctet("257.0.0.0", 257)
        assertBadOctet("192.168.0.999", 999)


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class AddressTestCase_v6(BaseTestCase, CommonTestMixin_v6):
    factory = ipaddress.IPv6Address

    def test_network_passed_as_address(self):
        addr = "::1/24"
        with self.assertAddressError("Unexpected '/' in %r", addr):
            ipaddress.IPv6Address(addr)

    def test_bad_address_split_v6_not_enough_parts(self):
        def assertBadSplit(addr):
            msg = "At least 3 parts expected in %r"
            with self.assertAddressError(msg, addr):
                ipaddress.IPv6Address(addr)

        assertBadSplit(":")
        assertBadSplit(":1")
        assertBadSplit("FEDC:9878")

    def test_bad_address_split_v6_too_many_colons(self):
        def assertBadSplit(addr):
            msg = "At most 8 colons permitted in %r"
            with self.assertAddressError(msg, addr):
                ipaddress.IPv6Address(addr)

        assertBadSplit("9:8:7:6:5:4:3::2:1")
        assertBadSplit("10:9:8:7:6:5:4:3:2:1")
        assertBadSplit("::8:7:6:5:4:3:2:1")
        assertBadSplit("8:7:6:5:4:3:2:1::")
        # A trailing IPv4 address is two parts
        assertBadSplit("10:9:8:7:6:5:4:3:42.42.42.42")

    def test_bad_address_split_v6_too_many_parts(self):
        def assertBadSplit(addr):
            msg = "Exactly 8 parts expected without '::' in %r"
            with self.assertAddressError(msg, addr):
                ipaddress.IPv6Address(addr)

        assertBadSplit("3ffe:0:0:0:0:0:0:0:1")
        assertBadSplit("9:8:7:6:5:4:3:2:1")
        assertBadSplit("7:6:5:4:3:2:1")
        # A trailing IPv4 address is two parts
        assertBadSplit("9:8:7:6:5:4:3:42.42.42.42")
        assertBadSplit("7:6:5:4:3:42.42.42.42")

    def test_bad_address_split_v6_too_many_parts_with_double_colon(self):
        def assertBadSplit(addr):
            msg = "Expected at most 7 other parts with '::' in %r"
            with self.assertAddressError(msg, addr):
                ipaddress.IPv6Address(addr)

        assertBadSplit("1:2:3:4::5:6:7:8")

    def test_bad_address_split_v6_repeated_double_colon(self):
        def assertBadSplit(addr):
            msg = "At most one '::' permitted in %r"
            with self.assertAddressError(msg, addr):
                ipaddress.IPv6Address(addr)

        assertBadSplit("3ffe::1::1")
        assertBadSplit("1::2::3::4:5")
        assertBadSplit("2001::db:::1")
        assertBadSplit("3ffe::1::")
        assertBadSplit("::3ffe::1")
        assertBadSplit(":3ffe::1::1")
        assertBadSplit("3ffe::1::1:")
        assertBadSplit(":3ffe::1::1:")
        assertBadSplit(":::")
        assertBadSplit("2001:db8:::1")

    def test_bad_address_split_v6_leading_colon(self):
        def assertBadSplit(addr):
            msg = "Leading ':' only permitted as part of '::' in %r"
            with self.assertAddressError(msg, addr):
                ipaddress.IPv6Address(addr)

        assertBadSplit(":2001:db8::1")
        assertBadSplit(":1:2:3:4:5:6:7")
        assertBadSplit(":1:2:3:4:5:6:")
        assertBadSplit(":6:5:4:3:2:1::")

    def test_bad_address_split_v6_trailing_colon(self):
        def assertBadSplit(addr):
            msg = "Trailing ':' only permitted as part of '::' in %r"
            with self.assertAddressError(msg, addr):
                ipaddress.IPv6Address(addr)

        assertBadSplit("2001:db8::1:")
        assertBadSplit("1:2:3:4:5:6:7:")
        assertBadSplit("::1.2.3.4:")
        assertBadSplit("::7:6:5:4:3:2:")

    def test_bad_v4_part_in(self):
        def assertBadAddressPart(addr, v4_error):
            with self.assertAddressError("%s in %r", v4_error, addr):
                ipaddress.IPv6Address(addr)

        assertBadAddressPart("3ffe::1.net", "Expected 4 octets in '1.net'")
        assertBadAddressPart("3ffe::127.0.1", "Expected 4 octets in '127.0.1'")
        assertBadAddressPart("::1.2.3", "Expected 4 octets in '1.2.3'")
        assertBadAddressPart("::1.2.3.4.5", "Expected 4 octets in '1.2.3.4.5'")
        assertBadAddressPart(
            "3ffe::1.1.1.net",
            "Only decimal digits permitted in 'net' " "in '1.1.1.net'",
        )

    def test_invalid_characters(self):
        def assertBadPart(addr, part):
            msg = "Only hex digits permitted in %r in %r" % (part, addr)
            with self.assertAddressError(re.escape(msg)):
                ipaddress.IPv6Address(addr)

        assertBadPart("3ffe::goog", "goog")
        assertBadPart("3ffe::-0", "-0")
        assertBadPart("3ffe::+0", "+0")
        assertBadPart("3ffe::-1", "-1")
        assertBadPart("1.2.3.4::", "1.2.3.4")
        assertBadPart("1234:axy::b", "axy")

    def test_part_length(self):
        def assertBadPart(addr, part):
            msg = "At most 4 characters permitted in %r in %r"
            with self.assertAddressError(msg, part, addr):
                ipaddress.IPv6Address(addr)

        assertBadPart("::00000", "00000")
        assertBadPart("3ffe::10000", "10000")
        assertBadPart("02001:db8::", "02001")
        assertBadPart("2001:888888::1", "888888")


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class NetmaskTestMixin_v4(CommonTestMixin_v4):
    """Input validation on interfaces and networks is very similar"""

    def test_split_netmask(self):
        addr = "1.2.3.4/32/24"
        with self.assertAddressError("Only one '/' permitted in %r" % addr):
            self.factory(addr)

    def test_address_errors(self):
        def assertBadAddress(addr, details):
            with self.assertAddressError(details):
                self.factory(addr)

        assertBadAddress("/", "Address cannot be empty")
        assertBadAddress("/8", "Address cannot be empty")
        assertBadAddress("bogus", "Expected 4 octets")
        assertBadAddress("google.com", "Expected 4 octets")
        assertBadAddress("10/8", "Expected 4 octets")
        assertBadAddress("::1.2.3.4", "Only decimal digits")
        assertBadAddress("1.2.3.256", re.escape("256 (> 255)"))

    def test_valid_netmask(self):
        self.assertEqual(str(self.factory("192.0.2.0/255.255.255.0")), "192.0.2.0/24")
        for i in range(0, 33):
            # Generate and re-parse the CIDR format (trivial).
            net_str = "0.0.0.0/%d" % i
            net = self.factory(net_str)
            self.assertEqual(str(net), net_str)
            # Generate and re-parse the expanded netmask.
            self.assertEqual(str(self.factory("0.0.0.0/%s" % net.netmask)), net_str)
            # Zero prefix is treated as decimal.
            self.assertEqual(str(self.factory("0.0.0.0/0%d" % i)), net_str)
            # Generate and re-parse the expanded hostmask.  The ambiguous
            # cases (/0 and /32) are treated as netmasks.
            if i in (32, 0):
                net_str = "0.0.0.0/%d" % (32 - i)
            self.assertEqual(str(self.factory("0.0.0.0/%s" % net.hostmask)), net_str)

    def test_netmask_errors(self):
        def assertBadNetmask(addr, netmask):
            msg = "%r is not a valid netmask" % netmask
            with self.assertNetmaskError(re.escape(msg)):
                self.factory("%s/%s" % (addr, netmask))

        assertBadNetmask("1.2.3.4", "")
        assertBadNetmask("1.2.3.4", "-1")
        assertBadNetmask("1.2.3.4", "+1")
        assertBadNetmask("1.2.3.4", " 1 ")
        assertBadNetmask("1.2.3.4", "0x1")
        assertBadNetmask("1.2.3.4", "33")
        assertBadNetmask("1.2.3.4", "254.254.255.256")
        assertBadNetmask("1.2.3.4", "1.a.2.3")
        assertBadNetmask("1.1.1.1", "254.xyz.2.3")
        assertBadNetmask("1.1.1.1", "240.255.0.0")
        assertBadNetmask("1.1.1.1", "255.254.128.0")
        assertBadNetmask("1.1.1.1", "0.1.127.255")
        assertBadNetmask("1.1.1.1", "pudding")
        assertBadNetmask("1.1.1.1", "::")


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class InterfaceTestCase_v4(BaseTestCase, NetmaskTestMixin_v4):
    factory = ipaddress.IPv4Interface


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class NetworkTestCase_v4(BaseTestCase, NetmaskTestMixin_v4):
    factory = ipaddress.IPv4Network


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class NetmaskTestMixin_v6(CommonTestMixin_v6):
    """Input validation on interfaces and networks is very similar"""

    def test_split_netmask(self):
        addr = "cafe:cafe::/128/190"
        with self.assertAddressError("Only one '/' permitted in %r" % addr):
            self.factory(addr)

    def test_address_errors(self):
        def assertBadAddress(addr, details):
            with self.assertAddressError(details):
                self.factory(addr)

        assertBadAddress("/", "Address cannot be empty")
        assertBadAddress("/8", "Address cannot be empty")
        assertBadAddress("google.com", "At least 3 parts")
        assertBadAddress("1.2.3.4", "At least 3 parts")
        assertBadAddress("10/8", "At least 3 parts")
        assertBadAddress("1234:axy::b", "Only hex digits")

    def test_valid_netmask(self):
        # We only support CIDR for IPv6, because expanded netmasks are not
        # standard notation.
        self.assertEqual(str(self.factory("2001:db8::/32")), "2001:db8::/32")
        for i in range(0, 129):
            # Generate and re-parse the CIDR format (trivial).
            net_str = "::/%d" % i
            self.assertEqual(str(self.factory(net_str)), net_str)
            # Zero prefix is treated as decimal.
            self.assertEqual(str(self.factory("::/0%d" % i)), net_str)

    def test_netmask_errors(self):
        def assertBadNetmask(addr, netmask):
            msg = "%r is not a valid netmask" % netmask
            with self.assertNetmaskError(re.escape(msg)):
                self.factory("%s/%s" % (addr, netmask))

        assertBadNetmask("::1", "")
        assertBadNetmask("::1", "::1")
        assertBadNetmask("::1", "1::")
        assertBadNetmask("::1", "-1")
        assertBadNetmask("::1", "+1")
        assertBadNetmask("::1", " 1 ")
        assertBadNetmask("::1", "0x1")
        assertBadNetmask("::1", "129")
        assertBadNetmask("::1", "1.2.3.4")
        assertBadNetmask("::1", "pudding")
        assertBadNetmask("::", "::")


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class InterfaceTestCase_v6(BaseTestCase, NetmaskTestMixin_v6):
    factory = ipaddress.IPv6Interface


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class NetworkTestCase_v6(BaseTestCase, NetmaskTestMixin_v6):
    factory = ipaddress.IPv6Network


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class FactoryFunctionErrors(BaseTestCase):
    def assertFactoryError(self, factory, kind):
        """Ensure a clean ValueError with the expected message"""
        addr = "camelot"
        msg = "%r does not appear to be an IPv4 or IPv6 %s"
        with self.assertCleanError(ValueError, msg, addr, kind):
            factory(addr)

    def test_ip_address(self):
        self.assertFactoryError(ipaddress.ip_address, "address")

    def test_ip_interface(self):
        self.assertFactoryError(ipaddress.ip_interface, "interface")

    def test_ip_network(self):
        self.assertFactoryError(ipaddress.ip_network, "network")


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class ComparisonTests(TestCase):

    v4addr = ipaddress.IPv4Address(1)
    v4net = ipaddress.IPv4Network(1)
    v4intf = ipaddress.IPv4Interface(1)
    v6addr = ipaddress.IPv6Address(1)
    v6net = ipaddress.IPv6Network(1)
    v6intf = ipaddress.IPv6Interface(1)

    v4_addresses = [v4addr, v4intf]
    v4_objects = v4_addresses + [v4net]
    v6_addresses = [v6addr, v6intf]
    v6_objects = v6_addresses + [v6net]
    objects = v4_objects + v6_objects

    def test_foreign_type_equality(self):
        # __eq__ should never raise TypeError directly
        other = object()
        for obj in self.objects:
            self.assertNotEqual(obj, other)
            self.assertFalse(obj == other)
            self.assertEqual(obj.__eq__(other), NotImplemented)
            self.assertEqual(obj.__ne__(other), NotImplemented)

    def test_mixed_type_equality(self):
        # Ensure none of the internal objects accidentally
        # expose the right set of attributes to become "equal"
        for lhs in self.objects:
            for rhs in self.objects:
                if lhs is rhs:
                    continue
                self.assertNotEqual(lhs, rhs)

    def test_containment(self):
        for obj in self.v4_addresses:
            self.assertIn(obj, self.v4net)
        for obj in self.v6_addresses:
            self.assertIn(obj, self.v6net)
        for obj in self.v4_objects + [self.v6net]:
            self.assertNotIn(obj, self.v6net)
        for obj in self.v6_objects + [self.v4net]:
            self.assertNotIn(obj, self.v4net)

    def test_mixed_type_ordering(self):
        for lhs in self.objects:
            for rhs in self.objects:
                if isinstance(lhs, type(rhs)) or isinstance(rhs, type(lhs)):
                    continue
                self.assertRaises(TypeError, lambda: lhs < rhs)
                self.assertRaises(TypeError, lambda: lhs > rhs)
                self.assertRaises(TypeError, lambda: lhs <= rhs)
                self.assertRaises(TypeError, lambda: lhs >= rhs)

    def test_mixed_type_key(self):
        # with get_mixed_type_key, you can sort addresses and network.
        v4_ordered = [self.v4addr, self.v4net, self.v4intf]
        v6_ordered = [self.v6addr, self.v6net, self.v6intf]
        self.assertEqual(
            v4_ordered, sorted(self.v4_objects, key=ipaddress.get_mixed_type_key)
        )
        self.assertEqual(
            v6_ordered, sorted(self.v6_objects, key=ipaddress.get_mixed_type_key)
        )
        self.assertEqual(
            v4_ordered + v6_ordered,
            sorted(self.objects, key=ipaddress.get_mixed_type_key),
        )
        self.assertEqual(NotImplemented, ipaddress.get_mixed_type_key(object))

    def test_incompatible_versions(self):
        # These should always raise TypeError
        v4addr = ipaddress.ip_address("1.1.1.1")
        v4net = ipaddress.ip_network("1.1.1.1")
        v6addr = ipaddress.ip_address("::1")
        v6net = ipaddress.ip_address("::1")

        self.assertRaises(TypeError, v4addr.__lt__, v6addr)
        self.assertRaises(TypeError, v4addr.__gt__, v6addr)
        self.assertRaises(TypeError, v4net.__lt__, v6net)
        self.assertRaises(TypeError, v4net.__gt__, v6net)

        self.assertRaises(TypeError, v6addr.__lt__, v4addr)
        self.assertRaises(TypeError, v6addr.__gt__, v4addr)
        self.assertRaises(TypeError, v6net.__lt__, v4net)
        self.assertRaises(TypeError, v6net.__gt__, v4net)


@skipIf(sys.version_info > (3,), "These are tested by the python test suite under Py3")
class IpaddrUnitTest(TestCase):
    def setUp(self):
        self.ipv4_address = ipaddress.IPv4Address("1.2.3.4")
        self.ipv4_interface = ipaddress.IPv4Interface("1.2.3.4/24")
        self.ipv4_network = ipaddress.IPv4Network("1.2.3.0/24")
        # self.ipv4_hostmask = ipaddress.IPv4Interface('10.0.0.1/0.255.255.255')
        self.ipv6_address = ipaddress.IPv6Interface("2001:658:22a:cafe:200:0:0:1")
        self.ipv6_interface = ipaddress.IPv6Interface("2001:658:22a:cafe:200:0:0:1/64")
        self.ipv6_network = ipaddress.IPv6Network("2001:658:22a:cafe::/64")

    def tearDown(self):
        for attrname in (
            "ipv4_network",
            "ipv4_interface",
            "ipv4_address",
            "ipv6_network",
            "ipv6_interface",
            "ipv6_address",
        ):
            try:
                delattr(self, attrname)
            except AttributeError:
                continue

    def testRepr(self):
        self.assertEqual(
            "IPv4Interface('1.2.3.4/32')", repr(ipaddress.IPv4Interface("1.2.3.4"))
        )
        self.assertEqual(
            "IPv6Interface('::1/128')", repr(ipaddress.IPv6Interface("::1"))
        )

    # issue57
    def testAddressIntMath(self):
        self.assertEqual(
            ipaddress.IPv4Address("1.1.1.1") + 255, ipaddress.IPv4Address("1.1.2.0")
        )
        self.assertEqual(
            ipaddress.IPv4Address("1.1.1.1") - 256, ipaddress.IPv4Address("1.1.0.1")
        )
        self.assertEqual(
            ipaddress.IPv6Address("::1") + (2 ** 16 - 2),
            ipaddress.IPv6Address("::ffff"),
        )
        self.assertEqual(
            ipaddress.IPv6Address("::ffff") - (2 ** 16 - 2),
            ipaddress.IPv6Address("::1"),
        )

    def testInvalidIntToBytes(self):
        self.assertRaises(ValueError, ipaddress.v4_int_to_packed, -1)
        self.assertRaises(
            ValueError, ipaddress.v4_int_to_packed, 2 ** ipaddress.IPV4LENGTH
        )
        self.assertRaises(ValueError, ipaddress.v6_int_to_packed, -1)
        self.assertRaises(
            ValueError, ipaddress.v6_int_to_packed, 2 ** ipaddress.IPV6LENGTH
        )

    def testInternals(self):
        first, last = ipaddress._find_address_range(
            [ipaddress.IPv4Address("10.10.10.10"), ipaddress.IPv4Address("10.10.10.12")]
        )
        self.assertEqual(first, last)
        self.assertEqual(128, ipaddress._count_righthand_zero_bits(0, 128))
        self.assertEqual("IPv4Network('1.2.3.0/24')", repr(self.ipv4_network))

    def testMissingAddressVersion(self):
        class Broken(ipaddress._BaseAddress):
            pass

        broken = Broken("127.0.0.1")
        with self.assertRaisesRegex(NotImplementedError, "Broken.*version"):
            broken.version

    def testMissingNetworkVersion(self):
        class Broken(ipaddress._BaseNetwork):
            pass

        broken = Broken("127.0.0.1")
        with self.assertRaisesRegex(NotImplementedError, "Broken.*version"):
            broken.version

    def testMissingAddressClass(self):
        class Broken(ipaddress._BaseNetwork):
            pass

        broken = Broken("127.0.0.1")
        with self.assertRaisesRegex(NotImplementedError, "Broken.*address"):
            broken._address_class

    def testGetNetwork(self):
        self.assertEqual(int(self.ipv4_network.network_address), 16909056)
        self.assertEqual(str(self.ipv4_network.network_address), "1.2.3.0")

        self.assertEqual(
            int(self.ipv6_network.network_address),
            42540616829182469433403647294022090752,
        )
        self.assertEqual(str(self.ipv6_network.network_address), "2001:658:22a:cafe::")
        self.assertEqual(str(self.ipv6_network.hostmask), "::ffff:ffff:ffff:ffff")

    def testIpFromInt(self):
        self.assertEqual(self.ipv4_interface._ip, ipaddress.IPv4Interface(16909060)._ip)

        ipv4 = ipaddress.ip_network("1.2.3.4")
        ipv6 = ipaddress.ip_network("2001:658:22a:cafe:200:0:0:1")
        self.assertEqual(ipv4, ipaddress.ip_network(int(ipv4.network_address)))
        self.assertEqual(ipv6, ipaddress.ip_network(int(ipv6.network_address)))

        v6_int = 42540616829182469433547762482097946625
        self.assertEqual(self.ipv6_interface._ip, ipaddress.IPv6Interface(v6_int)._ip)

        self.assertEqual(ipaddress.ip_network(self.ipv4_address._ip).version, 4)
        self.assertEqual(ipaddress.ip_network(self.ipv6_address._ip).version, 6)

    def testIpFromPacked(self):
        address = ipaddress.ip_address
        self.assertEqual(
            self.ipv4_interface._ip,
            ipaddress.ip_interface(bytearray(b"\x01\x02\x03\x04"))._ip,
        )
        self.assertEqual(
            address("255.254.253.252"), address(bytearray(b"\xff\xfe\xfd\xfc"))
        )
        self.assertEqual(
            self.ipv6_interface.ip,
            ipaddress.ip_interface(
                bytearray(
                    b"\x20\x01\x06\x58\x02\x2a\xca\xfe"
                    b"\x02\x00\x00\x00\x00\x00\x00\x01"
                )
            ).ip,
        )
        self.assertEqual(
            address("ffff:2:3:4:ffff::"),
            address(
                bytearray(b"\xff\xff\x00\x02\x00\x03\x00\x04")
                + bytearray(b"\xff\xff")
                + bytearray(b"\x00") * 6
            ),
        )
        self.assertEqual(address("::"), address(bytearray(b"\x00") * 16))

    def testGetIp(self):
        self.assertEqual(int(self.ipv4_interface.ip), 16909060)
        self.assertEqual(str(self.ipv4_interface.ip), "1.2.3.4")

        self.assertEqual(
            int(self.ipv6_interface.ip), 42540616829182469433547762482097946625
        )
        self.assertEqual(str(self.ipv6_interface.ip), "2001:658:22a:cafe:200::1")

    def testGetNetmask(self):
        self.assertEqual(int(self.ipv4_network.netmask), 4294967040)
        self.assertEqual(str(self.ipv4_network.netmask), "255.255.255.0")
        self.assertEqual(
            int(self.ipv6_network.netmask), 340282366920938463444927863358058659840
        )
        self.assertEqual(self.ipv6_network.prefixlen, 64)

    def testZeroNetmask(self):
        ipv4_zero_netmask = ipaddress.IPv4Interface("1.2.3.4/0")
        self.assertEqual(int(ipv4_zero_netmask.network.netmask), 0)
        self.assertEqual(ipv4_zero_netmask._prefix_from_prefix_string("0"), 0)
        self.assertTrue(ipv4_zero_netmask._is_valid_netmask("0"))
        self.assertTrue(ipv4_zero_netmask._is_valid_netmask("0.0.0.0"))
        self.assertFalse(ipv4_zero_netmask._is_valid_netmask("invalid"))

        ipv6_zero_netmask = ipaddress.IPv6Interface("::1/0")
        self.assertEqual(int(ipv6_zero_netmask.network.netmask), 0)
        self.assertEqual(ipv6_zero_netmask._prefix_from_prefix_string("0"), 0)

    def testIPv4NetAndHostmasks(self):
        net = self.ipv4_network
        self.assertFalse(net._is_valid_netmask("invalid"))
        self.assertTrue(net._is_valid_netmask("128.128.128.128"))
        self.assertFalse(net._is_valid_netmask("128.128.128.127"))
        self.assertFalse(net._is_valid_netmask("128.128.128.255"))
        self.assertTrue(net._is_valid_netmask("255.128.128.128"))

        self.assertFalse(net._is_hostmask("invalid"))
        self.assertTrue(net._is_hostmask("128.255.255.255"))
        self.assertFalse(net._is_hostmask("255.255.255.255"))
        self.assertFalse(net._is_hostmask("1.2.3.4"))

        net = ipaddress.IPv4Network("127.0.0.0/0.0.0.255")
        self.assertEqual(net.prefixlen, 24)

    def testGetBroadcast(self):
        self.assertEqual(int(self.ipv4_network.broadcast_address), 16909311)
        self.assertEqual(str(self.ipv4_network.broadcast_address), "1.2.3.255")

        self.assertEqual(
            int(self.ipv6_network.broadcast_address),
            42540616829182469451850391367731642367,
        )
        self.assertEqual(
            str(self.ipv6_network.broadcast_address),
            "2001:658:22a:cafe:ffff:ffff:ffff:ffff",
        )

    def testGetPrefixlen(self):
        self.assertEqual(self.ipv4_interface.network.prefixlen, 24)
        self.assertEqual(self.ipv6_interface.network.prefixlen, 64)

    def testGetSupernet(self):
        self.assertEqual(self.ipv4_network.supernet().prefixlen, 23)
        self.assertEqual(str(self.ipv4_network.supernet().network_address), "1.2.2.0")
        self.assertEqual(
            ipaddress.IPv4Interface("0.0.0.0/0").network.supernet(),
            ipaddress.IPv4Network("0.0.0.0/0"),
        )

        self.assertEqual(self.ipv6_network.supernet().prefixlen, 63)
        self.assertEqual(
            str(self.ipv6_network.supernet().network_address), "2001:658:22a:cafe::"
        )
        self.assertEqual(
            ipaddress.IPv6Interface("::0/0").network.supernet(),
            ipaddress.IPv6Network("::0/0"),
        )

    def testGetSupernet3(self):
        self.assertEqual(self.ipv4_network.supernet(3).prefixlen, 21)
        self.assertEqual(str(self.ipv4_network.supernet(3).network_address), "1.2.0.0")

        self.assertEqual(self.ipv6_network.supernet(3).prefixlen, 61)
        self.assertEqual(
            str(self.ipv6_network.supernet(3).network_address), "2001:658:22a:caf8::"
        )

    def testGetSupernet4(self):
        self.assertRaises(
            ValueError, self.ipv4_network.supernet, prefixlen_diff=2, new_prefix=1
        )
        self.assertRaises(ValueError, self.ipv4_network.supernet, new_prefix=25)
        self.assertEqual(
            self.ipv4_network.supernet(prefixlen_diff=2),
            self.ipv4_network.supernet(new_prefix=22),
        )

        self.assertRaises(
            ValueError, self.ipv6_network.supernet, prefixlen_diff=2, new_prefix=1
        )
        self.assertRaises(ValueError, self.ipv6_network.supernet, new_prefix=65)
        self.assertEqual(
            self.ipv6_network.supernet(prefixlen_diff=2),
            self.ipv6_network.supernet(new_prefix=62),
        )

    def testHosts(self):
        hosts = list(self.ipv4_network.hosts())
        self.assertEqual(254, len(hosts))
        self.assertEqual(ipaddress.IPv4Address("1.2.3.1"), hosts[0])
        self.assertEqual(ipaddress.IPv4Address("1.2.3.254"), hosts[-1])

        # special case where only 1 bit is left for address
        self.assertEqual(
            [ipaddress.IPv4Address("2.0.0.0"), ipaddress.IPv4Address("2.0.0.1")],
            list(ipaddress.ip_network("2.0.0.0/31").hosts()),
        )

    def testFancySubnetting(self):
        self.assertEqual(
            sorted(self.ipv4_network.subnets(prefixlen_diff=3)),
            sorted(self.ipv4_network.subnets(new_prefix=27)),
        )
        self.assertRaises(ValueError, list, self.ipv4_network.subnets(new_prefix=23))
        self.assertRaises(
            ValueError, list, self.ipv4_network.subnets(prefixlen_diff=3, new_prefix=27)
        )
        self.assertEqual(
            sorted(self.ipv6_network.subnets(prefixlen_diff=4)),
            sorted(self.ipv6_network.subnets(new_prefix=68)),
        )
        self.assertRaises(ValueError, list, self.ipv6_network.subnets(new_prefix=63))
        self.assertRaises(
            ValueError, list, self.ipv6_network.subnets(prefixlen_diff=4, new_prefix=68)
        )

    def testGetSubnets(self):
        self.assertEqual(list(self.ipv4_network.subnets())[0].prefixlen, 25)
        self.assertEqual(
            str(list(self.ipv4_network.subnets())[0].network_address), "1.2.3.0"
        )
        self.assertEqual(
            str(list(self.ipv4_network.subnets())[1].network_address), "1.2.3.128"
        )

        self.assertEqual(list(self.ipv6_network.subnets())[0].prefixlen, 65)

    def testGetSubnetForSingle32(self):
        ip = ipaddress.IPv4Network("1.2.3.4/32")
        subnets1 = [str(x) for x in ip.subnets()]
        subnets2 = [str(x) for x in ip.subnets(2)]
        self.assertEqual(subnets1, ["1.2.3.4/32"])
        self.assertEqual(subnets1, subnets2)

    def testGetSubnetForSingle128(self):
        ip = ipaddress.IPv6Network("::1/128")
        subnets1 = [str(x) for x in ip.subnets()]
        subnets2 = [str(x) for x in ip.subnets(2)]
        self.assertEqual(subnets1, ["::1/128"])
        self.assertEqual(subnets1, subnets2)

    def testSubnet2(self):
        ips = [str(x) for x in self.ipv4_network.subnets(2)]
        self.assertEqual(
            ips, ["1.2.3.0/26", "1.2.3.64/26", "1.2.3.128/26", "1.2.3.192/26"]
        )

        ipsv6 = [str(x) for x in self.ipv6_network.subnets(2)]
        self.assertEqual(
            ipsv6,
            [
                "2001:658:22a:cafe::/66",
                "2001:658:22a:cafe:4000::/66",
                "2001:658:22a:cafe:8000::/66",
                "2001:658:22a:cafe:c000::/66",
            ],
        )

    def testSubnetFailsForLargeCidrDiff(self):
        self.assertRaises(ValueError, list, self.ipv4_interface.network.subnets(9))
        self.assertRaises(ValueError, list, self.ipv4_network.subnets(9))
        self.assertRaises(ValueError, list, self.ipv6_interface.network.subnets(65))
        self.assertRaises(ValueError, list, self.ipv6_network.subnets(65))

    def testSupernetFailsForLargeCidrDiff(self):
        self.assertRaises(ValueError, self.ipv4_interface.network.supernet, 25)
        self.assertRaises(ValueError, self.ipv6_interface.network.supernet, 65)

    def testSubnetFailsForNegativeCidrDiff(self):
        self.assertRaises(ValueError, list, self.ipv4_interface.network.subnets(-1))
        self.assertRaises(ValueError, list, self.ipv4_network.subnets(-1))
        self.assertRaises(ValueError, list, self.ipv6_interface.network.subnets(-1))
        self.assertRaises(ValueError, list, self.ipv6_network.subnets(-1))

    def testGetNum_Addresses(self):
        self.assertEqual(self.ipv4_network.num_addresses, 256)
        self.assertEqual(list(self.ipv4_network.subnets())[0].num_addresses, 128)
        self.assertEqual(self.ipv4_network.supernet().num_addresses, 512)

        self.assertEqual(self.ipv6_network.num_addresses, 18446744073709551616)
        self.assertEqual(
            list(self.ipv6_network.subnets())[0].num_addresses, 9223372036854775808
        )
        self.assertEqual(
            self.ipv6_network.supernet().num_addresses, 36893488147419103232
        )

    def testContains(self):
        self.assertIn(ipaddress.IPv4Interface("1.2.3.128/25"), self.ipv4_network)
        self.assertNotIn(ipaddress.IPv4Interface("1.2.4.1/24"), self.ipv4_network)
        # We can test addresses and string as well.
        addr1 = ipaddress.IPv4Address("1.2.3.37")
        self.assertIn(addr1, self.ipv4_network)
        # issue 61, bad network comparison on like-ip'd network objects
        # with identical broadcast addresses.
        self.assertFalse(
            ipaddress.IPv4Network("1.1.0.0/16").__contains__(
                ipaddress.IPv4Network("1.0.0.0/15")
            )
        )

    def testNth(self):
        self.assertEqual(str(self.ipv4_network[5]), "1.2.3.5")
        self.assertRaises(IndexError, self.ipv4_network.__getitem__, 256)

        self.assertEqual(str(self.ipv6_network[5]), "2001:658:22a:cafe::5")

    def testGetitem(self):
        # http://code.google.com/p/ipaddr-py/issues/detail?id=15
        addr = ipaddress.IPv4Network("172.31.255.128/255.255.255.240")
        self.assertEqual(28, addr.prefixlen)
        addr_list = list(addr)
        self.assertEqual("172.31.255.128", str(addr_list[0]))
        self.assertEqual("172.31.255.128", str(addr[0]))
        self.assertEqual("172.31.255.143", str(addr_list[-1]))
        self.assertEqual("172.31.255.143", str(addr[-1]))
        self.assertEqual(addr_list[-1], addr[-1])

    def testEqual(self):
        self.assertTrue(self.ipv4_interface == ipaddress.IPv4Interface("1.2.3.4/24"))
        self.assertFalse(self.ipv4_interface == ipaddress.IPv4Interface("1.2.3.4/23"))
        self.assertFalse(self.ipv4_interface == ipaddress.IPv6Interface("::1.2.3.4/24"))
        self.assertFalse(self.ipv4_interface == "")
        self.assertFalse(self.ipv4_interface == [])
        self.assertFalse(self.ipv4_interface == 2)

        self.assertTrue(
            self.ipv6_interface
            == ipaddress.IPv6Interface("2001:658:22a:cafe:200::1/64")
        )
        self.assertFalse(
            self.ipv6_interface
            == ipaddress.IPv6Interface("2001:658:22a:cafe:200::1/63")
        )
        self.assertFalse(self.ipv6_interface == ipaddress.IPv4Interface("1.2.3.4/23"))
        self.assertFalse(self.ipv6_interface == "")
        self.assertFalse(self.ipv6_interface == [])
        self.assertFalse(self.ipv6_interface == 2)

    def testNotEqual(self):
        self.assertFalse(self.ipv4_interface != ipaddress.IPv4Interface("1.2.3.4/24"))
        self.assertTrue(self.ipv4_interface != ipaddress.IPv4Interface("1.2.3.4/23"))
        self.assertTrue(self.ipv4_interface != ipaddress.IPv6Interface("::1.2.3.4/24"))
        self.assertTrue(self.ipv4_interface != "")
        self.assertTrue(self.ipv4_interface != [])
        self.assertTrue(self.ipv4_interface != 2)

        self.assertTrue(self.ipv4_address != ipaddress.IPv4Address("1.2.3.5"))
        self.assertTrue(self.ipv4_address != "")
        self.assertTrue(self.ipv4_address != [])
        self.assertTrue(self.ipv4_address != 2)

        self.assertFalse(
            self.ipv6_interface
            != ipaddress.IPv6Interface("2001:658:22a:cafe:200::1/64")
        )
        self.assertTrue(
            self.ipv6_interface
            != ipaddress.IPv6Interface("2001:658:22a:cafe:200::1/63")
        )
        self.assertTrue(self.ipv6_interface != ipaddress.IPv4Interface("1.2.3.4/23"))
        self.assertTrue(self.ipv6_interface != "")
        self.assertTrue(self.ipv6_interface != [])
        self.assertTrue(self.ipv6_interface != 2)

        self.assertTrue(self.ipv6_address != ipaddress.IPv4Address("1.2.3.4"))
        self.assertTrue(self.ipv6_address != "")
        self.assertTrue(self.ipv6_address != [])
        self.assertTrue(self.ipv6_address != 2)

    def testSlash32Constructor(self):
        self.assertEqual(
            str(ipaddress.IPv4Interface("1.2.3.4/255.255.255.255")), "1.2.3.4/32"
        )

    def testSlash128Constructor(self):
        self.assertEqual(str(ipaddress.IPv6Interface("::1/128")), "::1/128")

    def testSlash0Constructor(self):
        self.assertEqual(str(ipaddress.IPv4Interface("1.2.3.4/0.0.0.0")), "1.2.3.4/0")

    def testCollapsing(self):
        # test only IP addresses including some duplicates
        ip1 = ipaddress.IPv4Address("1.1.1.0")
        ip2 = ipaddress.IPv4Address("1.1.1.1")
        ip3 = ipaddress.IPv4Address("1.1.1.2")
        ip4 = ipaddress.IPv4Address("1.1.1.3")
        ip5 = ipaddress.IPv4Address("1.1.1.4")
        ip6 = ipaddress.IPv4Address("1.1.1.0")
        # check that addreses are subsumed properly.
        collapsed = ipaddress.collapse_addresses([ip1, ip2, ip3, ip4, ip5, ip6])
        self.assertEqual(
            list(collapsed),
            [ipaddress.IPv4Network("1.1.1.0/30"), ipaddress.IPv4Network("1.1.1.4/32")],
        )

        # test a mix of IP addresses and networks including some duplicates
        ip1 = ipaddress.IPv4Address("1.1.1.0")
        ip2 = ipaddress.IPv4Address("1.1.1.1")
        ip3 = ipaddress.IPv4Address("1.1.1.2")
        ip4 = ipaddress.IPv4Address("1.1.1.3")
        # ip5 = ipaddress.IPv4Interface('1.1.1.4/30')
        # ip6 = ipaddress.IPv4Interface('1.1.1.4/30')
        # check that addreses are subsumed properly.
        collapsed = ipaddress.collapse_addresses([ip1, ip2, ip3, ip4])
        self.assertEqual(list(collapsed), [ipaddress.IPv4Network("1.1.1.0/30")])

        # test only IP networks
        ip1 = ipaddress.IPv4Network("1.1.0.0/24")
        ip2 = ipaddress.IPv4Network("1.1.1.0/24")
        ip3 = ipaddress.IPv4Network("1.1.2.0/24")
        ip4 = ipaddress.IPv4Network("1.1.3.0/24")
        ip5 = ipaddress.IPv4Network("1.1.4.0/24")
        # stored in no particular order b/c we want CollapseAddr to call
        # [].sort
        ip6 = ipaddress.IPv4Network("1.1.0.0/22")
        # check that addreses are subsumed properly.
        collapsed = ipaddress.collapse_addresses([ip1, ip2, ip3, ip4, ip5, ip6])
        self.assertEqual(
            list(collapsed),
            [ipaddress.IPv4Network("1.1.0.0/22"), ipaddress.IPv4Network("1.1.4.0/24")],
        )

        # test that two addresses are supernet'ed properly
        collapsed = ipaddress.collapse_addresses([ip1, ip2])
        self.assertEqual(list(collapsed), [ipaddress.IPv4Network("1.1.0.0/23")])

        # test same IP networks
        ip_same1 = ip_same2 = ipaddress.IPv4Network("1.1.1.1/32")
        self.assertEqual(
            list(ipaddress.collapse_addresses([ip_same1, ip_same2])), [ip_same1]
        )

        # test same IP addresses
        ip_same1 = ip_same2 = ipaddress.IPv4Address("1.1.1.1")
        self.assertEqual(
            list(ipaddress.collapse_addresses([ip_same1, ip_same2])),
            [ipaddress.ip_network("1.1.1.1/32")],
        )
        ip1 = ipaddress.IPv6Network("2001::/100")
        ip2 = ipaddress.IPv6Network("2001::/120")
        ip3 = ipaddress.IPv6Network("2001::/96")
        # test that ipv6 addresses are subsumed properly.
        collapsed = ipaddress.collapse_addresses([ip1, ip2, ip3])
        self.assertEqual(list(collapsed), [ip3])

        # the toejam test
        addr_tuples = [
            (ipaddress.ip_address("1.1.1.1"), ipaddress.ip_address("::1")),
            (ipaddress.IPv4Network("1.1.0.0/24"), ipaddress.IPv6Network("2001::/120")),
            (ipaddress.IPv4Network("1.1.0.0/32"), ipaddress.IPv6Network("2001::/128")),
        ]
        for ip1, ip2 in addr_tuples:
            self.assertRaises(TypeError, ipaddress.collapse_addresses, [ip1, ip2])

    def testSummarizing(self):
        # ip = ipaddress.ip_address
        # ipnet = ipaddress.ip_network
        summarize = ipaddress.summarize_address_range
        ip1 = ipaddress.ip_address("1.1.1.0")
        ip2 = ipaddress.ip_address("1.1.1.255")

        # summarize works only for IPv4 & IPv6
        class IPv7Address(ipaddress.IPv6Address):
            @property
            def version(self):
                return 7

        ip_invalid1 = IPv7Address("::1")
        ip_invalid2 = IPv7Address("::1")
        self.assertRaises(ValueError, list, summarize(ip_invalid1, ip_invalid2))
        # test that a summary over ip4 & ip6 fails
        self.assertRaises(TypeError, list, summarize(ip1, ipaddress.IPv6Address("::1")))
        # test a /24 is summarized properly
        self.assertEqual(
            list(summarize(ip1, ip2))[0], ipaddress.ip_network("1.1.1.0/24")
        )
        # test an  IPv4 range that isn't on a network byte boundary
        ip2 = ipaddress.ip_address("1.1.1.8")
        self.assertEqual(
            list(summarize(ip1, ip2)),
            [ipaddress.ip_network("1.1.1.0/29"), ipaddress.ip_network("1.1.1.8")],
        )
        # all!
        ip1 = ipaddress.IPv4Address(0)
        ip2 = ipaddress.IPv4Address(ipaddress.IPv4Address._ALL_ONES)
        self.assertEqual(
            [ipaddress.IPv4Network("0.0.0.0/0")], list(summarize(ip1, ip2))
        )

        ip1 = ipaddress.ip_address("1::")
        ip2 = ipaddress.ip_address("1:ffff:ffff:ffff:ffff:ffff:ffff:ffff")
        # test a IPv6 is sumamrized properly
        self.assertEqual(list(summarize(ip1, ip2))[0], ipaddress.ip_network("1::/16"))
        # test an IPv6 range that isn't on a network byte boundary
        ip2 = ipaddress.ip_address("2::")
        self.assertEqual(
            list(summarize(ip1, ip2)),
            [ipaddress.ip_network("1::/16"), ipaddress.ip_network("2::/128")],
        )

        # test exception raised when first is greater than last
        self.assertRaises(
            ValueError,
            list,
            summarize(ipaddress.ip_address("1.1.1.0"), ipaddress.ip_address("1.1.0.0")),
        )
        # test exception raised when first and last aren't IP addresses
        self.assertRaises(
            TypeError,
            list,
            summarize(ipaddress.ip_network("1.1.1.0"), ipaddress.ip_network("1.1.0.0")),
        )
        self.assertRaises(
            TypeError,
            list,
            summarize(ipaddress.ip_network("1.1.1.0"), ipaddress.ip_network("1.1.0.0")),
        )
        # test exception raised when first and last are not same version
        self.assertRaises(
            TypeError,
            list,
            summarize(ipaddress.ip_address("::"), ipaddress.ip_network("1.1.0.0")),
        )

    def testAddressComparison(self):
        self.assertTrue(
            ipaddress.ip_address("1.1.1.1") <= ipaddress.ip_address("1.1.1.1")
        )
        self.assertTrue(
            ipaddress.ip_address("1.1.1.1") <= ipaddress.ip_address("1.1.1.2")
        )
        self.assertTrue(ipaddress.ip_address("::1") <= ipaddress.ip_address("::1"))
        self.assertTrue(ipaddress.ip_address("::1") <= ipaddress.ip_address("::2"))

    def testInterfaceComparison(self):
        self.assertTrue(
            ipaddress.ip_interface("1.1.1.1") <= ipaddress.ip_interface("1.1.1.1")
        )
        self.assertTrue(
            ipaddress.ip_interface("1.1.1.1") <= ipaddress.ip_interface("1.1.1.2")
        )
        self.assertTrue(ipaddress.ip_interface("::1") <= ipaddress.ip_interface("::1"))
        self.assertTrue(ipaddress.ip_interface("::1") <= ipaddress.ip_interface("::2"))

    def testNetworkComparison(self):
        # ip1 and ip2 have the same network address
        ip1 = ipaddress.IPv4Network("1.1.1.0/24")
        ip2 = ipaddress.IPv4Network("1.1.1.0/32")
        ip3 = ipaddress.IPv4Network("1.1.2.0/24")

        self.assertTrue(ip1 < ip3)
        self.assertTrue(ip3 > ip2)

        self.assertEqual(ip1.compare_networks(ip1), 0)

        # if addresses are the same, sort by netmask
        self.assertEqual(ip1.compare_networks(ip2), -1)
        self.assertEqual(ip2.compare_networks(ip1), 1)

        self.assertEqual(ip1.compare_networks(ip3), -1)
        self.assertEqual(ip3.compare_networks(ip1), 1)
        self.assertTrue(ip1._get_networks_key() < ip3._get_networks_key())

        ip1 = ipaddress.IPv6Network("2001:2000::/96")
        ip2 = ipaddress.IPv6Network("2001:2001::/96")
        ip3 = ipaddress.IPv6Network("2001:ffff:2000::/96")

        self.assertTrue(ip1 < ip3)
        self.assertTrue(ip3 > ip2)
        self.assertEqual(ip1.compare_networks(ip3), -1)
        self.assertTrue(ip1._get_networks_key() < ip3._get_networks_key())

        # Test comparing different protocols.
        # Should always raise a TypeError.
        self.assertRaises(
            TypeError, self.ipv4_network.compare_networks, self.ipv6_network
        )
        ipv6 = ipaddress.IPv6Interface("::/0")
        ipv4 = ipaddress.IPv4Interface("0.0.0.0/0")
        self.assertRaises(TypeError, ipv4.__lt__, ipv6)
        self.assertRaises(TypeError, ipv4.__gt__, ipv6)
        self.assertRaises(TypeError, ipv6.__lt__, ipv4)
        self.assertRaises(TypeError, ipv6.__gt__, ipv4)

        # Regression test for issue 19.
        ip1 = ipaddress.ip_network("10.1.2.128/25")
        self.assertFalse(ip1 < ip1)
        self.assertFalse(ip1 > ip1)
        ip2 = ipaddress.ip_network("10.1.3.0/24")
        self.assertTrue(ip1 < ip2)
        self.assertFalse(ip2 < ip1)
        self.assertFalse(ip1 > ip2)
        self.assertTrue(ip2 > ip1)
        ip3 = ipaddress.ip_network("10.1.3.0/25")
        self.assertTrue(ip2 < ip3)
        self.assertFalse(ip3 < ip2)
        self.assertFalse(ip2 > ip3)
        self.assertTrue(ip3 > ip2)

        # Regression test for issue 28.
        ip1 = ipaddress.ip_network("10.10.10.0/31")
        ip2 = ipaddress.ip_network("10.10.10.0")
        ip3 = ipaddress.ip_network("10.10.10.2/31")
        ip4 = ipaddress.ip_network("10.10.10.2")
        sorted = [ip1, ip2, ip3, ip4]
        unsorted = [ip2, ip4, ip1, ip3]
        unsorted.sort()
        self.assertEqual(sorted, unsorted)
        unsorted = [ip4, ip1, ip3, ip2]
        unsorted.sort()
        self.assertEqual(sorted, unsorted)
        self.assertRaises(TypeError, ip1.__lt__, ipaddress.ip_address("10.10.10.0"))
        self.assertRaises(TypeError, ip2.__lt__, ipaddress.ip_address("10.10.10.0"))

        # <=, >=
        self.assertTrue(
            ipaddress.ip_network("1.1.1.1") <= ipaddress.ip_network("1.1.1.1")
        )
        self.assertTrue(
            ipaddress.ip_network("1.1.1.1") <= ipaddress.ip_network("1.1.1.2")
        )
        self.assertFalse(
            ipaddress.ip_network("1.1.1.2") <= ipaddress.ip_network("1.1.1.1")
        )
        self.assertTrue(ipaddress.ip_network("::1") <= ipaddress.ip_network("::1"))
        self.assertTrue(ipaddress.ip_network("::1") <= ipaddress.ip_network("::2"))
        self.assertFalse(ipaddress.ip_network("::2") <= ipaddress.ip_network("::1"))

    def testStrictNetworks(self):
        self.assertRaises(ValueError, ipaddress.ip_network, "192.168.1.1/24")
        self.assertRaises(ValueError, ipaddress.ip_network, "::1/120")

    def testOverlaps(self):
        other = ipaddress.IPv4Network("1.2.3.0/30")
        other2 = ipaddress.IPv4Network("1.2.2.0/24")
        other3 = ipaddress.IPv4Network("1.2.2.64/26")
        self.assertTrue(self.ipv4_network.overlaps(other))
        self.assertFalse(self.ipv4_network.overlaps(other2))
        self.assertTrue(other2.overlaps(other3))

    def testEmbeddedIpv4(self):
        ipv4_string = "192.168.0.1"
        ipv4 = ipaddress.IPv4Interface(ipv4_string)
        v4compat_ipv6 = ipaddress.IPv6Interface("::%s" % ipv4_string)
        self.assertEqual(int(v4compat_ipv6.ip), int(ipv4.ip))
        v4mapped_ipv6 = ipaddress.IPv6Interface("::ffff:%s" % ipv4_string)
        self.assertNotEqual(v4mapped_ipv6.ip, ipv4.ip)
        self.assertRaises(
            ipaddress.AddressValueError, ipaddress.IPv6Interface, "2001:1.1.1.1:1.1.1.1"
        )

    # Issue 67: IPv6 with embedded IPv4 address not recognized.
    def testIPv6AddressTooLarge(self):
        # RFC4291 2.5.5.2
        self.assertEqual(
            ipaddress.ip_address("::FFFF:192.0.2.1"),
            ipaddress.ip_address("::FFFF:c000:201"),
        )
        # RFC4291 2.2 (part 3) x::d.d.d.d
        self.assertEqual(
            ipaddress.ip_address("FFFF::192.0.2.1"),
            ipaddress.ip_address("FFFF::c000:201"),
        )

    def testIPVersion(self):
        self.assertEqual(self.ipv4_address.version, 4)
        self.assertEqual(self.ipv6_address.version, 6)

    def testMaxPrefixLength(self):
        self.assertEqual(self.ipv4_interface.max_prefixlen, 32)
        self.assertEqual(self.ipv6_interface.max_prefixlen, 128)

    def testPacked(self):
        self.assertEqual(self.ipv4_address.packed, bytearray(b"\x01\x02\x03\x04"))
        self.assertEqual(
            ipaddress.IPv4Interface("255.254.253.252").packed,
            bytearray(b"\xff\xfe\xfd\xfc"),
        )
        self.assertEqual(
            self.ipv6_address.packed,
            bytearray(
                b"\x20\x01\x06\x58\x02\x2a\xca\xfe" b"\x02\x00\x00\x00\x00\x00\x00\x01"
            ),
        )
        self.assertEqual(
            ipaddress.IPv6Interface("ffff:2:3:4:ffff::").packed,
            bytearray(b"\xff\xff\x00\x02\x00\x03\x00\x04\xff\xff")
            + bytearray(b"\x00") * 6,
        )
        self.assertEqual(
            ipaddress.IPv6Interface("::1:0:0:0:0").packed,
            bytearray(b"\x00") * 6 + bytearray(b"\x00\x01") + bytearray(b"\x00") * 8,
        )

    def testIpType(self):
        ipv4net = ipaddress.ip_network("1.2.3.4")
        ipv4addr = ipaddress.ip_address("1.2.3.4")
        ipv6net = ipaddress.ip_network("::1.2.3.4")
        ipv6addr = ipaddress.ip_address("::1.2.3.4")
        self.assertEqual(ipaddress.IPv4Network, type(ipv4net))
        self.assertEqual(ipaddress.IPv4Address, type(ipv4addr))
        self.assertEqual(ipaddress.IPv6Network, type(ipv6net))
        self.assertEqual(ipaddress.IPv6Address, type(ipv6addr))

    def testReservedIpv4(self):
        # test networks
        self.assertEqual(True, ipaddress.ip_interface("224.1.1.1/31").is_multicast)
        self.assertEqual(False, ipaddress.ip_network("240.0.0.0").is_multicast)
        self.assertEqual(True, ipaddress.ip_network("240.0.0.0").is_reserved)

        self.assertEqual(True, ipaddress.ip_interface("192.168.1.1/17").is_private)
        self.assertEqual(False, ipaddress.ip_network("192.169.0.0").is_private)
        self.assertEqual(True, ipaddress.ip_network("10.255.255.255").is_private)
        self.assertEqual(False, ipaddress.ip_network("11.0.0.0").is_private)
        self.assertEqual(False, ipaddress.ip_network("11.0.0.0").is_reserved)
        self.assertEqual(True, ipaddress.ip_network("172.31.255.255").is_private)
        self.assertEqual(False, ipaddress.ip_network("172.32.0.0").is_private)
        self.assertEqual(True, ipaddress.ip_network("169.254.1.0/24").is_link_local)

        self.assertEqual(
            True, ipaddress.ip_interface("169.254.100.200/24").is_link_local
        )
        self.assertEqual(
            False, ipaddress.ip_interface("169.255.100.200/24").is_link_local
        )

        self.assertEqual(True, ipaddress.ip_network("127.100.200.254/32").is_loopback)
        self.assertEqual(True, ipaddress.ip_network("127.42.0.0/16").is_loopback)
        self.assertEqual(False, ipaddress.ip_network("128.0.0.0").is_loopback)
        self.assertEqual(False, ipaddress.ip_network("100.64.0.0/10").is_private)
        self.assertEqual(False, ipaddress.ip_network("100.64.0.0/10").is_global)

        self.assertEqual(True, ipaddress.ip_network("192.0.2.128/25").is_private)
        self.assertEqual(True, ipaddress.ip_network("192.0.3.0/24").is_global)

        # test addresses
        self.assertEqual(True, ipaddress.ip_address("0.0.0.0").is_unspecified)
        self.assertEqual(True, ipaddress.ip_address("224.1.1.1").is_multicast)
        self.assertEqual(False, ipaddress.ip_address("240.0.0.0").is_multicast)
        self.assertEqual(True, ipaddress.ip_address("240.0.0.1").is_reserved)
        self.assertEqual(False, ipaddress.ip_address("239.255.255.255").is_reserved)

        self.assertEqual(True, ipaddress.ip_address("192.168.1.1").is_private)
        self.assertEqual(False, ipaddress.ip_address("192.169.0.0").is_private)
        self.assertEqual(True, ipaddress.ip_address("10.255.255.255").is_private)
        self.assertEqual(False, ipaddress.ip_address("11.0.0.0").is_private)
        self.assertEqual(True, ipaddress.ip_address("172.31.255.255").is_private)
        self.assertEqual(False, ipaddress.ip_address("172.32.0.0").is_private)

        self.assertEqual(True, ipaddress.ip_address("169.254.100.200").is_link_local)
        self.assertEqual(False, ipaddress.ip_address("169.255.100.200").is_link_local)

        self.assertEqual(True, ipaddress.ip_address("127.100.200.254").is_loopback)
        self.assertEqual(True, ipaddress.ip_address("127.42.0.0").is_loopback)
        self.assertEqual(False, ipaddress.ip_address("128.0.0.0").is_loopback)
        self.assertEqual(True, ipaddress.ip_network("0.0.0.0").is_unspecified)

    def testReservedIpv6(self):

        self.assertEqual(True, ipaddress.ip_network("ffff::").is_multicast)
        self.assertEqual(True, ipaddress.ip_network(2 ** 128 - 1).is_multicast)
        self.assertEqual(True, ipaddress.ip_network("ff00::").is_multicast)
        self.assertEqual(False, ipaddress.ip_network("fdff::").is_multicast)

        self.assertEqual(True, ipaddress.ip_network("fecf::").is_site_local)
        self.assertEqual(
            True, ipaddress.ip_network("feff:ffff:ffff:ffff::").is_site_local
        )
        self.assertEqual(False, ipaddress.ip_network("fbf:ffff::").is_site_local)
        self.assertEqual(False, ipaddress.ip_network("ff00::").is_site_local)

        self.assertEqual(True, ipaddress.ip_network("fc00::").is_private)
        self.assertEqual(True, ipaddress.ip_network("fc00:ffff:ffff:ffff::").is_private)
        self.assertEqual(False, ipaddress.ip_network("fbff:ffff::").is_private)
        self.assertEqual(False, ipaddress.ip_network("fe00::").is_private)

        self.assertEqual(True, ipaddress.ip_network("fea0::").is_link_local)
        self.assertEqual(True, ipaddress.ip_network("febf:ffff::").is_link_local)
        self.assertEqual(False, ipaddress.ip_network("fe7f:ffff::").is_link_local)
        self.assertEqual(False, ipaddress.ip_network("fec0::").is_link_local)

        self.assertEqual(True, ipaddress.ip_interface("0:0::0:01").is_loopback)
        self.assertEqual(False, ipaddress.ip_interface("::1/127").is_loopback)
        self.assertEqual(False, ipaddress.ip_network("::").is_loopback)
        self.assertEqual(False, ipaddress.ip_network("::2").is_loopback)

        self.assertEqual(True, ipaddress.ip_network("0::0").is_unspecified)
        self.assertEqual(False, ipaddress.ip_network("::1").is_unspecified)
        self.assertEqual(False, ipaddress.ip_network("::/127").is_unspecified)

        self.assertEqual(True, ipaddress.ip_network("2001::1/128").is_private)
        self.assertEqual(True, ipaddress.ip_network("200::1/128").is_global)
        # test addresses
        self.assertEqual(True, ipaddress.ip_address("ffff::").is_multicast)
        self.assertEqual(True, ipaddress.ip_address(2 ** 128 - 1).is_multicast)
        self.assertEqual(True, ipaddress.ip_address("ff00::").is_multicast)
        self.assertEqual(False, ipaddress.ip_address("fdff::").is_multicast)

        self.assertEqual(True, ipaddress.ip_address("fecf::").is_site_local)
        self.assertEqual(
            True, ipaddress.ip_address("feff:ffff:ffff:ffff::").is_site_local
        )
        self.assertEqual(False, ipaddress.ip_address("fbf:ffff::").is_site_local)
        self.assertEqual(False, ipaddress.ip_address("ff00::").is_site_local)

        self.assertEqual(True, ipaddress.ip_address("fc00::").is_private)
        self.assertEqual(True, ipaddress.ip_address("fc00:ffff:ffff:ffff::").is_private)
        self.assertEqual(False, ipaddress.ip_address("fbff:ffff::").is_private)
        self.assertEqual(False, ipaddress.ip_address("fe00::").is_private)

        self.assertEqual(True, ipaddress.ip_address("fea0::").is_link_local)
        self.assertEqual(True, ipaddress.ip_address("febf:ffff::").is_link_local)
        self.assertEqual(False, ipaddress.ip_address("fe7f:ffff::").is_link_local)
        self.assertEqual(False, ipaddress.ip_address("fec0::").is_link_local)

        self.assertEqual(True, ipaddress.ip_address("0:0::0:01").is_loopback)
        self.assertEqual(True, ipaddress.ip_address("::1").is_loopback)
        self.assertEqual(False, ipaddress.ip_address("::2").is_loopback)

        self.assertEqual(True, ipaddress.ip_address("0::0").is_unspecified)
        self.assertEqual(False, ipaddress.ip_address("::1").is_unspecified)

        # some generic IETF reserved addresses
        self.assertEqual(True, ipaddress.ip_address("100::").is_reserved)
        self.assertEqual(True, ipaddress.ip_network("4000::1/128").is_reserved)

    def testIpv4Mapped(self):
        self.assertEqual(
            ipaddress.ip_address("::ffff:192.168.1.1").ipv4_mapped,
            ipaddress.ip_address("192.168.1.1"),
        )
        self.assertEqual(ipaddress.ip_address("::c0a8:101").ipv4_mapped, None)
        self.assertEqual(
            ipaddress.ip_address("::ffff:c0a8:101").ipv4_mapped,
            ipaddress.ip_address("192.168.1.1"),
        )

    def testAddrExclude(self):
        addr1 = ipaddress.ip_network("10.1.1.0/24")
        addr2 = ipaddress.ip_network("10.1.1.0/26")
        addr3 = ipaddress.ip_network("10.2.1.0/24")
        addr4 = ipaddress.ip_address("10.1.1.0")
        addr5 = ipaddress.ip_network("2001:db8::0/32")
        self.assertEqual(
            sorted(list(addr1.address_exclude(addr2))),
            [
                ipaddress.ip_network("10.1.1.64/26"),
                ipaddress.ip_network("10.1.1.128/25"),
            ],
        )
        self.assertRaises(ValueError, list, addr1.address_exclude(addr3))
        self.assertRaises(TypeError, list, addr1.address_exclude(addr4))
        self.assertRaises(TypeError, list, addr1.address_exclude(addr5))
        self.assertEqual(list(addr1.address_exclude(addr1)), [])

    def testHash(self):
        self.assertEqual(
            hash(ipaddress.ip_interface("10.1.1.0/24")),
            hash(ipaddress.ip_interface("10.1.1.0/24")),
        )
        self.assertEqual(
            hash(ipaddress.ip_network("10.1.1.0/24")),
            hash(ipaddress.ip_network("10.1.1.0/24")),
        )
        self.assertEqual(
            hash(ipaddress.ip_address("10.1.1.0")),
            hash(ipaddress.ip_address("10.1.1.0")),
        )
        # i70
        self.assertEqual(
            hash(ipaddress.ip_address("1.2.3.4")),
            hash(ipaddress.ip_address(int(ipaddress.ip_address("1.2.3.4")._ip))),
        )
        ip1 = ipaddress.ip_address("10.1.1.0")
        ip2 = ipaddress.ip_address("1::")
        dummy = {}
        dummy[self.ipv4_address] = None
        dummy[self.ipv6_address] = None
        dummy[ip1] = None
        dummy[ip2] = None
        self.assertIn(self.ipv4_address, dummy)
        self.assertIn(ip2, dummy)

    def testIPBases(self):
        net = self.ipv4_network
        self.assertEqual("1.2.3.0/24", net.compressed)
        net = self.ipv6_network
        self.assertRaises(ValueError, net._string_from_ip_int, 2 ** 128 + 1)

    def testIPv6NetworkHelpers(self):
        net = self.ipv6_network
        self.assertEqual("2001:658:22a:cafe::/64", net.with_prefixlen)
        self.assertEqual("2001:658:22a:cafe::/ffff:ffff:ffff:ffff::", net.with_netmask)
        self.assertEqual("2001:658:22a:cafe::/::ffff:ffff:ffff:ffff", net.with_hostmask)
        self.assertEqual("2001:658:22a:cafe::/64", str(net))

    def testIPv4NetworkHelpers(self):
        net = self.ipv4_network
        self.assertEqual("1.2.3.0/24", net.with_prefixlen)
        self.assertEqual("1.2.3.0/255.255.255.0", net.with_netmask)
        self.assertEqual("1.2.3.0/0.0.0.255", net.with_hostmask)
        self.assertEqual("1.2.3.0/24", str(net))

    def testCopyConstructor(self):
        addr1 = ipaddress.ip_network("10.1.1.0/24")
        addr2 = ipaddress.ip_network(addr1)
        addr3 = ipaddress.ip_interface("2001:658:22a:cafe:200::1/64")
        addr4 = ipaddress.ip_interface(addr3)
        addr5 = ipaddress.IPv4Address("1.1.1.1")
        addr6 = ipaddress.IPv6Address("2001:658:22a:cafe:200::1")

        self.assertEqual(addr1, addr2)
        self.assertEqual(addr3, addr4)
        self.assertEqual(addr5, ipaddress.IPv4Address(addr5))
        self.assertEqual(addr6, ipaddress.IPv6Address(addr6))

    def testCompressIPv6Address(self):
        test_addresses = {
            "1:2:3:4:5:6:7:8": "1:2:3:4:5:6:7:8/128",
            "2001:0:0:4:0:0:0:8": "2001:0:0:4::8/128",
            "2001:0:0:4:5:6:7:8": "2001::4:5:6:7:8/128",
            "2001:0:3:4:5:6:7:8": "2001:0:3:4:5:6:7:8/128",
            "2001:0:3:4:5:6:7:8": "2001:0:3:4:5:6:7:8/128",
            "0:0:3:0:0:0:0:ffff": "0:0:3::ffff/128",
            "0:0:0:4:0:0:0:ffff": "::4:0:0:0:ffff/128",
            "0:0:0:0:5:0:0:ffff": "::5:0:0:ffff/128",
            "1:0:0:4:0:0:7:8": "1::4:0:0:7:8/128",
            "0:0:0:0:0:0:0:0": "::/128",
            "0:0:0:0:0:0:0:0/0": "::/0",
            "0:0:0:0:0:0:0:1": "::1/128",
            "2001:0658:022a:cafe:0000:0000:0000:0000/66": "2001:658:22a:cafe::/66",
            "::1.2.3.4": "::102:304/128",
            "1:2:3:4:5:ffff:1.2.3.4": "1:2:3:4:5:ffff:102:304/128",
            "::7:6:5:4:3:2:1": "0:7:6:5:4:3:2:1/128",
            "::7:6:5:4:3:2:0": "0:7:6:5:4:3:2:0/128",
            "7:6:5:4:3:2:1::": "7:6:5:4:3:2:1:0/128",
            "0:6:5:4:3:2:1::": "0:6:5:4:3:2:1:0/128",
        }
        for uncompressed, compressed in list(test_addresses.items()):
            self.assertEqual(compressed, str(ipaddress.IPv6Interface(uncompressed)))

    def testExplodeShortHandIpStr(self):
        addr1 = ipaddress.IPv6Interface("2001::1")
        addr2 = ipaddress.IPv6Address("2001:0:5ef5:79fd:0:59d:a0e5:ba1")
        addr3 = ipaddress.IPv6Network("2001::/96")
        addr4 = ipaddress.IPv4Address("192.168.178.1")
        self.assertEqual("2001:0000:0000:0000:0000:0000:0000:0001/128", addr1.exploded)
        self.assertEqual(
            "0000:0000:0000:0000:0000:0000:0000:0001/128",
            ipaddress.IPv6Interface("::1/128").exploded,
        )
        # issue 77
        self.assertEqual("2001:0000:5ef5:79fd:0000:059d:a0e5:0ba1", addr2.exploded)
        self.assertEqual("2001:0000:0000:0000:0000:0000:0000:0000/96", addr3.exploded)
        self.assertEqual("192.168.178.1", addr4.exploded)

    def testIntRepresentation(self):
        self.assertEqual(16909060, int(self.ipv4_address))
        self.assertEqual(42540616829182469433547762482097946625, int(self.ipv6_address))

    def testForceVersion(self):
        self.assertEqual(ipaddress.ip_network(1).version, 4)
        self.assertEqual(ipaddress.IPv6Network(1).version, 6)

    def testWithStar(self):
        self.assertEqual(self.ipv4_interface.with_prefixlen, "1.2.3.4/24")
        self.assertEqual(self.ipv4_interface.with_netmask, "1.2.3.4/255.255.255.0")
        self.assertEqual(self.ipv4_interface.with_hostmask, "1.2.3.4/0.0.0.255")

        self.assertEqual(
            self.ipv6_interface.with_prefixlen, "2001:658:22a:cafe:200::1/64"
        )
        self.assertEqual(
            self.ipv6_interface.with_netmask,
            "2001:658:22a:cafe:200::1/ffff:ffff:ffff:ffff::",
        )
        # this probably don't make much sense, but it's included for
        # compatibility with ipv4
        self.assertEqual(
            self.ipv6_interface.with_hostmask,
            "2001:658:22a:cafe:200::1/::ffff:ffff:ffff:ffff",
        )

    def testNetworkElementCaching(self):
        # V4 - make sure we're empty
        self.assertNotIn("network_address", self.ipv4_network._cache)
        self.assertNotIn("broadcast_address", self.ipv4_network._cache)
        self.assertNotIn("hostmask", self.ipv4_network._cache)

        # V4 - populate and test
        self.assertEqual(
            self.ipv4_network.network_address, ipaddress.IPv4Address("1.2.3.0")
        )
        self.assertEqual(
            self.ipv4_network.broadcast_address, ipaddress.IPv4Address("1.2.3.255")
        )
        self.assertEqual(self.ipv4_network.hostmask, ipaddress.IPv4Address("0.0.0.255"))

        # V4 - check we're cached
        self.assertIn("broadcast_address", self.ipv4_network._cache)
        self.assertIn("hostmask", self.ipv4_network._cache)

        # V6 - make sure we're empty
        self.assertNotIn("broadcast_address", self.ipv6_network._cache)
        self.assertNotIn("hostmask", self.ipv6_network._cache)

        # V6 - populate and test
        self.assertEqual(
            self.ipv6_network.network_address,
            ipaddress.IPv6Address("2001:658:22a:cafe::"),
        )
        self.assertEqual(
            self.ipv6_interface.network.network_address,
            ipaddress.IPv6Address("2001:658:22a:cafe::"),
        )

        self.assertEqual(
            self.ipv6_network.broadcast_address,
            ipaddress.IPv6Address("2001:658:22a:cafe:ffff:ffff:ffff:ffff"),
        )
        self.assertEqual(
            self.ipv6_network.hostmask, ipaddress.IPv6Address("::ffff:ffff:ffff:ffff")
        )
        self.assertEqual(
            self.ipv6_interface.network.broadcast_address,
            ipaddress.IPv6Address("2001:658:22a:cafe:ffff:ffff:ffff:ffff"),
        )
        self.assertEqual(
            self.ipv6_interface.network.hostmask,
            ipaddress.IPv6Address("::ffff:ffff:ffff:ffff"),
        )

        # V6 - check we're cached
        self.assertIn("broadcast_address", self.ipv6_network._cache)
        self.assertIn("hostmask", self.ipv6_network._cache)
        self.assertIn("broadcast_address", self.ipv6_interface.network._cache)
        self.assertIn("hostmask", self.ipv6_interface.network._cache)

    def testTeredo(self):
        # stolen from wikipedia
        server = ipaddress.IPv4Address("65.54.227.120")
        client = ipaddress.IPv4Address("192.0.2.45")
        teredo_addr = "2001:0000:4136:e378:8000:63bf:3fff:fdd2"
        self.assertEqual((server, client), ipaddress.ip_address(teredo_addr).teredo)
        bad_addr = "2000::4136:e378:8000:63bf:3fff:fdd2"
        self.assertFalse(ipaddress.ip_address(bad_addr).teredo)
        bad_addr = "2001:0001:4136:e378:8000:63bf:3fff:fdd2"
        self.assertFalse(ipaddress.ip_address(bad_addr).teredo)

        # i77
        teredo_addr = ipaddress.IPv6Address("2001:0:5ef5:79fd:0:59d:a0e5:ba1")
        self.assertEqual(
            (
                ipaddress.IPv4Address("94.245.121.253"),
                ipaddress.IPv4Address("95.26.244.94"),
            ),
            teredo_addr.teredo,
        )

    def testsixtofour(self):
        sixtofouraddr = ipaddress.ip_address("2002:ac1d:2d64::1")
        bad_addr = ipaddress.ip_address("2000:ac1d:2d64::1")
        self.assertEqual(
            ipaddress.IPv4Address("172.29.45.100"), sixtofouraddr.sixtofour
        )
        self.assertFalse(bad_addr.sixtofour)