Merge pull request #695 from maykinmedia/feature/1558-add-phonenumber…

…-validation-to-contactform

[#1558] Add phonenumber validation

src/open_inwoner/accounts/forms.py

@@ -17,11 +17,7 @@
 from open_inwoner.configurations.models import SiteConfiguration
 from open_inwoner.pdc.models.category import Category
 from open_inwoner.utils.forms import LimitedUploadFileField, PrivateFileWidget
-from open_inwoner.utils.validators import (
-    CharFieldValidator,
-    format_phone_number,
-    validate_phone_number,
-)
+from open_inwoner.utils.validators import CharFieldValidator, DutchPhoneNumberValidator
 
 from .choices import (
     ContactTypeChoices,
@@ -71,24 +67,14 @@ class PhoneNumberForm(forms.Form):
         help_text=_(
             "Vermeld bij niet-nederlandse telefoonnummers de landcode (bijvoorbeeld: +32 1234567890)"
         ),
-        validators=[
-            validate_phone_number,
-        ],
+        validators=[DutchPhoneNumberValidator()],
     )
     phonenumber_2 = forms.CharField(
         label=_("Mobiele telefoonnummer bevestigen"),
         max_length=16,
-        validators=[
-            validate_phone_number,
-        ],
+        validators=[DutchPhoneNumberValidator()],
     )
 
-    def clean_phonenumber_1(self):
-        return format_phone_number(self.cleaned_data["phonenumber_1"])
-
-    def clean_phonenumber_2(self):
-        return format_phone_number(self.cleaned_data["phonenumber_2"])
-
     def clean(self):
         cleaned_data = super().clean()
 
@@ -134,9 +120,6 @@ def __init__(self, *args, **kwargs):
         else:
             self.fields["phonenumber"].required = True
 
-    def clean_phonenumber(self):
-        return format_phone_number(self.cleaned_data["phonenumber"])
-
     def clean_email(self):
         email = self.cleaned_data["email"]
 

src/open_inwoner/accounts/migrations/0063_alter_user_phonenumber.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.15 on 2023-06-26 07:52
+
+from django.db import migrations, models
+
+import open_inwoner.utils.validators
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("accounts", "0062_alter_user_deactivated_on"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="user",
+            name="phonenumber",
+            field=models.CharField(
+                blank=True,
+                default="",
+                max_length=15,
+                validators=[open_inwoner.utils.validators.DutchPhoneNumberValidator()],
+                verbose_name="Phonenumber",
+            ),
+        ),
+    ]

src/open_inwoner/accounts/models.py

@@ -18,7 +18,7 @@
 from timeline_logger.models import TimelineLog
 
 from open_inwoner.utils.hash import create_sha256_hash
-from open_inwoner.utils.validators import CharFieldValidator, validate_phone_number
+from open_inwoner.utils.validators import CharFieldValidator, DutchPhoneNumberValidator
 
 from ..plans.models import PlanContact
 from .choices import ContactTypeChoices, LoginTypeChoices, StatusChoices, TypeChoices
@@ -78,7 +78,7 @@ class User(AbstractBaseUser, PermissionsMixin):
         blank=True,
         default="",
         max_length=15,
-        validators=[validate_phone_number],
+        validators=[DutchPhoneNumberValidator()],
     )
     image = ImageCropField(
         verbose_name=_("Image"),

src/open_inwoner/accounts/tests/factories.py

@@ -23,7 +23,7 @@ class Meta:
         lambda o: "%s%d@example.com" % (o.first_name, random.randint(0, 10000000))
     )
     password = factory.PostGenerationMethodCall("set_password", "secret")
-    phonenumber = factory.Faker("numerify", text="06########")
+    phonenumber = factory.Faker("numerify", text="061#######")
 
 
 class DigidUserFactory(UserFactory):

src/open_inwoner/accounts/tests/test_auth_2fa_sms.py

@@ -407,9 +407,7 @@ def test_login_by_adding_phone_number_succeeds(self, mock_gateway_send):
         phonenumber1_response = phonenumber1_form.submit()
 
         self.assertContains(phonenumber1_response, "Account verificatie (stap 2 van 2)")
-        mock_gateway_send.assert_called_with(
-            to=format_phone_number("0643465651"), token=ANY
-        )
+        mock_gateway_send.assert_called_with(to="0643465651", token=ANY)
 
         sent_token = mock_gateway_send.call_args[1]["token"]
 
@@ -419,7 +417,7 @@ def test_login_by_adding_phone_number_succeeds(self, mock_gateway_send):
 
         self.user.refresh_from_db()
 
-        self.assertEqual(self.user.phonenumber, "+31643465651")
+        self.assertEqual(self.user.phonenumber, "0643465651")
         self.assertRedirects(phonenumber2_response, str(settings.LOGIN_REDIRECT_URL))
 
     @patch("open_inwoner.accounts.gateways.gateway.send")

src/open_inwoner/accounts/tests/test_profile_views.py

