Pytest dan PostgreSQL: Pangkalan data baru untuk setiap ujian (bahagian II)

Dalam siaran sebelumnya, kami mencipta lekapan Pytest yang akan mencipta/menggugurkan pangkalan data Postgres sebelum/selepas kaedah ujian. Dalam bahagian ini, saya ingin memperbaiki lekapan supaya lebih fleksibel dan boleh dikonfigurasikan dengan bantuan Lekapan kilang Pytest.

Had lekapan statik

Sebagai contoh, jika anda mempunyai lebih daripada satu pangkalan data untuk dipermainkan dalam ujian

def test_create_user(test_db1, test_db2):
    ...

anda mesti mencipta hampir dua lekapan yang sama:

TEST_DB_URL = "postgresql://localhost"
TEST_DB1_NAME = "test_foo"
TEST_DB2_NAME = "test_bar"

@pytest.fixture
def test_db1():
    with psycopg.connect(TEST_DB_URL, autocommit=True) as conn:
        cur = conn.cursor()

        cur.execute(f'DROP DATABASE IF EXISTS "{TEST_DB1_NAME}" WITH (FORCE)')
        cur.execute(f'CREATE DATABASE "{TEST_DB1_NAME}"')

        with psycopg.connect(TEST_DB_URL, dbname=TEST_DB1_NAME) as conn:
            yield conn

        cur.execute(f'DROP DATABASE IF EXISTS "{TEST_DB1_NAME}" WITH (FORCE)')

@pytest.fixture
def test_db2():
    with psycopg.connect(TEST_DB_URL, autocommit=True) as conn:
        cur = conn.cursor()

        cur.execute(f'DROP DATABASE IF EXISTS "{TEST_DB2_NAME}" WITH (FORCE)')
        cur.execute(f'CREATE DATABASE "{TEST_DB2_NAME}"')

        with psycopg.connect(TEST_DB_URL, dbname=TEST_DB2_NAME) as conn:
            yield conn

        cur.execute(f'DROP DATABASE IF EXISTS "{TEST_DB2_NAME}" WITH (FORCE)')

Kilang lekapan Pytest

Lekapan "Statik" agak terhad di sini. Apabila diperlukan hampir sama dengan hanya sedikit perbezaan, anda perlu menduplikasi kod. Mudah-mudahan, Pytest mempunyai konsep kilang sebagai lekapan.

Lekapan kilang ialah lekapan yang mengembalikan lekapan lain. Kerana, seperti setiap kilang, ia adalah satu fungsi, ia boleh menerima hujah untuk menyesuaikan lekapan yang dikembalikan. Mengikut konvensyen, anda boleh mengawalnya dengan make_*, seperti make_test_db.

Lekapan khusus

Satu-satunya hujah untuk make_test_db kilang lekapan kami ialah nama pangkalan data ujian untuk dibuat/digugurkan.

Jadi, mari kita cipta dua lekapan "khusus" berdasarkan lekapan kilang make_test_db.

Penggunaan akan kelihatan seperti:

@pytest.fixture
def test_db_foo(make_test_db):
    yield from make_test_db("test_foo")

@pytest.fixture
def test_db_bar(make_test_db):
    yield from make_test_db("test_bar")

Sidenote: hasil daripada

Adakah anda perasan hasil daripada? Terdapat perbezaan utama antara hasil dan hasil daripada cara mereka mengendalikan aliran data dan kawalan dalam penjana.

Dalam Python, kedua-dua hasil dan hasil daripada digunakan dalam fungsi penjana untuk menghasilkan jujukan nilai, tetapi

• hasil digunakan untuk menjeda pelaksanaan fungsi penjana dan mengembalikan satu nilai kepada pemanggil.
• sementara hasil daripada digunakan untuk mewakilkan penjanaan nilai kepada penjana lain. Ia pada asasnya "meratakan" penjana bersarang, menghantar nilai terhasilnya terus kepada pemanggil penjana luar.

Iaitu, kami tidak mahu "menghasilkan" daripada lekapan khusus tetapi dari kilang lekapan. Oleh itu hasil daripada diperlukan di sini.

Kilang lekapan untuk mencipta/menggugurkan pangkalan data

Perubahan yang diperlukan pada pangkalan data mencipta/menggugurkan lekapan asal kami sebenarnya hampir tiada kecuali membungkus kod ke fungsi dalaman.

@pytest.fixture
def make_test_db():
    def _(test_db_name: str):
        with psycopg.connect(TEST_DB_URL, autocommit=True) as conn:
            cur = conn.cursor()

            cur.execute(f'DROP DATABASE IF EXISTS "{test_db_name}" WITH (FORCE)') # type: ignore
            cur.execute(f'CREATE DATABASE "{test_db_name}"') # type: ignore

            with psycopg.connect(TEST_DB_URL, dbname=test_db_name) as conn:
                yield conn

            cur.execute(f'DROP DATABASE IF EXISTS "{test_db_name}" WITH (FORCE)') # type: ignore

    yield _

Bonus: Tulis semula lekapan migrasi sebagai lekapan kilang

Di bahagian sebelumnya, saya juga mempunyai lekapan yang menggunakan migrasi Yoyo untuk mencipta pangkalan data kosong. Ia juga tidak begitu fleksibel. Mari kita lakukan perkara yang sama dan bungkus kod sebenar ke fungsi dalaman.

Dalam kes ini, kerana kod tidak perlu melakukan pembersihan selepas pemulangan daripada kaedah ujian (tiada hasil di dalamnya),

• Lekapan kilang mengembalikan (bukan hasil) fungsi dalaman
• panggilan lekapan khusus (bukan hasil daripada) lekapan kilang

@pytest.fixture
def make_yoyo():
    """Applies Yoyo migrations to test DB."""
    def _(test_db_name: str, migrations_dir: str):
        url = (
            urlparse(TEST_DB_URL)
            .
            _replace(scheme="postgresql+psycopg")
            .
            _replace(path=test_db_name)
            .geturl()
        )

        backend = get_backend(url)
        migrations = read_migrations(migrations_dir)

        if len(migrations) == 0:
            raise ValueError(f"No Yoyo migrations found in '{migrations_dir}'")

        with backend.lock():
            backend.apply_migrations(backend.to_apply(migrations))

    return _

@pytest.fixture
def yoyo_foo(make_yoyo):
    migrations_dir = str(Path(__file__, "../../foo/migrations").resolve())
    make_yoyo("test_foo", migrations_dir)

@pytest.fixture
def yoyo_bar(make_yoyo):
    migrations_dir = str(Path(__file__, "../../bar/migrations").resolve())
    make_yoyo("test_bar", migrations_dir)

Kaedah ujian yang memerlukan dua pangkalan data dan menggunakan migrasi kepada mereka:

from psycopg import Connection

def test_get_new_users_since_last_run(
        test_db_foo: Connection,
        test_db_bar: Connection,
        yoyo_foo,
        yoyo_bar):
    test_db_foo.execute("...")
    ...

Kesimpulan

Membina kilang lekapan anda sendiri mencipta dan menggugurkan pangkalan data untuk kaedah Pytest sebenarnya merupakan latihan yang baik untuk mengamalkan penjana Python dan hasil/hasil daripada pengendali.

Saya harap artikel ini membantu anda dengan suite ujian pangkalan data anda sendiri. Sila tinggalkan saya soalan anda dalam komen dan selamat mengekod!

Atas ialah kandungan terperinci Pytest dan PostgreSQL: Pangkalan data baru untuk setiap ujian (bahagian II). Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!