Merge pull request #70 from alphagov/mobile-number-validation

Mobile number validation

app/main/forms.py

@@ -1,3 +1,4 @@
+import re
 from flask_wtf import Form
 
 from wtforms import (
@@ -24,11 +25,48 @@ def email_address():
         Regexp(regex=gov_uk_email, message='Enter a gov.uk email address')])
 
 
+class UKMobileNumber(StringField):
+
+    def pre_validate(self, form):
+
+        self.data = self.data.replace('(', '')
+        self.data = self.data.replace(')', '')
+        self.data = self.data.replace(' ', '')
+        self.data = self.data.replace('-', '')
+
+        if self.data.startswith('+'):
+            self.data = self.data[1:]
+
+        if not sum(
+            self.data.startswith(prefix) for prefix in ['07', '447', '4407', '00447']
+        ):
+            raise ValidationError('Must be a UK mobile number (eg 07700 900460)')
+
+        for digit in self.data:
+            try:
+                int(digit)
+            except(ValueError):
+                raise ValidationError('Must not contain letters or symbols')
+
+        self.data = self.data.split('7', 1)[1]
+
+        if len(self.data) > 9:
+            raise ValidationError('Too many digits')
+
+        if len(self.data) < 9:
+            raise ValidationError('Not enough digits')
+
+    def post_validate(self, form, validation_stopped):
+
+        if len(self.data) != 9:
+            return
+
+        self.data = '+44 7{} {} {}'.format(*re.findall('...', self.data))
+
+
 def mobile_number():
-    mobile_number_regex = "^\\+44[\\d]{10}$"
+    return UKMobileNumber('Mobile phone number',
-    return StringField('Mobile phone number',
+                          validators=[DataRequired(message='Cannot be empty')])
-                       validators=[DataRequired(message='Mobile number can not be empty'),
-                                   Regexp(regex=mobile_number_regex, message='Enter a +44 mobile number')])
 
 
 def password(label='Create a password'):

tests/app/main/test_phone_number_form_field.py

@@ -0,0 +1,75 @@
+import pytest
+from wtforms import Form
+from app.main.forms import UKMobileNumber
+
+
+class FormExample(Form):
+    phone_number = UKMobileNumber()
+
+invalid_phone_numbers = sum([
+    [
+        (phone_number, error) for phone_number in group
+    ] for error, group in [
+        ('Too many digits', (
+            '0712345678910',
+            '0044712345678910',
+            '0044712345678910',
+            '+44 (0)7123 456 789 10',
+        )),
+        ('Not enough digits', (
+            '0712345678',
+            '004471234567',
+            '00447123456',
+            '+44 (0)7123 456 78',
+        )),
+        ('Must be a UK mobile number (eg 07700 900460)', (
+            '08081 570364',
+            '+44 8081 570364',
+            '0117 496 0860',
+            '+44 117 496 0860',
+            '020 7946 0991',
+            '+44 20 7946 0991',
+            '71234567890',
+        )),
+        ('Must not contain letters or symbols', (
+            '07890x32109',
+            '07123 456789...',
+            '07123 ☟☜⬇⬆☞☝',
+            '07123☟☜⬇⬆☞☝',
+            '07";DROP TABLE;"',
+            '+44 07ab cde fgh',
+        ))
+    ]
+], [])
+
+valid_phone_numbers = [
+    '07123456789',
+    '07123 456789',
+    '07123-456-789',
+    '00447123456789',
+    '00 44 7123456789',
+    '+447123456789',
+    '+44 7123 456 789',
+    '+44 (0)7123 456 789'
+]
+
+
+@pytest.mark.parametrize("phone_number", valid_phone_numbers)
+def test_phone_number_accepts_valid_values(phone_number):
+    form = FormExample(phone_number=phone_number)
+    form.validate()
+    assert form.errors == {}
+
+
+@pytest.mark.parametrize("phone_number, error_message", invalid_phone_numbers)
+def test_phone_number_rejects_invalid_values(phone_number, error_message):
+    form = FormExample(phone_number=phone_number)
+    form.validate()
+    assert form.phone_number.errors[0] == error_message
+
+
+@pytest.mark.parametrize("phone_number", valid_phone_numbers)
+def test_phone_number_outputs_in_correct_format(phone_number):
+    form = FormExample(phone_number=phone_number)
+    form.validate()
+    assert form.phone_number.data == '+44 7123 456 789'

tests/app/main/views/test_code_not_received.py

@@ -67,7 +67,7 @@ def test_should_check_and_redirect_to_verify(notifications_admin,
                 session['user_email'] = user.email_address
                 verify_codes_dao.add_code(user.id, code='12345', code_type='sms')
             response = client.post(url_for('main.check_and_resend_text_code'),
-                                   data={'mobile_number': '+441234123412'})
+                                   data={'mobile_number': '+447700900460'})
             assert response.status_code == 302
             assert response.location == url_for('main.verify', _external=True)
 
@@ -103,11 +103,11 @@ def test_should_update_mobile_number_resend_code(notifications_admin,
                 session['user_email'] = user.email_address
                 verify_codes_dao.add_code(user_id=user.id, code='12345', code_type='sms')
             response = client.post(url_for('main.check_and_resend_text_code'),
-                                   data={'mobile_number': '+443456789012'})
+                                   data={'mobile_number': '+447700900460'})
             assert response.status_code == 302
             assert response.location == url_for('main.verify', _external=True)
             updated_user = users_dao.get_user_by_id(user.id)
-            assert updated_user.mobile_number == '+443456789012'
+            assert updated_user.mobile_number == '+44 7700 900 460'
 
 
 def test_should_render_verification_code_not_received(notifications_admin,

tests/app/main/views/test_register.py

@@ -13,7 +13,7 @@ def test_process_register_creates_new_user(notifications_admin, notifications_ad
     response = notifications_admin.test_client().post('/register',
                                                       data={'name': 'Some One Valid',
                                                             'email_address': 'someone@example.gov.uk',
-                                                            'mobile_number': '+441231231231',
+                                                            'mobile_number': '+4407700900460',
                                                             'password': 'validPassword!'})
     assert response.status_code == 302
     assert response.location == 'http://localhost/verify'
@@ -31,7 +31,7 @@ def test_process_register_returns_400_when_mobile_number_is_invalid(notification
                                                             'password': 'validPassword!'})
 
     assert response.status_code == 200
-    assert 'Enter a +44 mobile number' in response.get_data(as_text=True)
+    assert 'Must be a UK mobile number (eg 07700 900460)' in response.get_data(as_text=True)
 
 
 def test_should_return_400_when_email_is_not_gov_uk(notifications_admin,
@@ -55,7 +55,7 @@ def test_should_add_verify_codes_on_session(notifications_admin, notifications_a
         response = client.post('/register',
                                data={'name': 'Test Codes',
                                      'email_address': 'test_codes@example.gov.uk',
-                                     'mobile_number': '+441234567890',
+                                     'mobile_number': '+4407700900460',
                                      'password': 'validPassword!'})
         assert response.status_code == 302
         assert 'notify_admin_session' in response.headers.get('Set-Cookie')