@@ -240,7 +240,7 @@ def test_save_filled_form(self):
         form["last_name"] = "Last name"
         form["display_name"] = "a nickname"
         form["email"] = "user@example.com"
-        form["phonenumber"] = "06987878787"
+        form["phonenumber"] = "0612345678"
         form["birthday"] = "21-01-1992"
         form["street"] = "Keizersgracht"
         form["housenumber"] = "17 d"
@@ -326,7 +326,7 @@ def test_form_for_digid_brp_user_saves_data(self):
 
         form["display_name"] = "a nickname"
         form["email"] = "user@example.com"
-        form["phonenumber"] = "06987878787"
+        form["phonenumber"] = "0612345678"
         response = form.submit()
 
         self.assertEqual(response.url, self.return_url)
@@ -335,7 +335,7 @@ def test_form_for_digid_brp_user_saves_data(self):
 
         self.assertEqual(user.display_name, "a nickname")
         self.assertEqual(user.email, "user@example.com")
-        self.assertEqual(user.phonenumber, "06987878787")
+        self.assertEqual(user.phonenumber, "0612345678")
 
     def test_expected_form_is_rendered(self):
         # regular user
@@ -422,7 +422,7 @@ def test_modify_phone_and_email_updates_klant_api(self, m):
 
         form = response.forms["profile-edit"]
         form["email"] = "new@example.com"
-        form["phonenumber"] = "01234456789"
+        form["phonenumber"] = "0612345678"
         form.submit()
 
         # user data tested in other cases
@@ -433,7 +433,7 @@ def test_modify_phone_and_email_updates_klant_api(self, m):
             klant_patch_data,
             {
                 "emailadres": "new@example.com",
-                "telefoonnummer": "01234456789",
+                "telefoonnummer": "0612345678",
             },
         )
         self.assertTimelineLog("retrieved klant for BSN-user")
@@ -472,7 +472,7 @@ def test_modify_phone_updates_klant_api_but_skip_unchanged_email(self, m):
         self.resetTimelineLogs()
 
         form = response.forms["profile-edit"]
-        form["phonenumber"] = "01234456789"
+        form["phonenumber"] = "0612345678"
         form.submit()
 
         # user data tested in other cases
@@ -482,7 +482,7 @@ def test_modify_phone_updates_klant_api_but_skip_unchanged_email(self, m):
         self.assertEqual(
             klant_patch_data,
             {
-                "telefoonnummer": "01234456789",
+                "telefoonnummer": "0612345678",
             },
         )
         self.assertTimelineLog("retrieved klant for BSN-user")

src/open_inwoner/configurations/migrations/0045_alter_siteconfiguration_footer_visiting_phonenumber.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.15 on 2023-06-27 10:33
+
+from django.db import migrations, models
+
+import open_inwoner.utils.validators
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("configurations", "0044_siteconfiguration_openid_display"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="siteconfiguration",
+            name="footer_visiting_phonenumber",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="Visiting phonenumber on the footer section.",
+                max_length=15,
+                validators=[open_inwoner.utils.validators.DutchPhoneNumberValidator()],
+                verbose_name="Footer visiting phonenumber",
+            ),
+        ),
+    ]

src/open_inwoner/configurations/models.py

@@ -9,7 +9,7 @@
 from ordered_model.models import OrderedModel, OrderedModelManager
 from solo.models import SingletonModel
 
-from open_inwoner.utils.validators import validate_phone_number
+from open_inwoner.utils.validators import DutchPhoneNumberValidator
 
 from ..utils.colors import hex_to_hsl
 from ..utils.validators import FilerExactImageSizeValidator
@@ -220,7 +220,7 @@ class SiteConfiguration(SingletonModel):
         max_length=15,
         default="",
         blank=True,
-        validators=[validate_phone_number],
+        validators=[DutchPhoneNumberValidator()],
         verbose_name=_("Footer visiting phonenumber"),
         help_text=_("Visiting phonenumber on the footer section."),
     )

src/open_inwoner/openklant/forms.py

@@ -4,7 +4,7 @@
 
 from open_inwoner.accounts.models import User
 from open_inwoner.openklant.models import ContactFormSubject, OpenKlantConfig
-from open_inwoner.utils.validators import validate_phone_number
+from open_inwoner.utils.validators import DutchPhoneNumberValidator
 
 
 class ContactForm(Form):
