Moved tests to using testcontainers

pyproject.toml

@@ -32,6 +32,10 @@ dev = [
     "hypothesis",
     "deepdiff",
     "pytest-xdist",
+    "testcontainers",
+    "pymysql",
+    "cryptography",
+
 ]
 docs = [
     "mkdocs-material",

tests/conftest.py

@@ -1,4 +1,3 @@
-import contextlib
 import json
 from collections.abc import Iterator
 from pathlib import Path
@@ -8,36 +7,32 @@
 import httpx
 import pytest
 from _pytest.config import Config
+from _pytest.config.argparsing import Parser
 from _pytest.nodes import Item
-from fastapi.testclient import TestClient
-from sqlalchemy import Connection, Engine, text
+from dotenv import load_dotenv
+from sqlalchemy import Connection, text
 
-from database.setup import expdb_database, user_database
-from main import create_api
-from routers.dependencies import expdb_connection, userdb_connection
+load_dotenv()
 
-PHP_API_URL = "http://openml-php-rest-api:80/api/v1/json"
 
+PHP_API_URL = "http://openml-php-rest-api:80/api/v1/json"
 
-@contextlib.contextmanager
-def automatic_rollback(engine: Engine) -> Iterator[Connection]:
-    with engine.connect() as connection:
-        transaction = connection.begin()
-        yield connection
-        if transaction.is_active:
-            transaction.rollback()
 
+def pytest_addoption(parser: Parser) -> None:
+    parser.addoption(
+        "--use-testcontainer",  # CLI flag
+        action="store_true",  # True if provided, False if omitted
+        help="Use testcontainers for database tests",
+    )
 
-@pytest.fixture
-def expdb_test() -> Connection:
-    with automatic_rollback(expdb_database()) as connection:
-        yield connection
 
+def pytest_configure(config: Config) -> None:
+    use_test_container = config.getoption("--use-testcontainer")
 
-@pytest.fixture
-def user_test() -> Connection:
-    with automatic_rollback(user_database()) as connection:
-        yield connection
+    if use_test_container:
+        config.pluginmanager.import_plugin("tests.fixtures_testcontainer")
+    else:
+        config.pluginmanager.import_plugin("tests.fixtures_local")
 
 
 @pytest.fixture
@@ -46,15 +41,6 @@ def php_api() -> httpx.Client:
         yield client
 
 
-@pytest.fixture
-def py_api(expdb_test: Connection, user_test: Connection) -> TestClient:
-    app = create_api()
-    # We use the lambda definitions because fixtures may not be called directly.
-    app.dependency_overrides[expdb_connection] = lambda: expdb_test
-    app.dependency_overrides[userdb_connection] = lambda: user_test
-    return TestClient(app)
-
-
 @pytest.fixture
 def dataset_130() -> Iterator[dict[str, Any]]:
     json_path = Path(__file__).parent / "resources" / "datasets" / "dataset_130.json"
@@ -109,7 +95,7 @@ def persisted_flow(flow: Flow, expdb_test: Connection) -> Iterator[Flow]:
     expdb_test.commit()
 
 
-def pytest_collection_modifyitems(config: Config, items: list[Item]) -> None:  # noqa: ARG001
+def pytest_collection_modifyitems(items: list[Item]) -> None:
     for test_item in items:
         for fixture in test_item.fixturenames:  # type: ignore[attr-defined]
             test_item.own_markers.append(_pytest.mark.Mark(fixture, (), {}))

tests/fixtures_local.py

@@ -0,0 +1,43 @@
+import contextlib
+from collections.abc import Iterator
+
+import pytest
+from dotenv import load_dotenv
+from fastapi.testclient import TestClient
+from sqlalchemy import Connection, Engine
+
+from database.setup import expdb_database, user_database
+from main import create_api
+from routers.dependencies import expdb_connection, userdb_connection
+
+load_dotenv()
+
+
+@contextlib.contextmanager
+def automatic_rollback(engine: Engine) -> Iterator[Connection]:
+    with engine.connect() as connection:
+        transaction = connection.begin()
+        yield connection
+        if transaction.is_active:
+            transaction.rollback()
+
+
+@pytest.fixture
+def expdb_test() -> Connection:
+    with automatic_rollback(expdb_database()) as connection:
+        yield connection
+
+
+@pytest.fixture
+def user_test() -> Connection:
+    with automatic_rollback(user_database()) as connection:
+        yield connection
+
+
+@pytest.fixture
+def py_api(expdb_test: Connection, user_test: Connection) -> TestClient:
+    app = create_api()
+    # We use the lambda definitions because fixtures may not be called directly.
+    app.dependency_overrides[expdb_connection] = lambda: expdb_test
+    app.dependency_overrides[userdb_connection] = lambda: user_test
+    return TestClient(app)

tests/fixtures_testcontainer.py

@@ -0,0 +1,99 @@
+import contextlib
+import os
+import re
+from collections.abc import Generator, Iterator
+
+import pytest
+import sqlalchemy
+from dotenv import load_dotenv
+from fastapi.testclient import TestClient
+from sqlalchemy import Connection, Engine
+from testcontainers.mysql import LogMessageWaitStrategy, MySqlContainer
+
+from main import create_api
+from routers.dependencies import expdb_connection, userdb_connection
+
+load_dotenv()
+
+
+@pytest.fixture(scope="session", autouse=True)
+def override_testcontainers_connect() -> None:
+    """
+    Override MySqlContainer._connect once per test session.
+    Applied automatically everywhere.
+    """
+
+    def _connect(self: MySqlContainer) -> None:
+        wait_strategy = LogMessageWaitStrategy(
+            re.compile(
+                r".*: ready for connections",
+                flags=re.DOTALL | re.MULTILINE,
+            )
+        )
+        wait_strategy.wait_until_ready(self)
+
+    MySqlContainer._connect = _connect  # noqa: SLF001
+
+
+@pytest.fixture(scope="session")
+def mysql_container() -> MySqlContainer:
+    container = MySqlContainer(
+        os.environ.get(
+            "OPENML_DATABASES_OPENML_URL",
+            "openml/test-database:v0.1.20260204",
+        ),
+        username=os.environ.get("OPENML_DATABASES_OPENML_USERNAME", ""),
+        password=os.environ.get("OPENML_DATABASES_OPENML_PASSWORD", ""),
+        dbname="openml_expdb",
+    )
+
+    container.start()
+    try:
+        yield container
+    finally:
+        container.stop()
+
+
+@pytest.fixture
+def expdb_test(mysql_container: MySqlContainer) -> Connection:
+    url = mysql_container.get_connection_url().replace("mysql://", "mysql+pymysql://")
+    engine = sqlalchemy.create_engine(url)
+
+    with engine.begin() as connection:  # This starts a transaction
+        try:
+            yield connection
+        finally:
+            connection.rollback()  # Rollback ALL test changes
+
+
+@contextlib.contextmanager
+def automatic_rollback(engine: Engine) -> Iterator[Connection]:
+    with engine.connect() as connection:
+        transaction = connection.begin()
+        yield connection
+        if transaction.is_active:
+            transaction.rollback()
+
+
+@pytest.fixture
+def py_api(expdb_test: Connection, user_test: Connection) -> Generator[TestClient, None, None]:
+    app = create_api()
+    # We use the lambda definitions because fixtures may not be called directly.
+    app.dependency_overrides[expdb_connection] = lambda: expdb_test
+    app.dependency_overrides[userdb_connection] = lambda: user_test
+
+    client = TestClient(app)
+    yield client
+    client.close()
+
+
+@pytest.fixture
+def user_test(mysql_container: MySqlContainer) -> Connection:
+    """Get a connection to the user database using the testcontainer."""
+    url = mysql_container.get_connection_url()
+    url = url.replace("mysql://", "mysql+pymysql://")
+    url = url.replace("openml_expdb", "openml")
+
+    engine = sqlalchemy.create_engine(url)
+    with automatic_rollback(engine) as connection:
+        yield connection