from django.core.exceptions import ValidationError from django.forms import GenericIPAddressField from django.test import SimpleTestCase from django.utils.ipv6 import MAX_IPV6_ADDRESS_LENGTH class GenericIPAddressFieldTest(SimpleTestCase): def test_generic_ipaddress_invalid_arguments(self): with self.assertRaises(ValueError): GenericIPAddressField(protocol="hamster") with self.assertRaises(ValueError): GenericIPAddressField(protocol="ipv4", unpack_ipv4=True) def test_generic_ipaddress_as_generic(self): # The edge cases of the IPv6 validation code are not deeply tested # here, they are covered in the tests for django.utils.ipv6 f = GenericIPAddressField() with self.assertRaisesMessage(ValidationError, "'This field is required.'"): f.clean("") with self.assertRaisesMessage(ValidationError, "'This field is required.'"): f.clean(None) self.assertEqual(f.clean(" 127.0.0.1 "), "127.0.0.1") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("foo") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("127.0.0.") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("1.2.3.4.5") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("256.125.1.5") self.assertEqual( f.clean(" fe80::223:6cff:fe8a:2e8a "), "fe80::223:6cff:fe8a:2e8a" ) self.assertEqual( f.clean(" 2a02::223:6cff:fe8a:2e8a "), "2a02::223:6cff:fe8a:2e8a" ) with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("12345:2:3:4") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1::2:3::4") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("foo::223:6cff:fe8a:2e8a") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1::2:3:4:5:6:7:8") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1:2") def test_generic_ipaddress_as_ipv4_only(self): f = GenericIPAddressField(protocol="IPv4") with self.assertRaisesMessage(ValidationError, "'This field is required.'"): f.clean("") with self.assertRaisesMessage(ValidationError, "'This field is required.'"): f.clean(None) self.assertEqual(f.clean(" 127.0.0.1 "), "127.0.0.1") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv4 address.'"): f.clean("foo") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv4 address.'"): f.clean("127.0.0.") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv4 address.'"): f.clean("1.2.3.4.5") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv4 address.'"): f.clean("256.125.1.5") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv4 address.'"): f.clean("fe80::223:6cff:fe8a:2e8a") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv4 address.'"): f.clean("2a02::223:6cff:fe8a:2e8a") def test_generic_ipaddress_as_ipv6_only(self): f = GenericIPAddressField(protocol="IPv6") with self.assertRaisesMessage(ValidationError, "'This field is required.'"): f.clean("") with self.assertRaisesMessage(ValidationError, "'This field is required.'"): f.clean(None) with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv6 address.'"): f.clean("127.0.0.1") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv6 address.'"): f.clean("foo") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv6 address.'"): f.clean("127.0.0.") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv6 address.'"): f.clean("1.2.3.4.5") with self.assertRaisesMessage(ValidationError, "'Enter a valid IPv6 address.'"): f.clean("256.125.1.5") self.assertEqual( f.clean(" fe80::223:6cff:fe8a:2e8a "), "fe80::223:6cff:fe8a:2e8a" ) self.assertEqual( f.clean(" 2a02::223:6cff:fe8a:2e8a "), "2a02::223:6cff:fe8a:2e8a" ) with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("12345:2:3:4") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1::2:3::4") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("foo::223:6cff:fe8a:2e8a") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1::2:3:4:5:6:7:8") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1:2") def test_generic_ipaddress_max_length_custom(self): # Valid IPv4-mapped IPv6 address, len 45. addr = "0000:0000:0000:0000:0000:ffff:192.168.100.228" f = GenericIPAddressField(max_length=len(addr)) f.clean(addr) def test_generic_ipaddress_max_length_validation_error(self): # Valid IPv4-mapped IPv6 address, len 45. addr = "0000:0000:0000:0000:0000:ffff:192.168.100.228" cases = [ ({}, MAX_IPV6_ADDRESS_LENGTH), # Default value. ({"max_length": len(addr) - 1}, len(addr) - 1), ] for kwargs, max_length in cases: max_length_plus_one = max_length + 1 msg = ( f"Ensure this value has at most {max_length} characters (it has " f"{max_length_plus_one}).'" ) with self.subTest(max_length=max_length): f = GenericIPAddressField(**kwargs) with self.assertRaisesMessage(ValidationError, msg): f.clean("x" * max_length_plus_one) with self.assertRaisesMessage( ValidationError, "This is not a valid IPv6 address." ): f.clean(addr) def test_generic_ipaddress_as_generic_not_required(self): f = GenericIPAddressField(required=False) self.assertEqual(f.clean(""), "") self.assertEqual(f.clean(None), "") self.assertEqual(f.clean("127.0.0.1"), "127.0.0.1") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("foo") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("127.0.0.") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("1.2.3.4.5") with self.assertRaisesMessage( ValidationError, "'Enter a valid IPv4 or IPv6 address.'" ): f.clean("256.125.1.5") self.assertEqual( f.clean(" fe80::223:6cff:fe8a:2e8a "), "fe80::223:6cff:fe8a:2e8a" ) self.assertEqual( f.clean(" " * MAX_IPV6_ADDRESS_LENGTH + " 2a02::223:6cff:fe8a:2e8a "), "2a02::223:6cff:fe8a:2e8a", ) with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("12345:2:3:4") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1::2:3::4") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("foo::223:6cff:fe8a:2e8a") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1::2:3:4:5:6:7:8") with self.assertRaisesMessage( ValidationError, "'This is not a valid IPv6 address.'" ): f.clean("1:2") def test_generic_ipaddress_normalization(self): # Test the normalizing code f = GenericIPAddressField() self.assertEqual(f.clean(" ::ffff:0a0a:0a0a "), "::ffff:10.10.10.10") self.assertEqual(f.clean(" ::ffff:10.10.10.10 "), "::ffff:10.10.10.10") self.assertEqual( f.clean(" 2001:000:a:0000:0:fe:fe:beef "), "2001:0:a::fe:fe:beef" ) self.assertEqual( f.clean(" 2001::a:0000:0:fe:fe:beef "), "2001:0:a::fe:fe:beef" ) f = GenericIPAddressField(unpack_ipv4=True) self.assertEqual(f.clean(" ::ffff:0a0a:0a0a"), "10.10.10.10")