@@ -36,7 +36,7 @@ class ContactForm(Form):
     phonenumber = forms.CharField(
         label=_("Telefoonnummer"),
         max_length=15,
-        validators=[validate_phone_number],
+        validators=[DutchPhoneNumberValidator()],
         required=False,
     )
     question = forms.CharField(

src/open_inwoner/openklant/tests/test_contactform.py

@@ -214,7 +214,7 @@ def test_submit_and_register_via_email(self, m):
         form["infix"] = "de"
         form["last_name"] = "Bar"
         form["email"] = "foo@example.com"
-        form["phonenumber"] = "0612345678"
+        form["phonenumber"] = "+31612345678"
         form["question"] = "hey!\n\nwaddup?"
 
         response = form.submit().follow()
@@ -233,7 +233,7 @@ def test_submit_and_register_via_email(self, m):
         self.assertEqual(email.recipients(), ["example@example.com"])
         self.assertIn("Foo de Bar", email.body)
         self.assertIn("foo@example.com", email.body)
-        self.assertIn("0612345678", email.body)
+        self.assertIn("+31612345678", email.body)
         self.assertIn("hey!\n\nwaddup?", email.body)
 
         self.assertTimelineLog("registered contactmoment by email")
@@ -260,7 +260,7 @@ def test_submit_and_register_anon_via_api_with_klant(self, m):
         form["infix"] = "de"
         form["last_name"] = "Bar"
         form["email"] = "foo@example.com"
-        form["phonenumber"] = "0612345678"
+        form["phonenumber"] = "+31612345678"
         form["question"] = "hey!\n\nwaddup?"
 
         response = form.submit().follow()
@@ -284,7 +284,7 @@ def test_submit_and_register_anon_via_api_with_klant(self, m):
                 "voorvoegselAchternaam": "de",
                 "achternaam": "Bar",
                 "emailadres": "foo@example.com",
-                "telefoonnummer": "0612345678",
+                "telefoonnummer": "+31612345678",
             },
         )
         contactmoment_create_data = data.matchers[1].request_history[0].json()
@@ -331,7 +331,7 @@ def test_submit_and_register_anon_via_api_without_klant(self, m):
         form["infix"] = "de"
         form["last_name"] = "Bar"
         form["email"] = "foo@example.com"
-        form["phonenumber"] = "0612345678"
+        form["phonenumber"] = "+31612345678"
         form["question"] = "hey!\n\nwaddup?"
 
         response = form.submit().follow()
@@ -358,7 +358,7 @@ def test_submit_and_register_anon_via_api_without_klant(self, m):
 
         Naam: Foo de Bar
         Email: foo@example.com
-        Telefoonnummer: 0612345678
+        Telefoonnummer: +31612345678
         """
         )
 

src/open_inwoner/pdc/migrations/0057_auto_20230623_1523.py

@@ -0,0 +1,49 @@
+# Generated by Django 3.2.15 on 2023-06-23 13:23
+
+from django.db import migrations, models
+
+import open_inwoner.utils.validators
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("pdc", "0056_alter_category_options"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="organization",
+            name="phonenumber",
+            field=models.CharField(
+                blank=True,
+                help_text="The phone number of the organization",
+                max_length=15,
+                validators=[open_inwoner.utils.validators.DutchPhoneNumberValidator()],
+                verbose_name="Phonenumber",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="productcontact",
+            name="phonenumber",
+            field=models.CharField(
+                blank=True,
+                help_text="The phone number of the product contact",
+                max_length=15,
+                validators=[open_inwoner.utils.validators.DutchPhoneNumberValidator()],
+                verbose_name="Phonenumber",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="productlocation",
+            name="phonenumber",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="The phonenumber of the current location",
+                max_length=15,
+                validators=[open_inwoner.utils.validators.DutchPhoneNumberValidator()],
+                verbose_name="Phonenumber",
+            ),
+        ),
+    ]

src/open_inwoner/pdc/models/organization.py

@@ -3,7 +3,7 @@
 
 from filer.fields.image import FilerImageField
 
-from open_inwoner.utils.validators import validate_phone_number
+from open_inwoner.utils.validators import DutchPhoneNumberValidator
 
 from .mixins import GeoModel
 
@@ -42,7 +42,7 @@ class Organization(GeoModel):
         verbose_name=_("Phonenumber"),
         blank=True,
         max_length=15,
-        validators=[validate_phone_number],
+        validators=[DutchPhoneNumberValidator()],
         help_text=_("The phone number of the organization"),
     )
     neighbourhood = models.ForeignKey(

src/open_inwoner/pdc/models/product.py

@@ -12,7 +12,7 @@
 from openformsclient.models import OpenFormsSlugField
 from ordered_model.models import OrderedModel
 
-from open_inwoner.utils.validators import validate_phone_number
+from open_inwoner.utils.validators import DutchPhoneNumberValidator
 
 from ..managers import ProductQueryset
 from .mixins import GeoModel
@@ -255,7 +255,7 @@ class ProductContact(models.Model):
         verbose_name=_("Phonenumber"),
         blank=True,
         max_length=15,
-        validators=[validate_phone_number],
+        validators=[DutchPhoneNumberValidator()],
         help_text=_("The phone number of the product contact"),
     )
     role = models.CharField(
@@ -331,7 +331,7 @@ class ProductLocation(GeoModel):
         blank=True,
         default="",
         max_length=15,
-        validators=[validate_phone_number],
+        validators=[DutchPhoneNumberValidator()],
         help_text=_("The phonenumber of the current location"),
     )