pytest-dblift

pytest plugin for DBLift. It applies your migrations in tests and exposes a DBLiftClient.

This is a separate PyPI package, not dblift[pytest].

pytest-dblift 0.2.0 requires dblift 4.9.0 or later. dblift_validate calls DBLiftClient.validate in a way that dblift 4.8.0 does not accept.

Install

SQLite (default, stdlib driver):

pip install pytest-dblift

Any other engine: install the matching dblift extra so the native driver is present. The plugin does not install drivers and does not open a second connection — it calls create_engine(url) then DBLiftClient.from_sqlalchemy.

pip install pytest-dblift "dblift[postgresql]"
pytest --dblift-url "postgresql+psycopg://user:pass@localhost/app_test"

Quickstart

def test_schema(dblift_migrated_db, dblift_client):
    info = dblift_client.info()
    assert info.pending_migrations == []

dblift_migrated_db applies pending migrations (function scope). dblift_client is a session-scoped DBLiftClient. No fixture is autouse: request what you need.

Fixtures

Undo uses companion U* scripts (same as dblift). There is no undo() function inside a V*.py file.

def test_rollback(dblift_migrated_db, dblift_undo):
    result = dblift_undo(target_version="0")
    assert result.success

Override config in tests/conftest.py:

import pytest

@pytest.fixture(scope="session")
def dblift_config():
    return {
        "url": "postgresql+psycopg://user:pass@localhost/app_test",
        "migrations_dir": "migrations",
    }

CLI options

pytest-xdist: only the default SQLite file is per-worker (test_gw0.db, …). A URL you pass with --dblift-url is used as-is.