feat: split compose into multiple files

Author: cofin

src/pytest_databases/docker/__init__.py

@@ -29,7 +29,6 @@
 import subprocess  # noqa: S404
 import sys
 import timeit
-from pathlib import Path
 from typing import TYPE_CHECKING, Any, Callable
 
 import pytest
@@ -38,6 +37,7 @@
 
 if TYPE_CHECKING:
     from collections.abc import Awaitable, Generator
+    from pathlib import Path
 
 
 async def wait_until_responsive(
@@ -76,9 +76,9 @@ def __init__(self, worker_id: str, compose_project_name: str = COMPOSE_PROJECT_N
         self._running_services: set[str] = set()
         self.docker_ip = self._get_docker_ip()
         self._base_command = ["docker-compose"] if USE_LEGACY_DOCKER_COMPOSE else ["docker", "compose"]
+        self._compose_files: list[str] = []
         self._base_command.extend(
             [
-                f"--file={Path(__file__).parent / 'docker-compose.yml'}",
                 f"--project-name={compose_project_name}-{worker_id}",
             ],
         )
@@ -96,12 +96,13 @@ def _get_docker_ip() -> str:
         raise ValueError(msg)
 
     def run_command(self, *args: str) -> None:
-        command = [*self._base_command, *args]
+        command = [*self._base_command, *self._compose_files, *args]
         subprocess.run(command, check=True, capture_output=True)
 
     async def start(
         self,
         name: str,
+        docker_compose_files: list[Path],
         *,
         check: Callable[..., Any],
         timeout: float = 30,
@@ -111,6 +112,7 @@ async def start(
         if SKIP_DOCKER_COMPOSE:
             self._running_services.add(name)
         if name not in self._running_services:
+            self._compose_files = [f"--file={compose_file}" for compose_file in docker_compose_files]
             self.run_command("up", "--force-recreate", "-d", name)
             self._running_services.add(name)
 

src/pytest_databases/docker/cockroachdb.py

@@ -23,6 +23,7 @@
 from __future__ import annotations
 
 import os
+from pathlib import Path
 from typing import TYPE_CHECKING
 
 import psycopg
@@ -58,17 +59,30 @@ def cockroachdb_driver_opts() -> dict[str, str]:
     return {"sslmode": "disable"}
 
 
+@pytest.fixture(scope="session")
+def docker_compose_files() -> list[Path]:
+    return [Path(Path(__file__).parent / "docker-compose.cockroachdb.yml")]
+
+
+@pytest.fixture(scope="session")
+def default_cockroachdb_service_name() -> str:
+    return "cockroachdb"
+
+
 @pytest.fixture(autouse=False)
 async def cockroachdb_service(
     docker_services: DockerServiceRegistry,
+    default_cockroachdb_service_name: str,
+    docker_compose_files: list[Path],
     cockroachdb_port: int,
     cockroachdb_database: str,
     cockroachdb_driver_opts: dict[str, str],
 ) -> None:
     os.environ["COCKROACHDB_DATABASE"] = cockroachdb_database
     os.environ["COCKROACHDB_PORT"] = str(cockroachdb_port)
     await docker_services.start(
-        "cockroachdb",
+        name=default_cockroachdb_service_name,
+        docker_compose_files=docker_compose_files,
         timeout=60,
         pause=1,
         check=cockroachdb_responsive,

src/pytest_databases/docker/docker-compose.cockroachdb.yml

@@ -0,0 +1,19 @@
+services:
+  cockroachdb:
+    image: cockroachdb/cockroach:latest-v23.1
+    command: start-single-node --insecure
+    restart: "no"
+    expose:
+      - "8080"
+      - "${COCKROACHDB_PORT:-26257}"
+    ports:
+      - "${COCKROACHDB_PORT:-26257}:26257"
+      - "8880:8080"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8080/health?ready=1"]
+      interval: 3s
+      timeout: 3s
+      retries: 5
+networks:
+  default:
+    driver: bridge

src/pytest_databases/docker/docker-compose.dragonfly.yml

@@ -0,0 +1,18 @@
+services:
+  dragonfly:
+    image: "docker.dragonflydb.io/dragonflydb/dragonfly"
+    ulimits:
+      memlock: -1
+    ports:
+      - "${DRAGONFLY_PORT:-6398}:6379"
+    # For better performance, consider `host` mode instead `port` to avoid docker NAT.
+    # `host` mode is NOT currently supported in Swarm Mode.
+    # https://docs.docker.com/compose/compose-file/compose-file-v3/#network_mode
+    # network_mode: "host"
+    volumes:
+      - dragonflydata:/data
+networks:
+  default:
+    driver: bridge
+volumes:
+  dragonflydata:

src/pytest_databases/docker/docker-compose.elasticsearch.yml

@@ -0,0 +1,30 @@
+services:
+  elasticsearch7:
+    image: elasticsearch:7.17.19
+    ports:
+      - 9200:9200
+      - 9301:9300
+    environment:
+      - discovery.type=single-node
+      - xpack.security.enabled=false
+    healthcheck:
+      test: curl -s http://localhost:9200 >/dev/null || exit 1
+      interval: 30s
+      timeout: 10s
+      retries: 50
+  elasticsearch8:
+    image: elasticsearch:8.13.0
+    ports:
+      - 9201:9200
+      - 9300:9300
+    environment:
+      - discovery.type=single-node
+      - xpack.security.enabled=false
+    healthcheck:
+      test: curl -s http://localhost:9200 >/dev/null || exit 1
+      interval: 30s
+      timeout: 10s
+      retries: 50
+networks:
+  default:
+    driver: bridge

src/pytest_databases/docker/docker-compose.keydb.yml

@@ -0,0 +1,8 @@
+services:
+  keydb:
+    image: eqalpha/keydb
+    ports:
+      - "${KEYDB_PORT:-6396}:6379"
+networks:
+  default:
+    driver: bridge

src/pytest_databases/docker/docker-compose.mariadb.yml

@@ -0,0 +1,17 @@
+services:
+  mariadb113:
+    networks:
+      - default
+    image: mariadb:11.3
+    ports:
+      - "${MARIADB113_PORT:-3359}:3306" # use a non-standard port here
+    environment:
+      MARIADB_ROOT_PASSWORD: ${MARIADB_ROOT_PASSWORD:-super-secret}
+      MARIADB_PASSWORD: ${MARIADB_PASSWORD:-super-secret}
+      MARIADB_USER: ${MARIADB_USER:-app}
+      MARIADB_DATABASE: ${MARIADB_DATABASE:-db}
+      MARIADB_ROOT_HOST: "%"
+      LANG: C.UTF-8
+networks:
+  default:
+    driver: bridge

src/pytest_databases/docker/docker-compose.mssql.yml

@@ -0,0 +1,15 @@
+services:
+  mssql2022:
+    networks:
+      - default
+    image: mcr.microsoft.com/mssql/server:2022-latest
+    ports:
+      - "${MSSQL2022_PORT:-4133}:1433" # use a non-standard port here
+    environment:
+      SA_PASSWORD: ${MSSQL_PASSWORD:-Super-secret1}
+      MSSQL_PID: Developer
+      ACCEPT_EULA: Accepted
+      MSSQL_TCP_PORT: 1433
+networks:
+  default:
+    driver: bridge

src/pytest_databases/docker/docker-compose.mysql.yml

@@ -0,0 +1,43 @@
+services:
+  mysql8:
+    networks:
+      - default
+    image: mysql:latest
+    ports:
+      - "${MYSQL8_PORT:-3360}:3306" # use a non-standard port here
+    environment:
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:-super-secret}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD:-super-secret}
+      MYSQL_USER: ${MYSQL_USER:-app}
+      MYSQL_DATABASE: ${MYSQL_DATABASE:-db}
+      MYSQL_ROOT_HOST: "%"
+      LANG: C.UTF-8
+  mysql57:
+    networks:
+      - default
+    image: mysql:5.7
+    ports:
+      - "${MYSQL57_PORT:-3362}:3306" # use a non-standard port here
+    environment:
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:-super-secret}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD:-super-secret}
+      MYSQL_USER: ${MYSQL_USER:-app}
+      MYSQL_DATABASE: ${MYSQL_DATABASE:-db}
+      MYSQL_ROOT_HOST: "%"
+      LANG: C.UTF-8
+  mysql56:
+    networks:
+      - default
+    image: mysql:5.6
+    ports:
+      - "${MYSQL56_PORT:-3363}:3306" # use a non-standard port here
+    environment:
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:-super-secret}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD:-super-secret}
+      MYSQL_USER: ${MYSQL_USER:-app}
+      MYSQL_DATABASE: ${MYSQL_DATABASE:-db}
+      MYSQL_ROOT_HOST: "%"
+      LANG: C.UTF-8
+networks:
+  default:
+    driver: bridge

src/pytest_databases/docker/docker-compose.oracle.yml

@@ -0,0 +1,24 @@
+services:
+  oracle18c:
+    networks:
+      - default
+    image: gvenzl/oracle-xe:18-slim-faststart
+    ports:
+      - "${ORACLE18C_PORT:-1514}:1521" # use a non-standard port here
+    environment:
+      ORACLE_PASSWORD: ${ORACLE_SYSTEM_PASSWORD:-super-secret}
+      APP_USER_PASSWORD: ${ORACLE_PASSWORD:-super-secret}
+      APP_USER: ${ORACLE_USER:-app}
+  oracle23c:
+    networks:
+      - default
+    image: gvenzl/oracle-free:23-slim-faststart
+    ports:
+      - "${ORACLE23C_PORT:-1513}:1521" # use a non-standard port here
+    environment:
+      ORACLE_PASSWORD: ${ORACLE_SYSTEM_PASSWORD:-super-secret}
+      APP_USER_PASSWORD: ${ORACLE_PASSWORD:-super-secret}
+      APP_USER: ${ORACLE_USER:-app}
+networks:
+  default:
+    driver: bridge