MPT-14713 Prepare for e2e testing

Author: albertsola

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

@@ -29,6 +29,9 @@ jobs:
     - name: "Run validation & test"
       run: docker compose run --service-ports app_test
 
+    - name: "Run E2E test"
+      run: docker compose run --service-ports app_test
+
     - name: "Run SonarCloud Scan"
       uses: SonarSource/sonarqube-scan-action@master
       env:

docker-compose.yml

@@ -41,3 +41,13 @@ 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

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,16 @@ 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"
 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 tests/__init__.pytests/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("API_TOKEN")
+
+
+@pytest.fixture
+def base_url():
+    return os.getenv("API_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,9 @@
+import random
+
+import pytest
+
+
+@pytest.mark.flaky(reruns=5, reruns_delay=0.01)  # noqa: WPS432
+@pytest.mark.e2e
+def test_example():
+    assert random.choice([True, False])  # noqa: S311