refactor tests

tests/web_api/e2e/test_auth.py

@@ -1,107 +1,112 @@
-from http import HTTPStatus as status
-from uuid import uuid4
+from typing import Final
 
+from dirty_equals import IsDict, IsPartialDict, IsStr
 from dishka import FromDishka
-from httpx import AsyncClient, Response
 
+from tests.web_api.helpers import (
+    is_conflict_response,
+    is_not_found_response,
+    is_success_response,
+    is_unauthorized_response,
+)
 from tests.web_api.ioc import DatabaseClearer, inject
+from tests.web_api.test_api_gateway import TestApiGateway
 
-DEFAULT_PASSWORD = "Sup3rSecret"  # noqa: S105
-
-
-async def _sign_up_email(client: AsyncClient, email: str, password: str = DEFAULT_PASSWORD) -> None:
-    response = await client.post(
-        "/auth/sign_up/email",
-        json={"email": email, "password": password},
-    )
-    assert response.status_code == status.OK, response.text
-
-
-async def _sign_in_email(client: AsyncClient, email: str, password: str = DEFAULT_PASSWORD) -> Response:
-    return await client.post(
-        "/auth/sign_in/email",
-        json={"email": email, "password": password},
-    )
-
-
-def _unique_email() -> str:
-    return f"user-{uuid4().hex}@example.com"
+DEFAULT_PASSWORD: Final = "Sup3rPuperS3cret"  # noqa: S105
 
 
 @inject
 async def test_email_sign_up_creates_user(
-    http_client: FromDishka[AsyncClient],
+    unique_email: str,
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
-    email = _unique_email()
 
-    response = await http_client.post(
-        "/auth/sign_up/email",
-        json={"email": email, "password": DEFAULT_PASSWORD},
+    response = await test_api_gateway.sign_up_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
+    )
+    assert is_success_response(response)
+    assert response.json() == IsPartialDict(
+        access_token=IsStr()
     )
-    body = response.json()
-
-    assert response.status_code == status.OK
-    assert isinstance(body["access_token"], str)
-    assert body["access_token"]
 
 
 @inject
 async def test_email_sign_up_existing_user_conflict(
-    http_client: FromDishka[AsyncClient],
+    unique_email: str,
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
-    email = _unique_email()
-    await _sign_up_email(http_client, email)
 
-    response = await http_client.post(
-        "/auth/sign_up/email",
-        json={"email": email, "password": DEFAULT_PASSWORD},
+    await test_api_gateway.sign_up_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
     )
 
-    assert response.status_code == status.CONFLICT
+    response = await test_api_gateway.sign_up_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
+    )
+    assert is_conflict_response(response)
 
 
 @inject
 async def test_email_sign_in_returns_token(
-    http_client: FromDishka[AsyncClient],
+    unique_email: str,
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
-    email = _unique_email()
-    await _sign_up_email(http_client, email)
 
-    response = await _sign_in_email(http_client, email)
-    body = response.json()
+    await test_api_gateway.sign_up_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
+    )
 
-    assert response.status_code == status.OK
-    assert isinstance(body["access_token"], str)
-    assert body["access_token"]
+    response = await test_api_gateway.sign_in_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
+    )
+    assert is_success_response(response)
+    assert response.json() == IsDict(
+        access_token=IsStr,
+    )
 
 
 @inject
 async def test_email_sign_in_invalid_password(
-    http_client: FromDishka[AsyncClient],
+    unique_email: str,
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
-    email = _unique_email()
-    await _sign_up_email(http_client, email)
 
-    response = await _sign_in_email(http_client, email, password="wrong-password")
+    await test_api_gateway.sign_up_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
+    )
 
-    assert response.status_code == status.UNAUTHORIZED
+    response = await test_api_gateway.sign_in_email(
+        email=unique_email,
+        password="wrong-password",
+    )
+    assert is_unauthorized_response(response)
 
 
 @inject
 async def test_email_sign_in_user_not_found(
-    http_client: FromDishka[AsyncClient],
+    unique_email: str,
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
 
-    response = await _sign_in_email(http_client, email=_unique_email())
+    response = await test_api_gateway.sign_in_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
+    )
 
-    assert response.status_code == status.NOT_FOUND
+    assert is_not_found_response(response)

tests/web_api/e2e/test_healthcheck.py

@@ -1,8 +1,8 @@
-from http import HTTPStatus as status
-
+from dirty_equals import IsDict
 from dishka import FromDishka
 from httpx import AsyncClient
 
+from tests.web_api.helpers import is_success_response
 from tests.web_api.ioc import inject
 
 
@@ -11,7 +11,9 @@ async def test_healthcheck(
     http_client: FromDishka[AsyncClient],
 ) -> None:
     response = await http_client.get("/healthcheck")
-    response_json = response.json()
-
-    assert response.status_code == status.OK
-    assert response_json["ok"]
+    assert is_success_response(response)
+    assert response.json() == IsDict(
+        {
+            "ok": True,
+        }
+    )

tests/web_api/e2e/test_profile.py

@@ -1,108 +1,87 @@
-from collections.abc import Mapping
-from http import HTTPStatus as status
-from uuid import uuid4
+from typing import Final
 
+from dirty_equals import IsDict, IsPartialDict
 from dishka import FromDishka
