enhance phone number validation to enforce E.164 format and update tests

Author: pcrespov

packages/models-library/src/models_library/api_schemas_webserver/users.py

@@ -213,7 +213,7 @@ def _validate_user_name(cls, value: str):
 #
 
 
-PhoneNumberStr: TypeAlias = Annotated[str, PhoneNumberValidator()]
+PhoneNumberStr: TypeAlias = Annotated[str, PhoneNumberValidator(number_format="E164")]
 
 
 class MyPhoneRegister(InputSchema):

packages/models-library/tests/test_users.py

@@ -43,6 +43,20 @@ def test_valid_phone_numbers(phone: str):
     ).validate_python(phone)
 
 
+@pytest.mark.parametrize(
+    "phone",
+    [
+        "+41763456789",
+        "+41 76 345 67 89",
+        "tel:+41-76-345-67-89",
+    ],
+    ids=["E.164", "INTERNATIONAL", "RFC3966"],
+)
+def test_autoformat_phone_number_to_e164(phone: str):
+    # This test is used to tune options of PhoneNumberValidator formatting to E164
+    assert TypeAdapter(PhoneNumberStr).validate_python(phone) == "+41763456789"
+
+
 @pytest.mark.parametrize(
     "phone",
     ["41763456789", "+09104630364", "+1 111-304-4567"],

services/web/server/tests/conftest.py

@@ -157,10 +157,11 @@ async def user(client: TestClient) -> AsyncIterator[UserInfoDict]:
 
 @pytest.fixture
 def user_phone(faker: Faker) -> PhoneNumberStr:
-    phone = faker.phone_number()
+    phone = faker.random_element(["+41763456789", "+19104630364", "+13013044567"])
     tail = f"{faker.pyint(100, 999)}"
-    valid_phone = phone[: -len(tail)] + tail  # ensure phone is 10 digits long
-    return TypeAdapter(PhoneNumberStr).validate_python(valid_phone)
+    valid_phone = phone[: -len(tail)] + tail  # ensure phone keeps its length
+    assert TypeAdapter(PhoneNumberStr).validate_python(valid_phone) == valid_phone
+    return valid_phone
 
 
 @pytest.fixture