Skip to main content

Catch database migration rollback failures before they reach production

Project description

pytest-mrt

PyPI CI 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 24 known dangerous patterns.

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     │ Message                            │
├──────────┼──────────────────────────┼─────────┼────────────────────────────────────┤
│ 004      │ DROP COLUMN in upgrade   │ error   │ Data permanently lost on rollback  │
│ 005      │ No-op downgrade          │ error   │ downgrade() does nothing           │
│ 006      │ INDEX without CONCURR.   │ warning │ 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()
  • 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 🔜 planned

Documentation

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

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.3.0.tar.gz (29.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-0.3.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pytest_mrt-0.3.0.tar.gz
Algorithm Hash digest
SHA256 255758c195c76eb8647de5ce723cc897864249a7ff897a532af6debe2b1df12f
MD5 ee397fbf343c063140c32103a707db5c
BLAKE2b-256 caf9eeb100e00844d34abe5c2e38e3ab68914841c54b012925bd22d919cde4eb

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for pytest_mrt-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64c95d8222bbb06c50f24133998eac530cebea91a872356b4836172d6d6d7e00
MD5 81e10b5e69c0a8d27f5922c2b744208b
BLAKE2b-256 69d5d565ea910514a9d40f94d356bdcf7d4f62484f8264cf9e0ba22b794aa32b

See more details on using hashes here.

Provenance

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