pytest-mrt 0.1.0__tar.gz

pytest_mrt-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v
+
+  test-postgres:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: mrt
+          POSTGRES_PASSWORD: mrt
+          POSTGRES_DB: mrt_test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install
+        run: pip install -e ".[dev]" psycopg2-binary
+
+      - name: Run postgres integration tests
+        env:
+          MRT_TEST_DB_URL: postgresql://mrt:mrt@localhost:5432/mrt_test
+        run: pytest tests/ -v -m postgres --ignore=tests/test_integration.py

pytest_mrt-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+# dependencies & build
+.venv/
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+.pytest_cache/
+
+# PyPI credentials — never commit
+.pypirc
+*.token
+
+# example DB files
+examples/**/*.db
+
+# secrets
+.env
+.env.*

pytest_mrt-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to pytest-mrt
+
+Thank you for considering a contribution. Here's how to get started.
+
+## Setup
+
+```bash
+git clone https://github.com/croc100/pytest-mrt
+cd pytest-mrt
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Running tests
+
+```bash
+# All tests (SQLite, no external dependencies)
+pytest tests/ -v
+
+# With PostgreSQL
+MRT_TEST_DB_URL=postgresql://localhost/mrt_test pytest tests/ -v -m postgres
+```
+
+## What to work on
+
+Good first issues:
+- Add a new static analysis pattern to `pytest_mrt/core/detector.py`
+- Add a new integration test case to `tests/test_integration.py`
+- Improve error messages in `pytest_mrt/reporter.py`
+
+Higher effort:
+- Django Migrations adapter (`pytest_mrt/adapters/django.py`)
+- MySQL support
+- HTML report output
+
+## Adding a new risk pattern
+
+1. Write a `_check_*` function in `pytest_mrt/core/detector.py`
+2. Add it to the `_CHECKS` list at the bottom
+3. Write a test in `tests/test_detector.py` (both a positive and a negative case)
+
+```python
+def _check_my_new_pattern(source: str, rev: str, fname: str) -> list[RiskWarning]:
+    body = _upgrade_body(source)
+    if re.search(r"some_pattern", body):
+        return [RiskWarning(rev, fname, "Pattern name",
+                            "Human-readable explanation of the risk", "error")]
+    return []
+```
+
+## Commit style
+
+```
+feat: add MySQL support
+fix: handle empty downgrade body correctly
+docs: add Django example
+test: cover NOT NULL without default on existing table
+```
+
+## Pull request checklist
+
+- [ ] Tests added for new behavior
+- [ ] All existing tests pass (`pytest tests/ -v`)
+- [ ] `mrt check examples/blog/alembic/versions/` still works

pytest_mrt-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 croc100
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytest_mrt-0.1.0/PKG-INFO

@@ -0,0 +1,335 @@
+Metadata-Version: 2.4
+Name: pytest-mrt
+Version: 0.1.0
+Summary: Catch database migration rollback failures before they reach production
+Project-URL: Homepage, https://github.com/croc100/pytest-mrt
+Project-URL: Repository, https://github.com/croc100/pytest-mrt
+Project-URL: Issues, https://github.com/croc100/pytest-mrt/issues
+Project-URL: Changelog, https://github.com/croc100/pytest-mrt/releases
+Author: croc100
+License: MIT License
+        
+        Copyright (c) 2026 croc100
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: alembic,database,migrations,pytest,rollback,sqlalchemy,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: alembic>=1.9
+Requires-Dist: pytest>=7.0
+Requires-Dist: rich>=13.0
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: typer>=0.9
+Provides-Extra: asyncpg
+Requires-Dist: asyncpg; extra == 'asyncpg'
+Provides-Extra: dev
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: psycopg2-binary; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# pytest-mrt
+
+<p align="center">
+  <strong>Migration Rollback Tester</strong><br>
+  Catch database migration disasters before they reach production.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/pytest-mrt"><img src="https://img.shields.io/pypi/v/pytest-mrt?color=blue" alt="PyPI"></a>
+  <a href="https://github.com/croc100/pytest-mrt/actions"><img src="https://img.shields.io/github/actions/workflow/status/croc100/pytest-mrt/ci.yml?branch=main" alt="CI"></a>
+  <a href="https://pypi.org/project/pytest-mrt"><img src="https://img.shields.io/pypi/pyversions/pytest-mrt" alt="Python"></a>
+  <a href="https://github.com/croc100/pytest-mrt/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-green" alt="License"></a>
+</p>
+
+---
+
+## The problem
+
+It's 2am. Your new feature is deployed. Something is wrong. You run `alembic downgrade -1`.
+
+The command succeeds. But the data is gone.
+
+The column came back. The rows didn't.
+
+---
+
+This happens because **most tools only check if your migration runs without errors** — not whether your data survives the round-trip. `alembic downgrade` can succeed while silently destroying everything it was supposed to restore.
+
+**pytest-mrt** tests the full cycle: seed real data → upgrade → downgrade → verify nothing was lost.
+
+---
+
+## Install
+
+```bash
+pip install pytest-mrt
+```
+
+---
+
+## Quickstart
+
+```python
+# conftest.py
+from pytest_mrt import MRTConfig
+
+def pytest_configure(config):
+    config._mrt_config = MRTConfig(
+        alembic_ini="alembic.ini",
+        db_url="postgresql://localhost/myapp_test",
+    )
+```
+
+```python
+# test_migrations.py
+def test_all_migrations_are_reversible(mrt):
+    mrt.assert_all_reversible()
+```
+
+```
+$ pytest test_migrations.py -s
+
+  ──────────── MRT — Migration Rollback Test ────────────
+
+  ✓  001  reversible
+  ✓  002  reversible
+  ✓  003  reversible
+  ✗  004  data loss detected
+     └─ Table 'users': 3/3 rows lost after rollback
+  ✗  005  data loss detected
+     └─ Table 'users' still exists after rollback — downgrade is incomplete
+
+  ╭─────────────────────────────────────────────────────╮
+  │  2 migration(s) will cause data loss on rollback.   │
+  │    004                                              │
+  │      └─ Table 'users': 3/3 rows lost after rollback │
+  │    005                                              │
+  │      └─ Table 'users' still exists after rollback   │
+  ╰─────────────────────────────────────────────────────╯
+```
+
+---
+
+## What it catches
+
+### Static analysis — before you even run
+
+| Pattern | Severity | Why it's dangerous |
+|---|---|---|
+| `op.drop_column()` in upgrade | 🔴 error | Column data is permanently gone |
+| `op.drop_table()` in upgrade | 🔴 error | All table data is permanently gone |
+| `TRUNCATE` in migration | 🔴 error | Destroys data with no undo |
+| `def downgrade(): pass` | 🔴 error | Rollback silently does nothing |
+| No `downgrade()` function | 🔴 error | Migration is completely irreversible |
+| `RunPython` without `reverse_func` | 🔴 error | Data transformation cannot be undone |
+| `NOT NULL` without `server_default` | 🟡 warning | Will fail on non-empty tables |
+| `ALTER COLUMN type_=...` | 🟡 warning | Type conversion may lose data |
+| `op.execute()` with raw SQL | 🟡 warning | Cannot verify reversibility |
+| Bulk `UPDATE` without reverse | 🟡 warning | One-way data transformation |
+| `ON DELETE CASCADE` added | 🟡 warning | Child rows silently deleted |
+| `CREATE INDEX` without `CONCURRENTLY` | 🟡 warning | Locks table during index build |
+| `ADD COLUMN` with `DEFAULT` | 🟡 warning | Full table rewrite on PostgreSQL < 11 |
+| `CREATE UNIQUE CONSTRAINT` | 🟡 warning | Will fail if duplicates exist |
+| `NOT NULL` without restoring `nullable` | 🟡 warning | Downgrade leaves column in wrong state |
+
+Run static analysis without a database:
+
+```bash
+mrt check migrations/versions/
+```
+
+```
+╭──────────────────────────────────────────────────────────────────────────────╮
+│                          Rollback Risk Analysis                              │
+├──────────┬──────────────────────┬─────────────┬───────────────────────────  │
+│ Revision │ Pattern              │ Sev         │ Message                       │
+├──────────┼──────────────────────┼─────────────┼───────────────────────────  │
+│ 004      │ DROP COLUMN          │ error       │ Data loss on rollback         │
+│ 005      │ No-op downgrade      │ error       │ downgrade() does nothing      │
+│ 006      │ INDEX without CONC.  │ warning     │ Locks table during build      │
+╰──────────────────────────────────────────────────────────────────────────────╯
+2 error(s), 1 warning(s)
+```
+
+### Dynamic verification — with real data
+
+pytest-mrt seeds actual rows before each migration, then checks they survive the downgrade:
+
+```python
+def test_specific_revision(mrt):
+    result = mrt.check_revision("abc123")
+    assert result.passed, result.failure_summary()
+```
+
+Or test everything at once:
+
+```python
+def test_all_migrations(mrt):
+    mrt.assert_all_reversible()
+```
+
+---
+
+## How it works
+
+For each migration revision, pytest-mrt:
+
+```
+1. Capture schema at current state
+2. Seed real data into all existing tables
+3. Run upgrade to this revision
+4. Run downgrade (one step back)
+5. Verify schema is exactly restored
+6. Verify every seeded row survived
+```
+
+This catches failures that syntax checks miss:
+- Schema comes back, but seeded rows are gone → **data loss**
+- Downgrade is a no-op, table still exists → **rollback did nothing**
+- Column returns but with wrong type → **schema drift**
+
+---
+
+## Supported databases
+
+| Database | Status |
+|---|---|
+| PostgreSQL | ✅ Full support |
+| SQLite | ✅ Full support (great for CI) |
+| MySQL / MariaDB | 🔜 Planned |
+
+---
+
+## CI integration
+
+Add to your GitHub Actions workflow:
+
+```yaml
+- name: Test migration rollbacks
+  run: pytest tests/test_migrations.py -v -s
+```
+
+Or use the static check as a fast pre-flight:
+
+```yaml
+- name: Static migration analysis
+  run: mrt check migrations/versions/ --strict
+```
+
+`--strict` makes warnings fail the build, not just errors.
+
+---
+
+## Configuration
+
+```python
+# conftest.py
+from pytest_mrt import MRTConfig
+
+def pytest_configure(config):
+    config._mrt_config = MRTConfig(
+        alembic_ini="alembic.ini",       # path to alembic.ini
+        db_url="postgresql://...",        # test database URL
+        seed_rows=5,                      # rows to seed per table (default: 3)
+    )
+```
+
+Use environment variables for CI:
+
+```python
+import os
+from pytest_mrt import MRTConfig
+
+def pytest_configure(config):
+    config._mrt_config = MRTConfig(
+        alembic_ini="alembic.ini",
+        db_url=os.environ["TEST_DATABASE_URL"],
+    )
+```
+
+---
+
+## Examples
+
+See [`examples/blog/`](examples/blog/) for a complete working example with:
+- Safe migrations (add nullable column, create table)
+- Dangerous migrations (drop column with data, no-op downgrade)
+- How pytest-mrt catches each failure
+
+```bash
+cd examples/blog
+pip install pytest-mrt
+pytest test_migrations.py -v -s
+```
+
+---
+
+## FAQ
+
+**Does it modify my production database?**
+No. pytest-mrt only runs against the database URL you provide in `MRTConfig`. Always use a test database.
+
+**Does it work with Django migrations?**
+Django support is on the roadmap. Currently only Alembic is supported.
+
+**How is this different from pytest-alembic?**
+`pytest-alembic` checks that migrations run without errors and that your schema matches your models. It does **not** verify that data survives a rollback. pytest-mrt focuses specifically on that gap.
+
+**My migration intentionally drops a column. Will this always fail?**
+Yes — dropping a column destroys data. That's exactly what pytest-mrt warns you about. If you want to proceed, you can exclude specific revisions or mark the test as expected-to-fail.
+
+---
+
+## Roadmap
+
+- [x] Alembic support
+- [x] Static risk analysis CLI (`mrt check`)
+- [x] Dynamic data integrity verification
+- [x] GitHub Actions CI
+- [ ] Django Migrations support
+- [ ] MySQL / MariaDB support
+- [ ] HTML report output
+- [ ] Per-revision exclusions (`@mrt.skip("004", reason="...")`)
+- [ ] PyPI release
+
+---
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## License
+
+Apache 2.0