MPT-14713 E2E TDR Proof of concept

- 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, ...)

Author: albertsola

.env.sample

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

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
@@ -51,3 +55,5 @@ services:
     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

@@ -62,6 +62,7 @@ pythonpath = "."
 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",

tests/e2e/conftest.py

@@ -7,12 +7,12 @@
 
 @pytest.fixture
 def api_token():
-    return os.getenv("API_TOKEN")
+    return os.getenv("MPT_API_TOKEN")
 
 
 @pytest.fixture
 def base_url():
-    return os.getenv("API_URL")
+    return os.getenv("MPT_API_BASE_URL")
 
 
 @pytest.fixture

tests/e2e/test_e2e.py

@@ -2,8 +2,28 @@
 
 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"

tests/unit/test_exceptions.py

@@ -10,10 +10,34 @@
 
 
 def test_http_error():
-    exception = MPTHttpError(status_code=400, text="Content")
+    exception = MPTHttpError(status_code=400, message="Bad request", body="Content")
 
     assert exception.status_code == 400
-    assert exception.text == "Content"
+    assert exception.body == "Content"
+    assert str(exception) == "HTTP 400: Bad request"
+
+
+def test_http_error_not_found_from_mpt():  # noqa: WPS218
+    status_code = 400  # changed from 404 for testing purposes
+    api_status_code = 404
+    payload = {"message": "Resource not found", "statusCode": api_status_code}
+    message = (
+        "Client error '404 Resource Not Found' for url "
+        "'https://api.s1.show/public/public/v1/catalog/products?limit=100&offset=0'\n"
+        "For more information check: "
+        "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404"
+    )
+
+    exception = MPTAPIError(status_code=status_code, message=message, payload=payload)
+
+    assert exception.status_code == status_code
+    assert exception.payload == payload
+    assert exception.status == api_status_code
+    assert exception.title == "Resource not found"
+    assert exception.detail == message
+    assert exception.trace_id is None
+    assert exception.errors is None
+    assert str(exception) == f"404 Resource not found - {message} (no-trace-id)"
 
 
 def test_api_error():  # noqa: WPS218
@@ -24,7 +48,7 @@ def test_api_error():  # noqa: WPS218
         "traceId": "abc123",
         "errors": "Some error details",
     }
-    exception = MPTAPIError(status_code=400, payload=payload)
+    exception = MPTAPIError(status_code=400, message="Bad Request", payload=payload)
 
     assert exception.status_code == 400
     assert exception.payload == payload
@@ -43,7 +67,7 @@ def test_api_error_str_and_repr():
         "traceId": "abc123",
         "errors": "Some error details",
     }
-    exception = MPTAPIError(status_code=400, payload=payload)
+    exception = MPTAPIError(status_code=400, message="Bad request", payload=payload)
 
     assert str(exception) == '400 Bad Request - Invalid input (abc123)\n"Some error details"'
     assert repr(exception) == (
@@ -60,12 +84,12 @@ def test_api_error_str_no_errors():
         "traceId": "abc123",
     }
 
-    exception = MPTAPIError(status_code=400, payload=payload)
+    exception = MPTAPIError(status_code=400, message="Bad request", payload=payload)
 
     assert str(exception) == "400 Bad Request - Invalid input (abc123)"
 
 
-def test_transform_http_status_exception():
+def test_transform_http_status_exception_api():
     payload = {
         "status": "400",
         "title": "Bad Request",
@@ -88,17 +112,18 @@ def test_transform_http_status_exception():
     assert err.payload == payload
 
 
-def test_transform_http_status_exception_json():
+def test_transform_http_status_exception():
     response = Response(
         status_code=500,
         request=Request("GET", "http://test"),
         content=b"Internal Server Error",
         headers={"content-type": "text/plain"},
     )
-    exc = HTTPStatusError("error", request=response.request, response=response)
+    exc = HTTPStatusError("Error message", request=response.request, response=response)
 
     err = transform_http_status_exception(exc)
 
     assert isinstance(err, MPTHttpError)
     assert err.status_code == 500
-    assert err.text == "Internal Server Error"
+    assert err.body == "Internal Server Error"
+    assert str(err) == "HTTP 500: Error message"