Skip to main content

Catch database migration rollback failures before they reach production

Project description

pytest-mrt

PyPI Downloads Used by CI Coverage Production/Stable Python 3.10-3.13 MIT License Contributors

A pytest plugin that catches database migration rollback failures before they reach production.

mrt check catching DROP COLUMN data loss


alembic downgrade -1 ran clean. No errors. Your monitoring went green.

But the users' phone numbers are gone. The column came back. The data didn't.

pytest-mrt would have caught this before it reached production:

$ mrt check migrations/versions/

                         Rollback Risk Analysis
╭──────────┬────────┬───────────────────────────┬───────┬──────┬─────────────────────────────────────╮
│ Revision │ Code   │ Pattern                   │ Sev   │ Line │ Message                             │
├──────────┼────────┼───────────────────────────┼───────┼──────┼─────────────────────────────────────┤
│ 042      │ MRT201 │ DROP COLUMN in upgrade    │ error │   18 │ op.drop_column('users', 'phone') —  │
│          │        │                           │       │      │ column data is permanently lost     │
│          │        │                           │       │      │ even if downgrade re-adds the column│
╰──────────┴────────┴───────────────────────────┴───────┴──────┴─────────────────────────────────────╯
1 error(s), 0 warning(s)

Non-invasive — installs in 2 minutes, zero changes to your existing tests.


What it does

Most tools verify that migrations run without errors.
pytest-mrt verifies that your data survives a rollback.

It seeds real rows before each migration, rolls back, and checks nothing was lost. It also statically scans migration files for 44 known dangerous patterns across both Alembic and Django migrations.

Install

pip install pytest-mrt

Setup (2 minutes)

Add this to conftest.py:

# conftest.py
import os
from pytest_mrt import MRTConfig


def pytest_configure(config):
    config._mrt_config = MRTConfig(
        alembic_ini="alembic.ini",
        db_url=os.environ.get("TEST_DATABASE_URL", "sqlite:///test.db"),
    )

That's it. Run pytest and 6 safety tests appear automatically — no test files needed:

PASSED test_mrt_single_head          - Migration history has exactly one head
PASSED test_mrt_upgrade              - alembic upgrade head completes without error
PASSED test_mrt_downgrade_base       - alembic downgrade base then re-upgrade completes cleanly
PASSED test_mrt_up_down_consistency  - Every migration is safely reversible
PASSED test_mrt_static_no_errors     - Zero static analysis errors in all migration files
PASSED test_mrt_schema_matches_models- Database schema matches ORM models after upgrade

Want to write custom rollback tests? Use the mrt fixture — just add it as a parameter to any test function, no import needed:

def test_migration_003(mrt):
    mrt.assert_reversible("abc1234")

Static analysis (no database needed)

mrt check migrations/versions/
╭──────────┬──────────────────────────┬─────────┬──────┬─────────┬────────────────────────────────────╮
│ Revision │ Pattern                  │ Sev     │ Line │ Code    │ Message                            │
├──────────┼──────────────────────────┼─────────┼──────┼─────────┼────────────────────────────────────┤
│ 004      │ DROP COLUMN in upgrade   │ error   │   12 │ MRT103  │ Data permanently lost on rollback  │
│ 005      │ No-op downgrade          │ error   │    8 │ MRT102  │ downgrade() does nothing           │
│ 006      │ INDEX without CONCURR.   │ warning │   19 │ MRT207  │ Locks table during index build     │
╰──────────┴──────────────────────────┴─────────┴──────┴─────────┴────────────────────────────────────╯
2 error(s), 1 warning(s)

What gets caught

Errors (will cause data loss or a broken rollback):

  • op.drop_column() in upgrade — data is gone even if downgrade re-adds the column
  • op.drop_table() in upgrade — all rows permanently lost
  • TRUNCATE in migration
  • def downgrade(): pass — rollback silently does nothing
  • No downgrade() function
  • rename_table / rename_column without reverse
  • DROP VIEW without recreating in downgrade
  • ALTER TYPE ... ADD VALUE (PostgreSQL ENUM) — can't roll back once rows use the new value
  • Add column + migrate data + drop original in one migration

Warnings (review before deploying):

  • NOT NULL without server_default
  • Column type change
  • Raw op.execute() / context.execute() without reverse
  • op.execute(sa.text(...)) — SQL inside sa.text() wrapper now fully analyzed
  • op.bulk_insert() without corresponding DELETE in downgrade
  • Bulk UPDATE without a reverse UPDATE in downgrade
  • ON DELETE CASCADE added
  • CREATE INDEX without CONCURRENTLY (PostgreSQL)
  • ADD COLUMN with DEFAULT on large tables
  • CREATE UNIQUE CONSTRAINT on existing data
  • DROP INDEX without recreating
  • DROP CONSTRAINT without recreating
  • ALTER SEQUENCE / setval
  • NOT NULL via raw SQL without reverse
  • NOT NULL without restoring nullable in downgrade

Databases

Static analysis Dynamic verification
PostgreSQL Yes Yes
SQLite Yes Yes
MySQL / MariaDB Yes Yes
Oracle Yes Yes
SQL Server Yes Yes
pip install pytest-mrt[mysql]    # PyMySQL
pip install pytest-mrt[oracle]   # python-oracledb
pip install pytest-mrt[mssql]    # pymssql

pre-commit integration

Add to .pre-commit-config.yaml to run mrt check automatically before every push:

