Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
19e143c
fix(migrations): preserve cross-app foreign key columns and constraints…
solvin-ai-teammate Sep 10, 2026
8c56ad9
refactor(migrations): address review feedback on multi-connection tests…
solvin-ai-teammate Sep 17, 2026
e6896f9
refactor(migrations): resolve transitive migration dependencies in Migr…
solvin-ai-teammate Oct 6, 2026
3aa0089
refactor(migrations): optimize loader queue and add tests for run_befor…
solvin-ai-teammate Oct 7, 2026
416c8cc
Merge branch 'develop' of github.com:tortoise/tortoise-orm into fix__…
waketzheng Nov 7, 2026
b15ff2f
Merge branch 'develop' of github.com:tortoise/tortoise-orm into fix__…
waketzheng Nov 9, 2026
5671770
test: use touch instead
waketzheng Nov 9, 2026
b93956c
Merge branch 'develop' of github.com:tortoise/tortoise-orm into fix__…
waketzheng Nov 10, 2026
f3d629e
refactor(test): use dedented multiline strings for fixture code
waketzheng Nov 10, 2026
ba98474
refactor(test): extract _memory_sqlite() helper
waketzheng Nov 10, 2026
05a4df4
Merge branch 'develop' of github.com:tortoise/tortoise-orm into fix__…
waketzheng Nov 10, 2026
873f110
Merge branch 'develop' of github.com:tortoise/tortoise-orm into fix__…
waketzheng Nov 11, 2026
5a7d533
refactor(test): extract _purge_app_modules() to document stale-module…
waketzheng Nov 11, 2026
ebcb0c2
Merge branch 'develop' of github.com:tortoise/tortoise-orm into fix__…
waketzheng Nov 12, 2026
011b9db
test: promote _multiline_code to a shared helper
waketzheng Nov 12, 2026
0ef0061
test: tighten cross-app FK assertion to exact SQLite quoting
waketzheng Nov 12, 2026
15dbf47
test: extract tortoise teardown into _teardown_tortoise helper
waketzheng Nov 12, 2026
4f4ee44
test: split cross-app fixtures into per-app builders
waketzheng Nov 12, 2026
be8a26d
refactor: drop redundant selected_apps check in migrate routing
waketzheng Nov 13, 2026
7468895
refactor: explain all_apps_config in migration entry points
waketzheng Nov 14, 2026
d536151
fix: load dependency app migrations in MigrationLoader
waketzheng Nov 14, 2026
ffa134f
test: fix collection warning and stale apps_config assertion
waketzheng Nov 14, 2026
8325595
test: share purge helper, reuse base config, and silence TestSchemaEd…
waketzheng Nov 14, 2026
88f1772
feat: add MigrationLoader.compute_closure
waketzheng Nov 15, 2026
a05e9cf
test: cover connection skip on empty targets and annotate double load…
waketzheng Nov 15, 2026
662a3c6
test: tighten empty-target connection skip coverage
waketzheng Nov 15, 2026
abe0589
refactor: rename compute_closure parameter and annotate test
waketzheng Nov 15, 2026
08870a0
test: make plan empty-target test actually exercise the skip
waketzheng Nov 15, 2026
8dce0b0
docs: update changelog
waketzheng Nov 16, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Fixed
- docs: fix relation accessors in model and query examples. (#2411)
- Match email domain allowlists without regard to case. (#2403)
- Allow ``sql_mode=`` in MySQL database URLs to clear the default SQL mode, including connection setup with aiomysql and asyncmy. (#2326)
- ``migrate``/``plan``/``sqlmigrate`` on a subset of apps now load dependency apps' migrations, so cross-app ``ForeignKeyField`` columns and constraints are no longer silently omitted. (#2278)

1.1.9
-----
Expand Down
315 changes: 305 additions & 10 deletions tests/migrations/test_migrate_api.py
Original file line number Diff line number Diff line change
@@ -1,22 +1,317 @@
from collections.abc import AsyncGenerator
from contextlib import asynccontextmanager
from pathlib import Path
from typing import Any

import pytest

from tests.utils.multiline import multiline_code
from tests.utils.purge import purge_app_modules
from tortoise import Tortoise
from tortoise.config import AppConfig, ConnectionConfig, TortoiseConfig
from tortoise.migrations.api import migrate
from tortoise.migrations.api import migrate, plan, sqlmigrate
from tortoise.migrations.executor import MigrationExecutor, MigrationTarget
from tortoise.migrations.loader import MigrationLoader


@pytest.mark.asyncio
async def test_migrate_accepts_dataclass_config() -> None:
config = TortoiseConfig(
def _create_app_package(app_dir: Path, models_code: str, migration_code: str) -> None:
migrations_dir = app_dir / "migrations"
migrations_dir.mkdir(parents=True, exist_ok=True)
(app_dir / "__init__.py").touch()
(migrations_dir / "__init__.py").touch()
(app_dir / "models.py").write_text(models_code, encoding="ascii")
(migrations_dir / "0001_initial.py").write_text(migration_code, encoding="ascii")


def _memory_sqlite() -> ConnectionConfig:
return ConnectionConfig(
engine="tortoise.backends.sqlite",
credentials={"file_path": ":memory:"},
)


def _create_cross_app_a(tmp_path: Path) -> None:
_create_app_package(
tmp_path / "app_a",
models_code=multiline_code(
"""
from tortoise import Model, fields

class User(Model):
id = fields.IntField(primary_key=True)
username = fields.CharField(max_length=50)
"""
),
migration_code=multiline_code(
"""
from tortoise import fields, migrations
from tortoise.migrations import operations as ops

class Migration(migrations.Migration):
dependencies = []
operations = [
ops.CreateModel(
name='User',
fields=[
('id', fields.IntField(primary_key=True)),
('username', fields.CharField(max_length=50)),
],
),
]
"""
),
)


def _create_cross_app_b(tmp_path: Path) -> None:
_create_app_package(
tmp_path / "app_b",
models_code=multiline_code(
"""
from tortoise import Model, fields

class GenericModel(Model):
user = fields.ForeignKeyField('app_a.User')

class Meta:
abstract = True

class ModelA(GenericModel):
class Meta:
abstract = True

class ModelB(ModelA):
class Meta:
abstract = True

class ConcreteModel(ModelB):
id = fields.IntField(primary_key=True)
"""
),
migration_code=multiline_code(
"""
from tortoise import fields, migrations
from tortoise.migrations import operations as ops

class Migration(migrations.Migration):
dependencies = [('app_a', '0001_initial')]
operations = [
ops.CreateModel(
name='ConcreteModel',
fields=[
('id', fields.IntField(primary_key=True)),
('user', fields.ForeignKeyField('app_a.User')),
],
),
]
"""
),
)


def _create_cross_app_c(tmp_path: Path) -> None:
_create_app_package(
tmp_path / "app_c",
models_code=multiline_code(
"""
from tortoise import Model, fields

class Item(Model):
id = fields.IntField(primary_key=True)
"""
),
migration_code=multiline_code(
"""
from tortoise import fields, migrations
from tortoise.migrations import operations as ops

class Migration(migrations.Migration):
dependencies = []
operations = [
ops.CreateModel(
name='Item',
fields=[('id', fields.IntField(primary_key=True))],
),
]
"""
),
)


def _setup_cross_app_projects(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> TortoiseConfig:
purge_app_modules("app_a", "app_b")
_create_cross_app_a(tmp_path)
_create_cross_app_b(tmp_path)
monkeypatch.syspath_prepend(str(tmp_path))

return TortoiseConfig(
connections={"default": _memory_sqlite()},
apps={
"app_a": AppConfig(
models=["app_a.models"],
default_connection="default",
migrations="app_a.migrations",
),
"app_b": AppConfig(
models=["app_b.models"],
default_connection="default",
migrations="app_b.migrations",
),
},
)


def _setup_multi_connection_projects(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> TortoiseConfig:
purge_app_modules("app_c")

base = _setup_cross_app_projects(tmp_path, monkeypatch)

_create_cross_app_c(tmp_path)

return TortoiseConfig(
connections={
"default": ConnectionConfig(
engine="tortoise.backends.sqlite",
credentials={"file_path": ":memory:"},
)
**base.connections,
"secondary": _memory_sqlite(),
},
apps={
**base.apps,
"app_c": AppConfig(
models=["app_c.models"],
default_connection="secondary",
migrations="app_c.migrations",
),
},
apps={"models": AppConfig(models=["tests.testmodels"], default_connection="default")},
)


@asynccontextmanager
async def _teardown_tortoise(*app_names: str) -> AsyncGenerator[None]:
try:
await migrate(config=config)
yield
finally:
await Tortoise.close_connections()
await Tortoise._reset_apps()
if app_names:
purge_app_modules(*app_names)


@pytest.mark.asyncio
async def test_plan_cross_app_dependency(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
config = _setup_cross_app_projects(tmp_path, monkeypatch)

async with _teardown_tortoise("app_a", "app_b"):
output = await plan(config=config, app_labels=["app_b"])
app_a_idx = next(i for i, line in enumerate(output) if "app_a.0001_initial" in line)
app_b_idx = next(i for i, line in enumerate(output) if "app_b.0001_initial" in line)
assert app_a_idx < app_b_idx


@pytest.mark.asyncio
async def test_plan_multi_connection_empty_targets(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
config = _setup_multi_connection_projects(tmp_path, monkeypatch)

async with _teardown_tortoise("app_a", "app_b", "app_c"):
output = await plan(config=config, app_labels=["app_b", "app_c"], target="app_b")
joined = "\n".join(output)
assert "app_b.0001_initial" in joined
assert "app_c.0001_initial" not in joined
assert "secondary" not in joined


@pytest.mark.asyncio
async def test_migrate_accepts_dataclass_config() -> None:
config = TortoiseConfig(
connections={"default": _memory_sqlite()},
apps={"models": AppConfig(models=["tests.testmodels"], default_connection="default")},
)
async with _teardown_tortoise():
await migrate(config=config)


@pytest.mark.asyncio
async def test_sqlmigrate_cross_app_foreign_key_in_table_sql(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
config = _setup_cross_app_projects(tmp_path, monkeypatch)

async with _teardown_tortoise("app_a", "app_b"):
sql_statements = await sqlmigrate(
config=config,
app_label="app_b",
migration_name="0001_initial",
)
combined_sql = "\n".join(sql_statements)
assert '"user_id"' in combined_sql
assert 'REFERENCES "user"' in combined_sql


@pytest.mark.asyncio
async def test_migrate_cross_app_foreign_key(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
config = _setup_cross_app_projects(tmp_path, monkeypatch)

async with _teardown_tortoise("app_a", "app_b"):
await migrate(config=config, app_labels=["app_b"])
conn = Tortoise.get_connection("default")
_, table_info = await conn.execute_query("PRAGMA table_info('concretemodel')")
col_names = [row["name"] for row in table_info]
assert "user_id" in col_names

_, fk_info = await conn.execute_query("PRAGMA foreign_key_list('concretemodel')")
assert any(row["table"] == "user" and row["from"] == "user_id" for row in fk_info)


@pytest.mark.asyncio
async def test_migrate_empty_targets_skips_connection(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
config = _setup_multi_connection_projects(tmp_path, monkeypatch)
async with _teardown_tortoise("app_a", "app_b", "app_c"):
await migrate(config=config, app_labels=["app_b", "app_c"], target="app_b")
sec_conn = Tortoise.get_connection("secondary")
_, sec_tables = await sec_conn.execute_query(
"SELECT name FROM sqlite_master WHERE type='table' AND name='item'"
)
assert len(sec_tables) == 0
conn = Tortoise.get_connection("default")
_, tables = await conn.execute_query(
"SELECT name FROM sqlite_master WHERE type='table' AND name='concretemodel'"
)
assert len(tables) == 1


@pytest.mark.asyncio
async def test_migrate_multi_connection_target_exclusion(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
config = _setup_multi_connection_projects(tmp_path, monkeypatch)
recorded_targets: dict[str, list[str]] = {}
orig_migrate = MigrationExecutor.migrate

async def mock_migrate(
self: MigrationExecutor, targets: list[MigrationTarget], **kwargs: Any
) -> None:
conn_name = next(
k for k in config.connections if Tortoise.get_connection(k) == self.connection
)
recorded_targets[conn_name] = [t.app_label for t in targets]
return await orig_migrate(self, targets, **kwargs)

monkeypatch.setattr(MigrationExecutor, "migrate", mock_migrate)
async with _teardown_tortoise("app_a", "app_b", "app_c"):
# app_a is in the closure (app_b's FK needs it) but must not be a target.
assert "app_a" in MigrationLoader.compute_closure(
config.to_dict()["apps"], ["app_b", "app_c"]
)
await migrate(config=config, app_labels=["app_b", "app_c"])
assert "app_c" not in recorded_targets["default"]
assert "app_b" in recorded_targets["default"]
assert "app_a" not in recorded_targets["default"]
assert "app_b" not in recorded_targets["secondary"]
assert "app_a" not in recorded_targets["secondary"]
assert "app_c" in recorded_targets["secondary"]
2 changes: 2 additions & 0 deletions tests/migrations/test_operations_database.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@


class TestSchemaEditor(BaseSchemaEditor):
__test__ = False

def _get_table_comment_sql(self, table: str, comment: str) -> str:
return ""

Expand Down
Loading