Debian Codegraph @

tests/utils_tests/test_ipv6.py

raw
1 import traceback
2 from decimal import Decimal
3 from io import StringIO
4 from ipaddress import IPv6Address
5
6 from django.core.exceptions import ValidationError
7 from django.test import SimpleTestCase
8 from django.utils.ipv6 import (
9 MAX_IPV6_ADDRESS_LENGTH,
10 clean_ipv6_address,
11 is_valid_ipv6_address,
12 )
13
14
15 class TestUtilsIPv6(SimpleTestCase):
16 def test_validates_correct_plain_address(self):
17 self.assertTrue(is_valid_ipv6_address("fe80::223:6cff:fe8a:2e8a"))
18 self.assertTrue(is_valid_ipv6_address("2a02::223:6cff:fe8a:2e8a"))
19 self.assertTrue(is_valid_ipv6_address("1::2:3:4:5:6:7"))
20 self.assertTrue(is_valid_ipv6_address("::"))
21 self.assertTrue(is_valid_ipv6_address("::a"))
22 self.assertTrue(is_valid_ipv6_address("2::"))
23
24 def test_validates_correct_with_v4mapping(self):
25 self.assertTrue(is_valid_ipv6_address("::ffff:254.42.16.14"))
26 self.assertTrue(is_valid_ipv6_address("::ffff:0a0a:0a0a"))
27
28 def test_validates_correct_with_ipv6_instance(self):
29 cases = [
30 IPv6Address("::ffff:2.125.160.216"),
31 IPv6Address("fe80::1"),
32 IPv6Address("::"),
33 ]
34 for case in cases:
35 with self.subTest(case=case):
36 self.assertIs(is_valid_ipv6_address(case), True)
37
38 def test_validates_incorrect_plain_address(self):
39 self.assertFalse(is_valid_ipv6_address("foo"))
40 self.assertFalse(is_valid_ipv6_address("127.0.0.1"))
41 self.assertFalse(is_valid_ipv6_address("12345::"))
42 self.assertFalse(is_valid_ipv6_address("1::2:3::4"))
43 self.assertFalse(is_valid_ipv6_address("1::zzz"))
44 self.assertFalse(is_valid_ipv6_address("1::2:3:4:5:6:7:8"))
45 self.assertFalse(is_valid_ipv6_address("1:2"))
46 self.assertFalse(is_valid_ipv6_address("1:::2"))
47 self.assertFalse(is_valid_ipv6_address("fe80::223: 6cff:fe8a:2e8a"))
48 self.assertFalse(is_valid_ipv6_address("2a02::223:6cff :fe8a:2e8a"))
49
50 def test_validates_incorrect_with_v4mapping(self):
51 self.assertFalse(is_valid_ipv6_address("::ffff:999.42.16.14"))
52 self.assertFalse(is_valid_ipv6_address("::ffff:zzzz:0a0a"))
53 # The ::1.2.3.4 format used to be valid but was deprecated
54 # in RFC 4291 section 2.5.5.1.
55 self.assertTrue(is_valid_ipv6_address("::254.42.16.14"))
56 self.assertTrue(is_valid_ipv6_address("::0a0a:0a0a"))
57 self.assertFalse(is_valid_ipv6_address("::999.42.16.14"))
58 self.assertFalse(is_valid_ipv6_address("::zzzz:0a0a"))
59
60 def test_validates_incorrect_with_non_string(self):
61 cases = [None, [], {}, (), Decimal("2.46"), 192.168, 42]
62 for case in cases:
63 with self.subTest(case=case):
64 self.assertIs(is_valid_ipv6_address(case), False)
65
66 def test_cleans_plain_address(self):
67 self.assertEqual(clean_ipv6_address("DEAD::0:BEEF"), "dead::beef")
68 self.assertEqual(
69 clean_ipv6_address("2001:000:a:0000:0:fe:fe:beef"), "2001:0:a::fe:fe:beef"
70 )
71 self.assertEqual(
72 clean_ipv6_address("2001::a:0000:0:fe:fe:beef"), "2001:0:a::fe:fe:beef"
73 )
74
75 def test_cleans_with_v4_mapping(self):
76 self.assertEqual(clean_ipv6_address("::ffff:0a0a:0a0a"), "::ffff:10.10.10.10")
77 self.assertEqual(clean_ipv6_address("::ffff:1234:1234"), "::ffff:18.52.18.52")
78 self.assertEqual(clean_ipv6_address("::ffff:18.52.18.52"), "::ffff:18.52.18.52")
79 self.assertEqual(clean_ipv6_address("::ffff:0.52.18.52"), "::ffff:0.52.18.52")
80 self.assertEqual(clean_ipv6_address("::ffff:0.0.0.0"), "::ffff:0.0.0.0")
81
82 def test_unpacks_ipv4(self):
83 self.assertEqual(
84 clean_ipv6_address("::ffff:0a0a:0a0a", unpack_ipv4=True), "10.10.10.10"
85 )
86 self.assertEqual(
87 clean_ipv6_address("::ffff:1234:1234", unpack_ipv4=True), "18.52.18.52"
88 )
89 self.assertEqual(
90 clean_ipv6_address("::ffff:18.52.18.52", unpack_ipv4=True), "18.52.18.52"
91 )
92
93 def test_address_too_long(self):
94 addresses = [
95 "0000:0000:0000:0000:0000:ffff:192.168.100.228", # IPv4-mapped IPv6 address
96 "0000:0000:0000:0000:0000:ffff:192.168.100.228%123456", # % scope/zone
97 "fe80::223:6cff:fe8a:2e8a:1234:5678:00000", # MAX_IPV6_ADDRESS_LENGTH + 1
98 ]
99 msg = "This is the error message."
100 value_error_msg = "Unable to convert %s to an IPv6 address (value too long)."
101 for addr in addresses:
102 with self.subTest(addr=addr):
103 self.assertGreater(len(addr), MAX_IPV6_ADDRESS_LENGTH)
104 self.assertEqual(is_valid_ipv6_address(addr), False)
105 with self.assertRaisesMessage(ValidationError, msg) as ctx:
106 clean_ipv6_address(addr, error_message=msg)
107 exception_traceback = StringIO()
108 traceback.print_exception(ctx.exception, file=exception_traceback)
109 self.assertIn(value_error_msg % addr, exception_traceback.getvalue())