python: Add unit tests for Svix API client (WIP)

Author: anlambert

.github/workflows/python-tests.yml

@@ -0,0 +1,39 @@
+name: Python Tests
+on:
+  push:
+    paths:
+      - "python/**"
+      - "openapi.json"
+  pull_request:
+    paths:
+      - "python/**"
+      - "openapi.json"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build svix server image
+        run: docker compose build
+        working-directory: ./server
+
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: "3.11"
+
+      - name: Install deps
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements.txt .
+          python -m pip install -r requirements-dev.txt .
+        working-directory: ./python
+
+      - name: Regen openapi libs
+        run: ./scripts/generate_openapi.sh
+        working-directory: ./python
+
+      - name: Run Python tests
+        run: pytest -sv
+        working-directory: ./python

python/requirements-dev.txt

@@ -10,6 +10,7 @@ attrs==21.4.0
     # via
     #   openapi-python-client
     #   pytest
+    #   pytest-docker
 autoflake==1.4
     # via openapi-python-client
 black==23.3.0
@@ -20,6 +21,9 @@ certifi==2024.7.4
     # via
     #   httpcore
     #   httpx
+    #   requests
+charset-normalizer==3.3.2
+    # via requests
 click==8.0.1
     # via
     #   black
@@ -36,6 +40,7 @@ httpx==0.23.0
 idna==3.3
     # via
     #   anyio
+    #   requests
     #   rfc3986
 iniconfig==1.1.1
     # via pytest
@@ -77,11 +82,17 @@ pyflakes==2.3.1
 pyproject-hooks==1.0.0
     # via build
 pytest==6.2.4
+    # via
+    #   -r requirements.in/development.txt
+    #   pytest-docker
+pytest-docker==3.1.1
     # via -r requirements.in/development.txt
 python-dateutil==2.8.2
     # via openapi-python-client
 pyyaml==6.0.1
     # via openapi-python-client
+requests==2.32.3
+    # via -r requirements.in/development.txt
 rfc3986[idna2008]==1.5.0
     # via httpx
 ruff==0.4.8
@@ -103,6 +114,8 @@ typing-extensions==4.6.3
     # via
     #   mypy
     #   pydantic
+urllib3==2.2.3
+    # via requests
 wheel==0.40.0
     # via pip-tools
 

python/requirements.in/development.txt

@@ -5,3 +5,6 @@ pytest
 httpx>=0.23.0
 openapi-python-client>=0.14.1,<0.15 # I think version 0.15 is now dangerous for us? https://github.com/openapi-generators/openapi-python-client/pull/775#issuecomment-1646977834
 jinja2>=3.1.3
+pytest-docker
+requests
+

python/tests/conftest.py

@@ -0,0 +1,111 @@
+import os
+import shutil
+from subprocess import CalledProcessError, check_output
+
+import pytest
+import requests
+from requests.adapters import HTTPAdapter
+from svix.api import Svix, SvixOptions
+from urllib3.util.retry import Retry
+
+SVIX_ORG_ID = "org_svix_python_tests"
+
+
+def pytest_collection_modifyitems(config, items):
+    """Tests require docker compose (v2 or v1) so skip them if it is not
+    installed on host."""
+    skipper = None
+    if shutil.which("docker") is None:
+        skipper = pytest.mark.skip(reason="skipping test as docker command is missing")
+    else:
+        docker_compose_available = False
+        try:
+            # check if docker compose v2 if available
+            check_output(["docker", "compose", "version"])
+            docker_compose_available = True
+        except CalledProcessError:
+            # check if docker compose v1 if available
+            docker_compose_available = shutil.which("docker-compose") is not None
+        finally:
+            if not docker_compose_available:
+                skipper = pytest.mark.skip(
+                    reason="skipping test as docker compose is missing"
+                )
+    if skipper is not None:
+        for item in items:
+            item.add_marker(skipper)
+
+
+@pytest.fixture(scope="session")
+def docker_compose_command():
+    try:
+        # use docker compose v2 if available
+        check_output(["docker", "compose", "version"])
+        return "docker compose"
+    except Exception:
+        # fallback on v1 otherwise
+        return "docker-compose"
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file():
+    return [
+        os.path.join(os.path.dirname(__file__), "../../server/docker-compose.yml"),
+        os.path.join(
+            os.path.dirname(__file__), "../../server/docker-compose.override.yml"
+        ),
+    ]
+
+
+@pytest.fixture(scope="session")
+def docker_compose(docker_services):
+    return docker_services._docker_compose
+
+
+@pytest.fixture(scope="session")
+def svix_server_url(docker_services):
+    # svix server container exposes a free port to the docker host,
+    # we use the docker network gateway IP in case the tests are also
+    # executed in a container
+    svix_server_port = docker_services.port_for("backend", 8071)
+    return f"http://172.17.0.1:{svix_server_port}"
+
+
+@pytest.fixture(autouse=True, scope="session")
+def svix_server(svix_server_url):
+    """Spawn a Svix server for the tests session using docker compose"""
+    # wait for the svix backend service to be up and responding
+    request_session = requests.Session()
+    retries = Retry(total=10, backoff_factor=0.1, status_forcelist=[500, 502, 503, 504])
+    request_session.mount("http://", HTTPAdapter(max_retries=retries))
+    api_url = f"{svix_server_url}/api/v1/health/"
+    response = request_session.get(api_url)
+    assert response
+
+
+@pytest.fixture(autouse=True)
+def svix_wiper(docker_compose):
+    """Ensure stateless tests"""
+    yield
+    # wipe svix database after each test to ensure stateless tests
+    docker_compose.execute(
+        f"exec -T backend svix-server wipe --yes-i-know-what-im-doing {SVIX_ORG_ID}"
+    )
+
+
+@pytest.fixture(scope="session")
+def svix_api(svix_server_url, docker_compose):
+    # generate bearer token to authorize communication with the svix server
+    exec_output = docker_compose.execute(
+        f"exec -T backend svix-server jwt generate {SVIX_ORG_ID}"
+    )
+    svix_auth_token = (
+        exec_output.decode()
+        .replace("Token (Bearer): ", "")
+        .replace("\r", "")
+        .replace("\n", "")
+    )
+    return Svix(
+        svix_auth_token,
+        SvixOptions(server_url=svix_server_url),
+    )

python/tests/test_client.py

@@ -0,0 +1,28 @@
+import uuid
+
+import pytest
+from svix.api import ApplicationIn, ApplicationOut, Svix
+
+
+def _gen_uuid(name: str) -> str:
+    return str(uuid.uuid5(uuid.NAMESPACE_DNS, name))
+
+
+@pytest.fixture
+def svix_app_name() -> str:
+    return "svix_python_tests"
+
+
+def create_svix_app(
+    svix_api: Svix, svix_app_name: str, svix_app_uid: str
+) -> ApplicationOut:
+    return svix_api.application.get_or_create(
+        ApplicationIn(name=svix_app_name, uid=svix_app_uid)
+    )
+
+
+def test_svix_application_create(svix_api: Svix, svix_app_name: str):
+    svix_app_uid = _gen_uuid(svix_app_name)
+    app = create_svix_app(svix_api, svix_app_name, svix_app_uid)
+    assert app.name == svix_app_name
+    assert app.uid == svix_app_uid