Debian Codegraph @

tests/test_serializers.py

raw
1 from django.test import SimpleTestCase, override_settings
2 from rest_framework import renderers, serializers
3
4 from phonenumber_field.phonenumber import PhoneNumber
5 from phonenumber_field.serializerfields import PhoneNumberField
6
7 from .models import OptionalPhoneNumber
8
9
10 class PhoneNumberSerializerTest(SimpleTestCase):
11 def test_blank_field(self):
12 class PhoneNumberSerializer(serializers.ModelSerializer):
13 class Meta:
14 model = OptionalPhoneNumber
15 fields = ["phone_number"]
16
17 for data in [{}, {"phone": ""}]:
18 with self.subTest(data):
19 s = PhoneNumberSerializer(data=data)
20 self.assertIs(s.is_valid(), True)
21 self.assertEqual(s.data, {})
22
23 def test_int(self):
24 class PhoneNumberSerializer(serializers.Serializer):
25 phone = PhoneNumberField()
26
27 s = PhoneNumberSerializer(data={"phone": 1})
28 self.assertIs(s.is_valid(), False)
29
30 def test_empty_required(self):
31 class PhoneNumberSerializer(serializers.Serializer):
32 phone = PhoneNumberField()
33
34 serializer = PhoneNumberSerializer(data={"phone": ""})
35 self.assertIs(serializer.is_valid(), False)
36 self.assertEqual(serializer.validated_data, {})
37
38 def test_empty_optional(self):
39 class PhoneNumberSerializer(serializers.Serializer):
40 phone = PhoneNumberField(allow_blank=True)
41
42 serializer = PhoneNumberSerializer(data={"phone": ""})
43 self.assertIs(serializer.is_valid(), True)
44 self.assertEqual(serializer.validated_data, {"phone": ""})
45
46 def test_e164_phone_number(self):
47 class PhoneNumberSerializer(serializers.Serializer):
48 phone = PhoneNumberField()
49
50 serializer = PhoneNumberSerializer(data={"phone": "+33612345678"})
51 self.assertIs(serializer.is_valid(), True)
52 self.assertEqual(serializer.validated_data, {"phone": "+33612345678"})
53 self.assertIsInstance(serializer.validated_data["phone"], PhoneNumber)
54
55 def test_region(self):
56 class PhoneNumberSerializer(serializers.Serializer):
57 phone = PhoneNumberField(region="FR")
58
59 serializer = PhoneNumberSerializer(data={"phone": "0612345678"})
60 self.assertIs(serializer.is_valid(), True)
61 self.assertEqual(serializer.validated_data, {"phone": "+33612345678"})
62 self.assertIsInstance(serializer.validated_data["phone"], PhoneNumber)
63
64 def test_region_invalid(self):
65 class PhoneNumberSerializer(serializers.Serializer):
66 phone = PhoneNumberField(region="GB")
67
68 serializer = PhoneNumberSerializer(data={"phone": "0612345678"})
69 self.assertIs(serializer.is_valid(), False)
70 self.assertEqual(serializer.validated_data, {})
71 self.assertEqual(serializer.errors, {"phone": ["Enter a valid phone number."]})
72
73 @override_settings(PHONENUMBER_DEFAULT_REGION="FR")
74 def test_region_from_settings(self):
75 class PhoneNumberSerializer(serializers.Serializer):
76 phone = PhoneNumberField()
77
78 serializer = PhoneNumberSerializer(data={"phone": "0612345678"})
79 self.assertIs(serializer.is_valid(), True)
80 self.assertEqual(serializer.validated_data, {"phone": "+33612345678"})
81 self.assertIsInstance(serializer.validated_data["phone"], PhoneNumber)
82
83 @override_settings(PHONENUMBER_DEFAULT_REGION="GB")
84 def test_region_kwarg_precedes_setting(self):
85 class PhoneNumberSerializer(serializers.Serializer):
86 phone = PhoneNumberField(region="FR")
87
88 serializer = PhoneNumberSerializer(data={"phone": "0612345678"})
89 self.assertIs(serializer.is_valid(), True)
90 self.assertEqual(serializer.validated_data, {"phone": "+33612345678"})
91 self.assertIsInstance(serializer.validated_data["phone"], PhoneNumber)
92
93 def test_invalid_region(self):
94 with self.assertRaisesMessage(
95 ValueError, "“INVALID” is not a valid region code. Choices are"
96 ):
97
98 class PhoneNumberSerializer(serializers.Serializer):
99 phone = PhoneNumberField(region="INVALID")
100
101 def test_multiple_isvalid_calls(self):
102 class PhoneNumberSerializer(serializers.Serializer):
103 phone = PhoneNumberField()
104
105 serializer = PhoneNumberSerializer(data={"phone": "+33612345678"})
106 self.assertIs(serializer.is_valid(), True)
107 self.assertIs(serializer.is_valid(), True)
108
109 def test_serialization(self):
110 class PhoneNumberSerializer(serializers.Serializer):
111 phone = PhoneNumberField(region="FR")
112
113 for fmt, expected in [
114 ("E164", b"+33612345678"),
115 ("INTERNATIONAL", b"+33 6 12 34 56 78"),
116 ("RFC3966", b"tel:+33-6-12-34-56-78"),
117 ]:
118 with override_settings(PHONENUMBER_DEFAULT_FORMAT=fmt), self.subTest(fmt):
119 serializer = PhoneNumberSerializer(data={"phone": "0612345678"})
120 serializer.is_valid()
121 self.assertEqual(
122 b'{"phone":"%b"}' % expected,
123 renderers.JSONRenderer().render(serializer.data),
124 )