-from httpx import AsyncClient, Response
 
+from tests.web_api.helpers import is_forbidden_response, is_success_response
 from tests.web_api.ioc import DatabaseClearer, inject
+from tests.web_api.test_api_gateway import TestApiGateway
 
-DEFAULT_PASSWORD = "Sup3rSecret"  # noqa: S105
-
-
-def _unique_email() -> str:
-    return f"user-{uuid4().hex}@example.com"
-
-
-def _auth_headers(token: str) -> Mapping[str, str]:
-    return {"Authorization": f"Bearer {token}"}
-
-
-async def _sign_up_and_get_token(client: AsyncClient, email: str) -> str:
-    response = await client.post(
-        "/auth/sign_up/email",
-        json={"email": email, "password": DEFAULT_PASSWORD},
-    )
-    assert response.status_code == status.OK, response.text
-    body = response.json()
-    return str(body["access_token"])
-
-
-async def _get_profile(client: AsyncClient, token: str) -> Response:
-    return await client.get("/profile", headers=_auth_headers(token))
-
-
-async def _patch_profile(
-    client: AsyncClient,
-    token: str,
-    payload: Mapping[str, str | None],
-) -> Response:
-    return await client.patch("/profile", headers=_auth_headers(token), json=payload)
+DEFAULT_PASSWORD: Final = "Sup3rSecret"  # noqa: S105
 
 
 @inject
 async def test_get_profile_returns_current_user(
-    http_client: FromDishka[AsyncClient],
+    unique_email: str,
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
-    email = _unique_email()
-    token = await _sign_up_and_get_token(http_client, email)
 
-    response = await _get_profile(http_client, token)
-    body = response.json()
+    response_sign_up = await test_api_gateway.sign_up_email(unique_email, DEFAULT_PASSWORD)
+    access_token = response_sign_up.json()["access_token"]
 
-    assert response.status_code == status.OK
-    assert body["email"] == email
-    assert body["display_name"] is None
+    response = await test_api_gateway.get_profile(access_token)
+    assert is_success_response(response)
+    assert response.json() == IsPartialDict(
+        email=unique_email,
+        display_name=None,
+    )
 
 
 @inject
 async def test_patch_profile_updates_profile_data(
-    http_client: FromDishka[AsyncClient],
+    unique_email: str,
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
-    email = _unique_email()
-    token = await _sign_up_and_get_token(http_client, email)
 
-    payload = {
-        "display_name": "Alice",
-        "first_name": "Alice",
-        "last_name": "Smith",
-        "avatar_url": "https://example.com/avatar.png",
-        "phone": "+1234567890",
-    }
-    patch_response = await _patch_profile(http_client, token, payload)
-    patch_body = patch_response.json()
+    response = await test_api_gateway.sign_up_email(
+        email=unique_email,
+        password=DEFAULT_PASSWORD,
+    )
+    access_token = response.json()["access_token"]
 
-    assert patch_response.status_code == status.OK
-    assert patch_body["display_name"] == payload["display_name"]
-    assert patch_body["first_name"] == payload["first_name"]
-    assert patch_body["last_name"] == payload["last_name"]
-    assert patch_body["avatar_url"] == payload["avatar_url"]
-    assert patch_body["phone"] == payload["phone"]
-    assert patch_body["email"] == email
+    patch_response = await test_api_gateway.patch_profile(
+        access_token=access_token,
+        display_name="Alice",
+        first_name="Alice",
+        last_name="Smith",
+        avatar_url="https://example.com/avatar.png",
+        phone="+1234567890",
+    )
+    assert is_success_response(patch_response)
+    assert patch_response.json() == IsPartialDict(
+        display_name="Alice",
+        first_name="Alice",
+        last_name="Smith",
+        avatar_url="https://example.com/avatar.png",
+        phone="+1234567890",
+        email=unique_email,
+    )
 
-    get_response = await _get_profile(http_client, token)
-    get_body = get_response.json()
-
-    assert get_body["display_name"] == payload["display_name"]
-    assert get_body["first_name"] == payload["first_name"]
-    assert get_body["last_name"] == payload["last_name"]
-    assert get_body["avatar_url"] == payload["avatar_url"]
-    assert get_body["phone"] == payload["phone"]
+    get_response = await test_api_gateway.get_profile(access_token)
+    assert is_success_response(get_response)
+    assert get_response.json() == IsPartialDict(
+        display_name="Alice",
+        first_name="Alice",
+        last_name="Smith",
+        avatar_url="https://example.com/avatar.png",
+        phone="+1234567890",
+        email=unique_email,
+    )
 
 
 @inject
 async def test_profile_routes_require_authentication(
-    http_client: FromDishka[AsyncClient],
+    test_api_gateway: FromDishka[TestApiGateway],
     database_clearer: FromDishka[DatabaseClearer],
 ) -> None:
     await database_clearer.clear()
 
-    response_get = await http_client.get("/profile")
-    response_patch = await http_client.patch("/profile", json={})
+    response_get = await test_api_gateway.get_profile(None)
+    assert is_forbidden_response(response_get)
 
-    assert response_get.status_code == status.FORBIDDEN
-    assert response_patch.status_code == status.FORBIDDEN
+    response_patch = await test_api_gateway.patch_profile()
+    assert is_forbidden_response(response_patch)