Skip to content

Commit

Permalink
Refactor migration testing setup code
Browse files Browse the repository at this point in the history
- Do not explicitly import fixtures (a little duplication is safer/cleaner)
- Move dangerous fixture into module to prevent accidental usage from other modules
- Ensure only one database is used for all tests in module
  • Loading branch information
jdavcs committed Sep 25, 2024
1 parent 82b8893 commit b57ec18
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 30 deletions.
44 changes: 19 additions & 25 deletions test/unit/data/model/migration_fixes/conftest.py
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
from typing import (
Generator,
TYPE_CHECKING,
)
import tempfile
from typing import TYPE_CHECKING

import pytest
from sqlalchemy import (
create_engine,
text,
)
from sqlalchemy import create_engine
from sqlalchemy.orm import Session

from galaxy import model as m

if TYPE_CHECKING:
from sqlalchemy.engine import Engine

from galaxy.model.unittest_utils.model_testing_utils import ( # noqa: F401 - url_factory is a fixture we have to import explicitly
sqlite_url_factory,
from galaxy.model.unittest_utils.model_testing_utils import (
_generate_unique_database_name,
_make_sqlite_db_url,
)


@pytest.fixture()
@pytest.fixture(scope="module")
def sqlite_url_factory():
"""Return a function that generates a sqlite url"""

def url():
database = _generate_unique_database_name()
return _make_sqlite_db_url(tmp_dir, database)

with tempfile.TemporaryDirectory() as tmp_dir:
yield url


@pytest.fixture(scope="module")
def db_url(sqlite_url_factory): # noqa: F811
return sqlite_url_factory()

Expand All @@ -33,15 +39,3 @@ def engine(db_url: str) -> "Engine":
@pytest.fixture
def session(engine: "Engine") -> Session:
return Session(engine)


@pytest.fixture(autouse=True)
def clear_database(engine: "Engine") -> "Generator":
"""Delete all rows from all tables. Called after each test."""
yield
with engine.begin() as conn:
for table in m.mapper_registry.metadata.tables:
# Unless db is sqlite, disable foreign key constraints to delete out of order
if engine.name != "sqlite":
conn.execute(text(f"ALTER TABLE {table} DISABLE TRIGGER ALL"))
conn.execute(text(f"DELETE FROM {table}"))
31 changes: 26 additions & 5 deletions test/unit/data/model/migration_fixes/test_migrations.py
Original file line number Diff line number Diff line change
@@ -1,20 +1,41 @@
from typing import (
Generator,
TYPE_CHECKING,
)

import pytest
from sqlalchemy import select
from sqlalchemy import (
select,
text,
)

from galaxy import model as m
from galaxy.model import (
GroupRoleAssociation,
User,
UserGroupAssociation,
UserRoleAssociation,
)
from galaxy.model.unittest_utils.migration_scripts_testing_utils import ( # noqa: F401 - contains fixtures we have to import explicitly
run_command,
tmp_directory,
)
from galaxy.model.unittest_utils.migration_scripts_testing_utils import run_command

if TYPE_CHECKING:
from sqlalchemy.engine import Engine

COMMAND = "manage_db.sh"


@pytest.fixture(autouse=True)
def clear_database(engine: "Engine") -> "Generator":
"""Delete all rows from all tables. Called after each test."""
yield
with engine.begin() as conn:
for table in m.mapper_registry.metadata.tables:
# Unless db is sqlite, disable foreign key constraints to delete out of order
if engine.name != "sqlite":
conn.execute(text(f"ALTER TABLE {table} DISABLE TRIGGER ALL"))
conn.execute(text(f"DELETE FROM {table}"))


@pytest.fixture(autouse=True)
def upgrade_database_after_test():
"""Run after each test for proper cleanup"""
Expand Down

0 comments on commit b57ec18

Please sign in to comment.