Skip to main content

Catch database migration rollback failures before they reach production

Project description

pytest-mrt

PyPI CI Coverage Coverage 88% Python MIT License

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


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.


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 30 known dangerous patterns across both Alembic and Django migrations.

Django note: static pattern detection is fully supported. Dynamic rollback verification (manage.py migrate --backwards) is on the roadmap for v0.9 — not yet implemented.

Install

pip install pytest-mrt

Setup (2 minutes)

1. Create conftest.py in your project root:

# conftest.py
import os
from pytest_mrt import MRTConfig


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

2. Write a test:

# tests/test_migrations.py


def test_migrations_are_safe(mrt):
    mrt.assert_all_reversible()

3. Run:

pytest tests/test_migrations.py -s

mrt is a pytest fixture — just add it as a parameter and it works. No import needed in test files.

Static analysis (no database needed)

mrt check migrations/versions/
╭──────────┬──────────────────────────┬─────────┬──────┬────────────────────────────────────╮
│ Revision │ Pattern                  │ Sev     │ Line │ Message                            │
├──────────┼──────────────────────────┼─────────┼──────┼────────────────────────────────────┤
│ 004      │ DROP COLUMN in upgrade   │ error   │   12 │ Data permanently lost on rollback  │
│ 005      │ No-op downgrade          │ error   │    8 │ downgrade() does nothing           │
│ 006      │ INDEX without CONCURR.   │ warning │   19 │ 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
SQLite
MySQL / MariaDB
Oracle
SQL Server
pip install pytest-mrt[mysql]    # PyMySQL
pip install pytest-mrt[oracle]   # python-oracledb
pip install pytest-mrt[mssql]    # pymssql

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.

Changelog

See CHANGELOG.md for the full release history.

Documentation

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

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)
  • Django dynamic rollback verification (v0.9 target)
  • 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-0.9.0.tar.gz (111.6 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-0.9.0-py3-none-any.whl (48.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pytest_mrt-0.9.0.tar.gz
Algorithm Hash digest
SHA256 25dca5c99f03c208c9db37e29e6eb697c4b0bb4f6e4f6c905cc7a94e2a232967
MD5 fad5534c43d0e6f0ea58ae21149724dd
BLAKE2b-256 2501f92fc6814f3d9564266a0ef4c5fcf2be803201626910c849167b40fd1411

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_mrt-0.9.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-0.9.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pytest_mrt-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 73d4d86f94be257ce1f7fbe5d6b7b6703a0a7f6801207126082e28a0079085b5
MD5 21d960284edfa83d29ddc98893f0b25a
BLAKE2b-256 fc3a188cd74662616302338cbe2a7fb3e8b0e61b2039967a1ba14d00275dff78

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_mrt-0.9.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