from unittest import mock import django import phonenumbers from django import forms from django.core.exceptions import ImproperlyConfigured from django.test import SimpleTestCase, override_settings from django.utils import translation from django.utils.functional import lazy from phonenumbers import COUNTRY_CODES_FOR_NON_GEO_REGIONS from phonenumber_field.formfields import PhoneNumberField, SplitPhoneNumberField from phonenumber_field.phonenumber import PhoneNumber from phonenumber_field.validators import validate_phonenumber from tests.models import ( NullablePhoneNumber, PhoneNumberWithMaxLengthDefault, PhoneNumberWithMaxLengthNullable, ) ALGERIAN_PHONE_NUMBER = "+213799136332" class PhoneNumberFormFieldTest(SimpleTestCase): def test_error_message(self): class PhoneNumberForm(forms.Form): number = PhoneNumberField() form = PhoneNumberForm({"number": "invalid"}) self.assertIs(form.is_valid(), False) self.assertEqual( form.errors, {"number": ["Enter a valid phone number (e.g. +12125552368)."]} ) @override_settings(PHONENUMBER_DEFAULT_REGION="FR") def test_error_message_uses_default_region(self): class PhoneNumberForm(forms.Form): number = PhoneNumberField() form = PhoneNumberForm({"number": "invalid"}) self.assertIs(form.is_valid(), False) self.assertEqual( form.errors, { "number": [ "Enter a valid phone number (e.g. 01 23 45 67 89) " "or a number with an international call prefix." ] }, ) def test_override_error_message(self): class MyPhoneNumberField(PhoneNumberField): default_error_messages = {"invalid": "MY INVALID MESSAGE!"} class PhoneNumberForm(forms.Form): number = MyPhoneNumberField() form = PhoneNumberForm({"number": "invalid"}) self.assertIs(form.is_valid(), False) self.assertEqual(form.errors, {"number": ["MY INVALID MESSAGE!"]}) def test_override_error_message_inline(self): class PhoneNumberForm(forms.Form): number = PhoneNumberField( error_messages={"invalid": "MY INLINE INVALID MESSAGE!"} ) form = PhoneNumberForm({"number": "invalid"}) self.assertIs(form.is_valid(), False) self.assertEqual(form.errors, {"number": ["MY INLINE INVALID MESSAGE!"]}) def test_algerian_phone_number_in_form(self): class PhoneNumberForm(forms.Form): number = PhoneNumberField() form = PhoneNumberForm({"number": ALGERIAN_PHONE_NUMBER}) self.assertTrue(form.is_valid()) self.assertEqual(ALGERIAN_PHONE_NUMBER, form.cleaned_data["number"]) def test_error_message_lazy(self): def fail_gettext(msgid): raise Exception("gettext was called unexpectedly.") with mock.patch( "phonenumber_field.formfields.pgettext_lazy", side_effect=lazy(fail_gettext, str), ): PhoneNumberField() def test_override_widget(self): class MyPhoneNumberField(PhoneNumberField): widget = forms.TextInput class TestForm(forms.Form): phone = MyPhoneNumberField(region="FR") form = TestForm({"phone": "+33612345678"}) self.assertIs(form.is_valid(), True) self.assertHTMLEqual( form.as_p(), """

""", ) @override_settings(PHONENUMBER_DEFAULT_REGION="FR") def test_widget_uses_default_region(self): class TestForm(forms.Form): phone = PhoneNumberField() form = TestForm({"phone": "+33612345678"}) self.assertIs(form.is_valid(), True) self.assertHTMLEqual( form.as_p(), """

""", ) def test_invalid_phone_number(self): class PhoneNumberForm(forms.Form): number = PhoneNumberField() form = PhoneNumberForm({"number": "+11234567890"}) self.assertIs(form.is_valid(), False) self.assertEqual( form.errors, {"number": ["Enter a valid phone number (e.g. +12125552368)."]} ) def test_validate_shortcode(self): class ShortCodePhoneNumberField(PhoneNumberField): default_validators = [validate_phonenumber] class TestForm(forms.Form): phone = ShortCodePhoneNumberField(region="FR") form = TestForm({"phone": "1010"}) self.assertIs(form.is_valid(), True) class SplitPhoneNumberFormFieldTest(SimpleTestCase): def example_number(self, region_code: str) -> PhoneNumber: number = phonenumbers.example_number(region_code) e164 = phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164) return PhoneNumber.from_string(e164, region=region_code) def test_initial_empty(self): class TestForm(forms.Form): phone = SplitPhoneNumberField(region="CN") rendered = str(TestForm()) self.assertIn('', rendered) self.assertIn('', rendered) @override_settings(PHONENUMBER_DEFAULT_REGION="CN") def test_uses_default_region_as_initial(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() rendered = str(TestForm()) self.assertIn('', rendered) self.assertIn('', rendered) def test_no_initial(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() rendered = str(TestForm()) self.assertIn('', rendered) self.assertIn('', rendered) for prefix in COUNTRY_CODES_FOR_NON_GEO_REGIONS: self.assertNotIn(f"+{prefix}", rendered) def test_initial(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() rendered = str( TestForm(initial={"phone": PhoneNumber.from_string("+33612345678")}) ) self.assertIn('', rendered) self.assertIn('', rendered) self.assertIn( '', rendered, ) def test_invalid_phone_number(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() form = TestForm({"phone_0": "US", "phone_1": "1234567890"}) self.assertIs(form.is_valid(), False) self.assertEqual( form.errors, {"phone": ["Enter a valid phone number (e.g. (201) 555-0123)."]}, ) @override_settings(USE_I18N=True) def test_after_translation_deactivate_all(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() translation.deactivate_all() rendered = str(TestForm()) self.assertIn( '', rendered_form, count=1, ) self.assertInHTML( '', rendered_form, count=1, ) def test_empty_national_number(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() form = TestForm(data={"phone_0": "CA", "phone_1": ""}) self.assertFalse(form.is_valid()) rendered_form = form.as_ul() if django.VERSION >= (5, 2): self.assertInHTML( """ """, rendered_form, ) else: self.assertInHTML( '', rendered_form, ) aria_invalid = "" if django.VERSION[0] < 5 else 'aria-invalid="true" ' self.assertInHTML( f'', rendered_form, count=1, ) def test_not_required_empty_data(self): class TestForm(forms.Form): phone = SplitPhoneNumberField(required=False) form = TestForm(data={"phone_0": "", "phone_1": ""}) self.assertIs(form.is_valid(), True) self.assertEqual(form.cleaned_data["phone"], "") def test_no_region(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() form = TestForm(data={"phone_1": "654321"}) self.assertFalse(form.is_valid()) rendered_form = form.as_ul() if django.VERSION >= (5, 2): self.assertInHTML( """ """, rendered_form, ) else: self.assertInHTML( '', rendered_form, ) aria_invalid = "" if django.VERSION[0] < 5 else 'aria-invalid="true" ' self.assertInHTML( f'', rendered_form, count=1, ) self.assertInHTML( '', rendered_form, count=1, ) def test_no_national_number(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() form = TestForm(data={"phone_0": "CA"}) self.assertFalse(form.is_valid()) rendered_form = form.as_ul() if django.VERSION >= (5, 2): self.assertInHTML( """ """, rendered_form, count=1, ) else: self.assertInHTML( '', rendered_form, count=1, ) aria_invalid = "" if django.VERSION[0] < 5 else 'aria-invalid="true" ' self.assertInHTML( f'', rendered_form, count=1, ) def test_not_required_no_data(self): class TestForm(forms.Form): phone = SplitPhoneNumberField(required=False) form = TestForm(data={}) self.assertIs(form.is_valid(), True) self.assertEqual(form.cleaned_data["phone"], "") def test_not_required_empty_value(self): class TestForm(forms.Form): phone = SplitPhoneNumberField(required=False) phone_none = SplitPhoneNumberField(required=False, empty_value=None) form = TestForm(data={}) self.assertIs(form.is_valid(), True) self.assertEqual(form.cleaned_data["phone"], "") self.assertIsNone(form.cleaned_data["phone_none"]) def test_keeps_region_with_invalid_national_number(self): class TestForm(forms.Form): phone = SplitPhoneNumberField() form = TestForm(data={"phone_0": "CA", "phone_1": "0000"}) self.assertFalse(form.is_valid()) rendered_form = str(form) if django.VERSION >= (5, 2): self.assertInHTML( """ """, rendered_form, count=1, ) else: self.assertInHTML( '", rendered_form, ) aria_invalid = "" if django.VERSION[0] < 5 else 'aria-invalid="true" ' self.assertInHTML( f'', rendered_form, count=1, ) self.assertInHTML( '', rendered_form, count=1, ) def test_maxlength_not_in_select(self): # Regression test for #490 class TestForm(forms.Form): phone = SplitPhoneNumberField() rendered = str(TestForm()) self.assertIn('', rendered, ) self.assertInHTML( '', rendered, count=1, ) def test_custom_choices(self): class SplitPhoneNumberFieldWithCountries(SplitPhoneNumberField): def prefix_field(self): return forms.ChoiceField(choices=[("FR", "France"), ("BE", "Belgium")]) class TestForm(forms.Form): phone = SplitPhoneNumberFieldWithCountries() form = TestForm() if django.VERSION[0] < 4: self.assertHTMLEqual( str(form.as_p()), """

""", ) else: self.assertHTMLEqual( form.as_div(), """
Phone:
""", ) def test_invalid_region(self): class PhoneNumberForm(forms.Form): number = SplitPhoneNumberField() form = PhoneNumberForm({"number_0": "NONEXISTENT", "number_1": "+33612345678"}) self.assertIs(form.is_valid(), False) self.assertEqual( form.errors, { "number": [ "Select a valid choice. " "NONEXISTENT is not one of the available choices." ] }, ) @override_settings(PHONENUMBER_DEFAULT_REGION="FR") def test_input_not_cleared_on_other_field_error(self): class PhoneNumberForm(forms.Form): name = forms.CharField(min_length=4, max_length=100) number = SplitPhoneNumberField(required=False) form = PhoneNumberForm({"name": "a", "number_0": "FR", "number_1": "612345678"}) self.assertIs(form.is_valid(), False) self.assertEqual( form.errors, {"name": ["Ensure this value has at least 4 characters (it has 1)."]}, ) form_html = form.as_p() if django.VERSION >= (5, 2): self.assertInHTML( """

""", form_html, count=1, ) else: aria_invalid = "" if django.VERSION[0] < 5 else 'aria-invalid="true" ' self.assertInHTML( f"""

""", form_html, count=1, ) self.assertInHTML( '', form_html, count=1, ) self.assertInHTML( '', form_html, count=1, ) def test_without_babel(self): import phonenumber_field.formfields babel = phonenumber_field.formfields.babel def restore_babel(): phonenumber_field.formfields.babel = babel self.addCleanup(restore_babel) phonenumber_field.formfields.babel = None with self.assertRaises(ImproperlyConfigured): SplitPhoneNumberField() def test_error_message_is_localized(self): class PhoneNumberForm(forms.Form): number = SplitPhoneNumberField() form = PhoneNumberForm({"number_0": "FR", "number_1": "1"}) if django.VERSION >= (5, 2): self.assertIn( '", str(form), ) else: self.assertIn( '", str(form), ) def test_customize_invalid_error_message(self): class CustomSplitPhoneNumberField(SplitPhoneNumberField): def invalid_error_message(self): return "My message using {example_number}." class TestForm(forms.Form): phone = CustomSplitPhoneNumberField() form = TestForm({"phone_0": "FR", "phone_1": "1"}) if django.VERSION >= (5, 2): self.assertInHTML( """ """, str(form), count=1, ) else: self.assertIn( '', str(form), ) def test_clean_handles_invalid_input(self): data = [ # require_all_fields, phone_data, error_message (True, {"phone_0": "", "phone_1": "1234"}, "This field is required."), (True, {}, "This field is required."), (True, {"phone_1": "1234"}, "This field is required."), ( True, {"phone_0": "invalid", "phone_1": "1234"}, "Select a valid choice. invalid is not one of the available choices.", ), (False, {"phone_0": "", "phone_1": "1234"}, "Enter a complete value."), (False, {}, "This field is required."), (False, {"phone_1": "1234"}, "Enter a complete value."), ( False, {"phone_0": "invalid", "phone_1": "1234"}, "Select a valid choice. invalid is not one of the available choices.", ), ] for all_fields_required, phone_data, error_message in data: with self.subTest( f"require_all_fields={all_fields_required}," f"{phone_data=}," f"{error_message=}" ): class TestForm(forms.Form): phone = SplitPhoneNumberField( require_all_fields=all_fields_required ) form = TestForm(phone_data) self.assertIs(form.is_valid(), False) self.assertEqual(form.errors["phone"], [error_message]) def test_validate_shortcode(self): class ShortCodeSplitPhoneNumberField(SplitPhoneNumberField): default_validators = [validate_phonenumber] class TestForm(forms.Form): phone = ShortCodeSplitPhoneNumberField() form = TestForm({"phone_0": "FR", "phone_1": "1010"}) self.assertIs(form.is_valid(), True) def test_formfield_with_maxlength_null(self): class TestForm(forms.Form): def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.fields = forms.fields_for_model( NullablePhoneNumber, ["phone_number"], field_classes={"phone_number": SplitPhoneNumberField}, ) form = TestForm(data={"phone_number_0": "FR", "phone_number_1": "612345678"}) self.assertIs(form.is_valid(), True) self.assertEqual(form.cleaned_data["phone_number"], "+33612345678") def test_formfield_with_max_length_default(self): def make_form(model): class TestForm(forms.Form): def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.fields = forms.fields_for_model( model, ["phone"], field_classes={"phone": SplitPhoneNumberField}, ) return TestForm for model, empty_value in [ (PhoneNumberWithMaxLengthDefault, ""), (PhoneNumberWithMaxLengthNullable, None), ]: TestForm = make_form(model) with self.subTest("no data", model=model): form = TestForm(data={}) self.assertIs(form.is_valid(), True) self.assertEqual(form.cleaned_data["phone"], empty_value) with self.subTest("empty phone number", model=model): form = TestForm(data={"phone_0": "", "phone_1": ""}) self.assertIs(form.is_valid(), True) self.assertEqual(form.cleaned_data["phone"], empty_value) with self.subTest("phone number within max_length", model=model): form = TestForm(data={"phone_0": "AU", "phone_1": "0444444444"}) self.assertIs(form.is_valid(), True) self.assertEqual(form.cleaned_data["phone"], "+61444444444") with self.subTest("phone number exceeding max_length", model=model): form = TestForm(data={"phone_0": "FR", "phone_1": "33612345678"}) self.assertIs(form.is_valid(), False) self.assertEqual( form.errors, { "phone": [ "Ensure this value has no more than 12 characters, " "“6 12 34 56 78” is 13 characters long." ], }, )