# Alembic
- repo: https://github.com/croc100/pytest-mrt
  rev: v1.4.0
  hooks:
    - id: mrt-check
      args: [alembic/versions/]

# Django
- repo: https://github.com/croc100/pytest-mrt
  rev: v1.4.0
  hooks:
    - id: mrt-check
      args: [myapp/migrations/]

Update rev to the latest release tag. Run pre-commit autoupdate to keep it current.

Incremental CI — --since

Check only migrations added since a given revision. Keeps CI fast on large codebases:

# Alembic — pass a revision ID
mrt check migrations/versions/ --since a1b2c3d4

# Django — pass app_label.migration_name (filename without .py)
mrt check myapp/migrations/ --since myapp.0010_add_email

Pass the last migration on the base branch; only PR-new migrations are scanned.

When --since is active, graph-level checks (orphan detection, data-hole analysis) are skipped. Run without --since periodically for full coverage. See the CLI reference for the full format specification.

CI/CD integration

Drop mrt check into any pipeline as a pre-deploy gate:

# GitHub Actions — blocks merge if unsafe migrations are detected
- name: Migration safety check
  run: mrt check alembic/versions/ --strict

Full examples for GitHub Actions, GitLab CI, Jenkins, and pre-commit hooks are in examples/ci-integration/.

Docker

Run tests locally against PostgreSQL or MySQL without installing anything:

docker compose run test-postgres
docker compose run test-mysql

See docker-compose.yml for the full configuration.

Performance

10 migrations 50 migrations 100 migrations
mrt check (static, no DB) 22 ms 108 ms 216 ms
mrt fixture (SQLite) 0.33 s 4.3 s 15.6 s

Safe to run mrt check on every commit. Dynamic suite fits comfortably for projects up to ~200 migrations. For larger codebases, use MRTConfig(skip={...}) to exclude already-reviewed revisions. See benchmarks for methodology and PostgreSQL/MySQL numbers.

Suppress known risks (v1.2.0)

Use # noqa: MRTxxx on any line to suppress a specific warning — the same convention as ruff and flake8:

def upgrade():
    op.drop_column("users", "phone")  # noqa: MRT103

To suppress all MRT warnings on a line:

    op.drop_column("users", "legacy_col")  # noqa

Legacy syntax # mrt: ignore is still supported for backward compatibility.

How it compares

pytest-mrt pytest-alembic alembic check django-test-migrations
Static analysis (no DB required) ✅ 44 patterns
Dynamic rollback testing
Data survival check (seeds rows, verifies after rollback) ❌ schema only
Django support
Pre-commit hook
Inline suppression (# noqa: MRTxxx)

The key difference from pytest-alembic: pytest-mrt seeds actual rows before each rollback and verifies they survive. A migration that reverses the schema cleanly but silently destroys data will pass pytest-alembic and fail pytest-mrt.

What's new in v1.4.0

  • mrt check --format json/html — structured JSON output for CI tooling; self-contained HTML safety report
  • mrt check --watch — re-runs automatically whenever a migration file changes
  • mrt check --min-revision — skip revisions older than a configured floor (mirrors MRTConfig.minimum_downgrade_revision)
  • Django squashmigrations detection — MRT601/MRT602 catch unsafe RunPython in squashed migrations
  • minimum_downgrade_revision in dynamic tests — floor now respected by the mrt fixture check_all(), not just static analysis

Changelog

See CHANGELOG.md for the full release history.

Documentation

Full docs at croc100.github.io/pytest-mrt

Production SQLite monitoring

pytest-mrt catches rollback failures at test time. For production SQLite monitoring — schema drift detection, backup integrity, and continuous alerting — see Litescope.

# Catch drift in production after deploy
litescope monitor check production.db --baseline baseline.json

Sponsorship

pytest-mrt is MIT-licensed and free to use. If it saves you from a production incident, consider sponsoring development:

github.com/sponsors/croc100

Sponsorship directly funds:

  • New pattern development (Oracle, SQL Server, more Django patterns)
  • Maintained compatibility with new Alembic and SQLAlchemy releases

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_mrt-1.5.0.tar.gz (253.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytest_mrt-1.5.0-py3-none-any.whl (69.0 kB view details)

Uploaded Python 3

File details

Details for the file pytest_mrt-1.5.0.tar.gz.

File metadata

  • Download URL: pytest_mrt-1.5.0.tar.gz
  • Upload date:
  • Size: 253.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pytest_mrt-1.5.0.tar.gz
Algorithm Hash digest
SHA256 6f99568a42168e776df55acaa88e8c237b22a0ebe02aa3c5aaa0585e77c83e20
MD5 839fd7356bb76a4e13f2a73e59575bb6
BLAKE2b-256 53f06dd6d813d62e5c3ff9325e2d771fab3b33d5962f89ce84d4a94020c4437e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_mrt-1.5.0.tar.gz:

Publisher: publish.yml on croc100/pytest-mrt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pytest_mrt-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: pytest_mrt-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 69.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pytest_mrt-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75c48b0d2728b91e7506ac2393c2b5d443abe14437b2da1b54e99cb426c3ad6e
MD5 e70a6c9e69236bfdf7b50aadbffd3407
BLAKE2b-256 3e37c50ce0968241c83b2d8427c5d6729697568be4dc372485c821272121adcb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_mrt-1.5.0-py3-none-any.whl:

Publisher: publish.yml on croc100/pytest-mrt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page