test: introduce pytest-docker

pyproject.toml

@@ -29,6 +29,7 @@ uvicorn = { extras = ["standard"], version = "^0.23" }
 autoflake = "^2.2"
 autopep8 = "^2.0"
 black = "^23.3"
+ci-py = "^1.0.0"
 flake8 = "^6.0"
 httpx = "^0.24"
 mypy = "^1.5"
@@ -37,6 +38,7 @@ pre-commit = "^3.4"
 pytest = "^7.4"
 pytest-asyncio = "^0.21"
 pytest-cov = "^4.1"
+pytest-docker = "^2.0.1"
 pytest-mock = "^3.11"
 pytest-randomly = "^3.15"
 pytest-sugar = "^0.9"

test.docker-compose.yml

@@ -0,0 +1,8 @@
+version: "3"
+services:
+  redis:
+    image: "redis/redis-stack:6.2.6-v7"
+    restart: always
+    ports:
+      - ${REDIS_PORT:-6379}:6379
+      - ${REDIS_INSIGHT_PORT:-8001}:8001

tests/conftest.py

@@ -1,9 +1,12 @@
 import asyncio
+import os
 
+import ci
 import pytest
 import pytest_asyncio
 from fastapi import FastAPI
 from httpx import AsyncClient
+from pytest_docker.plugin import Services
 
 from mihama import crud, models
 from mihama.core import settings
@@ -12,6 +15,31 @@
 from mihama.main import create_app
 from mihama.redis import setup_redis_om
 
+from .utils import is_responsive
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file(pytestconfig):
+    return os.path.join(str(pytestconfig.rootdir), "test.docker-compose.yml")
+
+
+if not ci.is_ci():
+
+    @pytest.fixture(scope="session", autouse=True)
+    def docker_compose(docker_ip: str, docker_services: Services):  # type: ignore
+        port = docker_services.port_for("redis", 8001)
+        url = f"http://{docker_ip}:{port}"
+        docker_services.wait_until_responsive(
+            timeout=30.0, pause=0.1, check=lambda: is_responsive(url)
+        )
+        return url
+
+else:
+
+    @pytest.fixture
+    def docker_compose():
+        return
+
 
 @pytest.fixture(scope="session")
 def event_loop():

tests/utils.py

@@ -0,0 +1,9 @@
+import httpx
+
+
+def is_responsive(url: str) -> bool:
+    try:
+        httpx.get(url)
+        return True
+    except Exception:
+        return False