MPT-14713 E2E TDR Proof of concept (#97)

- Moved unit tests from `tests/` to `tests/unit/`
- Added dummy e2e test in `tests/e2e/`
- Updated pytest setup to not run tests mark as e2e
- Added docker image to run e2e tests with `docker compose run --rm e2e`
- Added `pytest-rerunfailures` dev dependency to rerun failed api calls
(flaky tests)
- Update Error handler to handle JSON responses for generic HTTP Errors
(404, 401, ...)
- Added e2e to github actions

Author: albertsola

.env.sample

@@ -0,0 +1,2 @@
+MPT_API_BASE_URL=https://api...
+MPT_API_TOKEN=idt:TKN-...

.github/workflows/pr-build-merge.yml

@@ -26,9 +26,19 @@ jobs:
     - name: "Build test containers"
       run: docker compose build app_test
 
+    - name: "Create environment file"
+      run: touch .env
+
     - name: "Run validation & test"
       run: docker compose run --service-ports app_test
 
+    - name: "Run E2E test"
+      run: docker compose run --service-ports -e MPT_API_BASE_URL=$MPT_API_BASE_URL -e MPT_API_TOKEN=$MPT_API_TOKEN e2e
+      env:
+        MPT_API_BASE_URL: ${{ secrets.MPT_API_BASE_URL }}
+        MPT_API_TOKEN: ${{ secrets.MPT_API_TOKEN }}
+
+
     - name: "Run SonarCloud Scan"
       uses: SonarSource/sonarqube-scan-action@master
       env:

docker-compose.yml

@@ -9,6 +9,8 @@ services:
     tty: true
     volumes:
       - .:/mpt_api_client
+    env_file:
+      - .env
 
   app_test:
     container_name: mpt_api_client_test
@@ -31,6 +33,8 @@ services:
     tty: true
     volumes:
       - .:/mpt_api_client
+    env_file:
+      - .env
 
   format:
     container_name: mpt_api_client_format
@@ -41,3 +45,15 @@ services:
     command: bash -c "ruff check . --select I --fix && ruff format ."
     volumes:
       - .:/mpt_api_client
+
+  e2e:
+    container_name: mpt_api_client_test
+    build:
+      context: .
+      dockerfile: dev.Dockerfile
+    working_dir: /mpt_api_client
+    command: bash -c "pytest -m e2e -p no:randomly --junitxml=e2e-report.xml"
+    volumes:
+      - .:/mpt_api_client
+    env_file:
+      - .env

mpt_api_client/exceptions.py

@@ -11,27 +11,27 @@ class MPTError(Exception):
 class MPTHttpError(MPTError):
     """Represents an HTTP error."""
 
-    def __init__(self, status_code: int, text: str):
+    def __init__(self, status_code: int, message: str, body: str):
         self.status_code = status_code
-        self.text = text
-        super().__init__(f"{self.status_code} - {self.text}")
+        self.body = body
+        super().__init__(f"HTTP {status_code}: {message}")
 
 
 class MPTAPIError(MPTHttpError):
     """Represents an API error."""
 
-    def __init__(self, status_code: int, payload: dict[str, str]):
-        super().__init__(status_code, json.dumps(payload))
+    def __init__(self, status_code: int, message: str, payload: dict[str, str]):
+        super().__init__(status_code, message, json.dumps(payload))
         self.payload = payload
-        self.status: str | None = payload.get("status")
-        self.title: str | None = payload.get("title")
-        self.detail: str | None = payload.get("detail")
+        self.status: str | None = payload.get("status") or payload.get("statusCode")
+        self.title: str | None = payload.get("title") or payload.get("message")
+        self.detail: str | None = payload.get("detail") or message
         self.trace_id: str | None = payload.get("traceId")
         self.errors: str | None = payload.get("errors")
 
     @override
     def __str__(self) -> str:
-        base = f"{self.status} {self.title} - {self.detail} ({self.trace_id})"
+        base = f"{self.status} {self.title} - {self.detail} ({self.trace_id or 'no-trace-id'})"  # noqa: WPS221 WPS237
 
         if self.errors:
             return f"{base}\n{json.dumps(self.errors, indent=2)}"
@@ -57,11 +57,13 @@ def transform_http_status_exception(http_status_exception: HTTPStatusError) -> M
     try:
         return MPTAPIError(
             status_code=http_status_exception.response.status_code,
+            message=http_status_exception.args[0],
             payload=http_status_exception.response.json(),
         )
     except json.JSONDecodeError:
-        payload = http_status_exception.response.content.decode()
+        body = http_status_exception.response.content.decode()
         return MPTHttpError(
             status_code=http_status_exception.response.status_code,
-            text=payload,
+            message=http_status_exception.args[0],
+            body=body,
         )

pyproject.toml

@@ -37,10 +37,11 @@ dev = [
     "pytest-deadfixtures==2.2.*",
     "pytest-mock==3.14.*",
     "pytest-randomly==3.16.*",
+    "pytest-rerunfailures>=16.1",
     "pytest-xdist==3.6.*",
     "responses==0.25.*",
     "respx==0.22.*",
-    "ruff==0.12.11",  # force ruff version to have same formatting everywhere
+    "ruff==0.12.11", # force ruff version to have same formatting everywhere
     "typing-extensions==4.13.*",
     "wemake-python-styleguide==1.3.*",
 ]
@@ -58,13 +59,17 @@ build-backend = "hatchling.build"
 [tool.pytest.ini_options]
 testpaths = "tests"
 pythonpath = "."
-addopts = "--cov=mpt_api_client --cov-report=term-missing --cov-report=html --cov-report=xml --import-mode=importlib"
+addopts = "--cov=mpt_api_client --cov-report=term-missing --cov-report=html --cov-report=xml --import-mode=importlib -m 'not e2e'"
 log_cli = false
 asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
 filterwarnings = [
     "ignore:Support for class-based `config` is deprecated:DeprecationWarning",
     "ignore:pkg_resources is deprecated as an API:DeprecationWarning",
 ]
+markers = [
+  "e2e: marks tests as e2e"
+]
 
 [tool.coverage.run]
 branch = true

setup.cfg

@@ -40,15 +40,15 @@ per-file-ignores =
   mpt_api_client/resources/catalog/*.py: WPS110 WPS214 WPS215
   mpt_api_client/resources/catalog/products.py: WPS204 WPS214 WPS215
   mpt_api_client/rql/query_builder.py: WPS110 WPS115 WPS210 WPS214
-  tests/http/test_async_service.py: WPS204 WPS202
-  tests/http/test_service.py: WPS204 WPS202
-  tests/http/test_mixins.py: WPS204 WPS202
-  tests/resources/catalog/test_products.py: WPS202 WPS210
-  tests/resources/*/test_mixins.py: WPS118 WPS202 WPS204 WPS235
-  tests/resources/accounts/test_users.py: WPS204 WPS202 WPS210
-  tests/test_mpt_client.py: WPS235
-
-  tests/*:
+  tests/unit/http/test_async_service.py: WPS204 WPS202
+  tests/unit/http/test_service.py: WPS204 WPS202
+  tests/unit/http/test_mixins.py: WPS204 WPS202
+  tests/unit/resources/catalog/test_products.py: WPS202 WPS210
+  tests/unit/resources/*/test_mixins.py: WPS118 WPS202 WPS204 WPS235
+  tests/unit/resources/accounts/test_users.py: WPS204 WPS202 WPS210
+  tests/unit/test_mpt_client.py: WPS235
+
+  tests/unit/*:
     # Allow magic strings.
     WPS432
     # Found too many modules members.

sonar-project.properties

@@ -9,5 +9,5 @@ sonar.inclusions=mpt_api_client/**
 sonar.exclusions=tests/**,**/__init__.py
 
 sonar.python.coverage.reportPaths=coverage.xml
-sonar.python.xunit.reportPath=coverage.xml
+sonar.python.xunit.reportPath=coverage.xml,e2e-report.xml
 sonar.python.version=3

tests/resources/billing/__init__.py renamed to tests/__init__.py

@@ -0,0 +1,20 @@
+import os
+
+import pytest
+
+from mpt_api_client import MPTClient
+
+
+@pytest.fixture
+def api_token():
+    return os.getenv("MPT_API_TOKEN")
+
+
+@pytest.fixture
+def base_url():
+    return os.getenv("MPT_API_BASE_URL")
+
+
+@pytest.fixture
+def mpt_client(api_token, base_url):
+    return MPTClient.from_config(api_token=api_token, base_url=base_url)

tests/e2e/conftest.py

@@ -0,0 +1,29 @@
+import random
+
+import pytest
+
+from mpt_api_client import MPTClient
+from mpt_api_client.exceptions import MPTAPIError
+
+
+@pytest.mark.flaky(reruns=5, reruns_delay=0.01)  # noqa: WPS432
+@pytest.mark.e2e
+def test_example():
+    assert random.choice([True, False])  # noqa: S311
+
+
+@pytest.mark.flaky
+@pytest.mark.e2e
+def test_unauthorised(base_url):
+    client = MPTClient.from_config(api_token="TKN-invalid", base_url=base_url)  # noqa: S106
+
+    with pytest.raises(MPTAPIError, match=r"401 Unauthorized"):
+        client.catalog.products.fetch_page()
+
+
+@pytest.mark.flaky
+@pytest.mark.e2e
+def test_access(mpt_client):
+    product = mpt_client.catalog.products.get("PRD-1975-5250")
+    assert product.id == "PRD-1975-5250"
+    assert product.name == "Amazon Web Services"