Pytest dan PostgreSQL: Pangkalan data baru untuk setiap ujian

Dalam Pytest, rangka kerja ujian Python kegemaran semua orang, lekapan ialah sekeping kod boleh guna semula yang menyusunsesuatusebelum ujian masuk dan pembersihan selepas ia berhenti. Contohnya, fail atau folder sementara, persekitaran persediaan, memulakan pelayan web, dll. Dalam siaran ini, kita akan melihatcara mencipta lekapan Pytest yang mencipta pangkalan data ujian (kosong atau dengan keadaan yang diketahui) yang dibersihkan, membenarkan setiap ujian dijalankan pada pangkalan data yang bersih sepenuhnya.

Matlamat

Kami akan mencipta lekapan Pytest menggunakan Psycopg 3 untuk menyediakan dan membersihkan pangkalan data ujian. Oleh kerana pangkalan data kosong jarang membantu untuk ujian, kami secara pilihan akan menggunakan migrasi Yoyo (pada masa penulisan tapak web tidak berfungsi, pergi ke gambar archive.org) untuk mengisinya.

Jadi, keperluan untuk lekapan Pytest bernama test_db yang dibuat dalam catatan blog ini ialah:

• jatuhkan pangkalan data ujianjika wujud sebelum ujian
• buat pangkalan data kosongsebelum ujian
• pilihangunakan migrasi atau buat data ujiansebelum ujian
• menyediakan sambungan ke pangkalan data ujianke ujian
• jatuhkan pangkalan data ujianselepas ujian (walaupun dalam kes kegagalan)

Sebarang kaedah ujian yang memintanya dengan menyenaraikannya sebagai hujah kaedah ujian:

def test_create_admin_table(test_db): ...

Akan menerima contoh Sambungan Psycopg biasa yang disambungkan ke DB ujian. Ujian boleh melakukan apa sahaja yang diperlukan seperti penggunaan biasa Psycopg biasa, cth.:

def test_create_admin_table(test_db): # Open a cursor to perform database operations cur = test_db.cursor() # Pass data to fill a query placeholders and let Psycopg perform # the correct conversion (no SQL injections!) cur.execute( "INSERT INTO test (num, data) VALUES (%s, %s)", (100, "abc'def")) # Query the database and obtain data as Python objects. cur.execute("SELECT * FROM test") cur.fetchone() # will return (1, 100, "abc'def") # You can use `cur.fetchmany()`, `cur.fetchall()` to return a list # of several records, or even iterate on the cursor for record in cur: print(record)

Susun atur fail projek

Dalam projek Python klasik, sumber hidup dalam src/ dan ujian dalam ujian/:

├── src │ └── tuvok │ ├── __init__.py │ └── sales │ └── new_user.py ├── tests │ ├── conftest.py │ └── sales │ └── test_new_user.py ├── requirements.txt └── yoyo.ini

Jika anda menggunakan pustaka migrasi seperti Yoyo yang hebat, skrip migrasi berkemungkinan dalam migrasi/:

├── migrations ├── 20240816_01_Yn3Ca-sales-user-user-add-last-run-table.py ├── ...

Konfigurasi

Lekapan DB ujian kami memerlukan konfigurasi yang sangat sedikit:

• URL sambungan- (tanpa pangkalan data)
• nama pangkalan data ujian- akan dicipta semula untuk setiap ujian
• (pilihan)folder migrasi- skrip migrasi untuk digunakan untuk setiap ujian

Pytest mempunyai tempat semula jadi conftest.py untuk berkongsi lekapan merentas berbilang fail. Konfigurasi lekapan akan pergi ke sana juga:

# Without DB name! TEST_DB_URL = "postgresql://localhost" TEST_DB_NAME = "test_tuvok" TEST_DB_MIGRATIONS_DIR = str(Path(__file__, "../../migrations").resolve())

Anda boleh menetapkan nilai ini daripada pembolehubah persekitaran atau apa sahaja yang sesuai dengan kes anda.

Buat lekapan test_db

Dengan pengetahuan tentangPostgreSQL dan perpustakaan Psycopg, tulis perlawanan dalam conftest.py:

@pytest.fixture def test_db(): # autocommit=True start no transaction because CREATE/DROP DATABASE # cannot be executed in a transaction block. with psycopg.connect(TEST_DB_URL, autocommit=True) as conn: cur = conn.cursor() # create test DB, drop before cur.execute(f'DROP DATABASE IF EXISTS "{TEST_DB_NAME}" WITH (FORCE)') cur.execute(f'CREATE DATABASE "{TEST_DB_NAME}"') # Return (a new) connection to just created test DB # Unfortunately, you cannot directly change the database for an existing Psycopg connection. Once a connection is established to a specific database, it's tied to that database. 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)')

Buat lekapan migrasi

Dalam kes kami, kami menggunakanMigrasi Yoyo. Tulis gunakan migrasi sebagai lekapan lain yang dipanggil yoyo:

@pytest.fixture def yoyo(): # Yoyo expect `driver://user:pass@host:port/database_name?param=value`. # In passed URL we need to url = ( urlparse(TEST_DB_URL) . # 1) Change driver (schema part) with `postgresql+psycopg` to use # psycopg 3 (not 2 which is `postgresql+psycopg2`) _replace(scheme="postgresql+psycopg") . # 2) Change database to test db (in which migrations will apply) _replace(path=TEST_DB_NAME) .geturl() ) backend = get_backend(url) migrations = read_migrations(TEST_DB_MIGRATIONS_DIR) if len(migrations) == 0: raise ValueError(f"No Yoyo migrations found in '{TEST_DB_MIGRATIONS_DIR}'") with backend.lock(): backend.apply_migrations(backend.to_apply(migrations))

Jika anda inginmemohon migrasi pada setiap pangkalan data ujian, perlukan lekapan yoyo untuk lekapan test_db:

@pytest.fixture def test_db(yoyo): ...

Kepadagunakan migrasi pada beberapa ujian sahaja, perlukan yoyo secara individu:

def test_create_admin_table(test_db, yoyo): ...

Kesimpulan

Membina lekapan sendiri untuk memberikan ujian anda pangkalan data yang bersih merupakan pengalaman yang menggembirakan bagi saya yang membolehkan saya menyelidiki lebih mendalam kedua-dua Pytest dan Postgres.

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

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