split imms_api fixtures

Author: jf-x-dev

mavis/test/fixtures/__init__.py

@@ -1,22 +1,9 @@
-from .helpers import (
-    add_vaccine_batch,
-    file_generator,
-    log_in_as_medical_secretary,
-    log_in_as_nurse,
-    log_in_as_prescriber,
-    schedule_mmr_session_and_get_consent_url,
-    schedule_session_and_get_consent_url,
-    set_feature_flags,
-    setup_session_and_batches_with_fixed_child,
-    upload_offline_vaccination,
-)
-from .models import (
-    authenticate_api,
+from .data_models import (
     children,
     clinics,
     delete_team_after_tests,
+    file_generator,
     healthcare_assistant,
-    imms_base_url,
     medical_secretary,
     nurse,
     onboarding,
@@ -30,6 +17,18 @@
     team,
     year_groups,
 )
+from .helpers import (
+    add_vaccine_batch,
+    log_in_as_medical_secretary,
+    log_in_as_nurse,
+    log_in_as_prescriber,
+    schedule_mmr_session_and_get_consent_url,
+    schedule_session_and_get_consent_url,
+    set_feature_flags,
+    setup_session_and_batches_with_fixed_child,
+    upload_offline_vaccination,
+)
+from .imms_api import authenticate_api, imms_base_url
 from .playwright import (
     base_url,
     basic_auth_credentials,

mavis/test/fixtures/models.py mavis/test/fixtures/data_models.pymavis/test/fixtures/models.py renamed to mavis/test/fixtures/data_models.py

@@ -1,17 +1,15 @@
-import base64
 import logging
 import os
 import random
 import time
 import urllib.parse
-import uuid
 
-import jwt
 import pytest
 import requests
 from faker import Faker
 
 from mavis.test.constants import Programme
+from mavis.test.data.file_generator import FileGenerator
 from mavis.test.data_models import (
     Child,
     Clinic,
@@ -30,6 +28,22 @@
 onboarding_faker.unique.clear()
 
 
+@pytest.fixture(scope="session", autouse=True)
+def delete_team_after_tests(base_url, team):
+    yield
+
+    url = urllib.parse.urljoin(base_url, f"api/testing/teams/{team.workgroup}")
+    response = requests.delete(url, timeout=30)
+    _check_response_status(response)
+
+
+@pytest.fixture(scope="module", autouse=True)
+def reset_before_each_module(base_url, team) -> None:
+    url = urllib.parse.urljoin(base_url, f"api/testing/teams/{team.workgroup}")
+    response = requests.delete(url, params={"keep_itself": "true"}, timeout=30)
+    _check_response_status(response)
+
+
 @pytest.fixture(scope="session")
 def year_groups() -> dict[str, int]:
     return {
@@ -84,22 +98,6 @@ def _check_response_status(response) -> None:
     response.raise_for_status()
 
 
-@pytest.fixture(scope="session", autouse=True)
-def delete_team_after_tests(base_url, team):
-    yield
-
-    url = urllib.parse.urljoin(base_url, f"api/testing/teams/{team.workgroup}")
-    response = requests.delete(url, timeout=30)
-    _check_response_status(response)
-
-
-@pytest.fixture(scope="module", autouse=True)
-def reset_before_each_module(base_url, team) -> None:
-    url = urllib.parse.urljoin(base_url, f"api/testing/teams/{team.workgroup}")
-    response = requests.delete(url, params={"keep_itself": "true"}, timeout=30)
-    _check_response_status(response)
-
-
 @pytest.fixture(scope="session")
 def healthcare_assistant(onboarding) -> User:
     return onboarding.users["healthcare_assistant"]
@@ -157,57 +155,6 @@ def children(year_groups) -> dict[str, list[Child]]:
     )
 
 
-def _read_imms_api_credentials() -> dict[str, str]:
-    return {
-        "pem": os.environ["IMMS_API_PEM"],
-        "key": os.environ["IMMS_API_KEY"],
-        "kid": os.environ["IMMS_API_KID"],
-        "url": os.environ["IMMS_BASE_URL"],
-    }
-
-
-def _get_jwt_payload(api_auth: dict[str, str]) -> str:
-    _kid = api_auth["kid"]
-    _api_key = api_auth["key"]
-    _decoded_pem = base64.b64decode(api_auth["pem"])
-    _auth_endpoint = urllib.parse.urljoin(api_auth["url"], "oauth2-mock/token")
-    headers = {
-        "alg": "RS512",
-        "typ": "JWT",
-        "kid": _kid,
-    }
-    claims = {
-        "sub": _api_key,
-        "iss": _api_key,
-        "jti": str(uuid.uuid4()),
-        "aud": _auth_endpoint,
-        "exp": int(time.time()) + 300,  # 5mins in the future
-    }
-    return jwt.encode(
-        payload=claims,
-        key=_decoded_pem,
-        algorithm="RS512",
-        headers=headers,
-    )
-
-
-@pytest.fixture(scope="session", autouse=False)
-def authenticate_api():
-    _api_auth: dict[str, str] = _read_imms_api_credentials()
-    _endpoint = urllib.parse.urljoin(_api_auth["url"], "oauth2-mock/token")
-    _payload = {
-        "grant_type": "client_credentials",
-        "client_assertion_type": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",  # noqa: E501
-        "client_assertion": _get_jwt_payload(api_auth=_api_auth),
-    }
-    _headers = {"Content-Type": "application/x-www-form-urlencoded"}
-
-    response = requests.post(url=_endpoint, headers=_headers, data=_payload, timeout=30)
-
-    _check_response_status(response=response)
-    return response.json()["access_token"]
-
-
-@pytest.fixture(scope="session")
-def imms_base_url():
-    return os.environ["IMMS_AUTH_URL"]
+@pytest.fixture
+def file_generator(organisation, schools, nurse, children, clinics, year_groups):
+    return FileGenerator(organisation, schools, nurse, children, clinics, year_groups)

mavis/test/fixtures/helpers.py

@@ -4,7 +4,7 @@
 import pytest
 
 from mavis.test.constants import ConsentOption, Programme, Vaccine
-from mavis.test.data import ClassFileMapping, FileGenerator, VaccsFileMapping
+from mavis.test.data import ClassFileMapping, VaccsFileMapping
 from mavis.test.data_models import School
 from mavis.test.pages import (
     AddBatchPage,
@@ -243,8 +243,3 @@ def _setup(programme_group):
             LogInPage(page).log_out()
 
     return _setup
-
-
-@pytest.fixture
-def file_generator(organisation, schools, nurse, children, clinics, year_groups):
-    return FileGenerator(organisation, schools, nurse, children, clinics, year_groups)

mavis/test/fixtures/imms_api.py

@@ -0,0 +1,71 @@
+import base64
+import logging
+import os
+import time
+import urllib.parse
+import uuid
+
+import jwt
+import pytest
+import requests
+
+logger = logging.getLogger(__name__)
+
+
+def _read_imms_api_credentials() -> dict[str, str]:
+    return {
+        "pem": os.environ["IMMS_API_PEM"],
+        "key": os.environ["IMMS_API_KEY"],
+        "kid": os.environ["IMMS_API_KID"],
+        "url": os.environ["IMMS_BASE_URL"],
+    }
+
+
+def _get_jwt_payload(api_auth: dict[str, str]) -> str:
+    _kid = api_auth["kid"]
+    _api_key = api_auth["key"]
+    _decoded_pem = base64.b64decode(api_auth["pem"])
+    _auth_endpoint = urllib.parse.urljoin(api_auth["url"], "oauth2-mock/token")
+    headers = {
+        "alg": "RS512",
+        "typ": "JWT",
+        "kid": _kid,
+    }
+    claims = {
+        "sub": _api_key,
+        "iss": _api_key,
+        "jti": str(uuid.uuid4()),
+        "aud": _auth_endpoint,
+        "exp": int(time.time()) + 300,  # 5mins in the future
+    }
+    return jwt.encode(
+        payload=claims,
+        key=_decoded_pem,
+        algorithm="RS512",
+        headers=headers,
+    )
+
+
+@pytest.fixture(scope="session", autouse=False)
+def authenticate_api():
+    _api_auth: dict[str, str] = _read_imms_api_credentials()
+    _endpoint = urllib.parse.urljoin(_api_auth["url"], "oauth2-mock/token")
+    _payload = {
+        "grant_type": "client_credentials",
+        "client_assertion_type": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",  # noqa: E501
+        "client_assertion": _get_jwt_payload(api_auth=_api_auth),
+    }
+    _headers = {"Content-Type": "application/x-www-form-urlencoded"}
+
+    response = requests.post(url=_endpoint, headers=_headers, data=_payload, timeout=30)
+
+    if not response.ok:
+        logger.warning(response.content)
+    response.raise_for_status()
+
+    return response.json()["access_token"]
+
+
+@pytest.fixture(scope="session")
+def imms_base_url():
+    return os.environ["IMMS_AUTH_URL"]