Testing Flask dengan Pytest dan Test Client
Mengecek route satu per satu lewat browser masih terasa ringan ketika aplikasi baru punya dua halaman. Begitu ada form, login, database, dan API, pengujian manual mudah melewatkan kasus penting. Test otomatis menyimpan perilaku yang kita harapkan dalam bentuk kode dan dapat dijalankan ulang setiap kali aplikasi berubah.
Flask menyediakan test client yang mengirim request langsung ke aplikasi. Development server tidak perlu dinyalakan dan tidak ada port jaringan yang dibuka. Dari sisi route, request tersebut tetap diproses seperti request biasa.
Siapkan Pytest dan Config Testing
Install pytest di virtual environment project:
# File: terminal
python -m pip install pytest
Supaya test dapat mengganti database dan config lain sebelum extension diinisialisasi, ubah factory agar menerima dictionary config opsional:
# File: app.py
from flask import Flask
from models import db
from routes.api import api_bp
from routes.notes import notes_bp
def create_app(test_config=None):
app = Flask(__name__)
app.config.from_object("config.Config")
if test_config is not None:
app.config.update(test_config)
db.init_app(app)
app.register_blueprint(notes_bp)
app.register_blueprint(api_bp)
return app
Config testing diterapkan sebelum db.init_app(app). Urutan ini memastikan SQLAlchemy membaca URI database test, bukan database development.
Buat Fixture App dan Client
Fixture pytest menyiapkan object yang bisa dipakai banyak test. tmp_path memberikan folder sementara yang berbeda untuk setiap test run, sehingga data percobaan tidak masuk ke app.db milik development.
# File: tests/conftest.py
import pytest
from app import create_app
from models import db
@pytest.fixture()
def app(tmp_path):
database_path = tmp_path / "test.db"
app = create_app({
"TESTING": True,
"SECRET_KEY": "test-secret",
"SQLALCHEMY_DATABASE_URI": f"sqlite:///{database_path}",
})
with app.app_context():
db.create_all()
yield app
with app.app_context():
db.session.remove()
db.drop_all()
@pytest.fixture()
def client(app):
return app.test_client()
Kode sebelum yield adalah setup. Setelah test selesai, eksekusi dilanjutkan untuk membersihkan session dan tabel. Pola ini menjaga test dapat diulang tanpa bergantung pada sisa data dari run sebelumnya.
Folder test sekarang terlihat seperti ini:
# File: test-structure.txt
tests/
├── conftest.py
├── test_pages.py
└── test_api.py
Pytest menemukan fixture di conftest.py secara otomatis, jadi file test tidak perlu meng-import client secara manual.
Mulai dari Route HTML
# File: tests/test_pages.py
def test_home_page_returns_success(client):
response = client.get("/")
assert response.status_code == 200
assert b"Hello, Flask!" in response.data
def test_unknown_page_returns_not_found(client):
response = client.get("/page-that-does-not-exist")
assert response.status_code == 404
Assertion pertama memeriksa status code. Assertion kedua melihat body response dalam bentuk bytes, karena response.data belum didecode menjadi string. Bisa juga gunakan response.get_data(as_text=True) jika perbandingan teks terasa lebih nyaman.
Nama test menjelaskan perilaku yang dijaga, bukan detail implementasi. Kalau route dipindahkan ke blueprint tetapi response-nya tetap sama, test tidak perlu ikut berubah.
Test Endpoint JSON
Parameter json={...} otomatis mengubah dictionary menjadi JSON dan memasang header Content-Type: application/json:
# File: tests/test_api.py
def test_create_note(client):
response = client.post("/api/notes", json={
"title": "Test Flask API",
})
assert response.status_code == 201
assert response.get_json()["data"]["title"] == "Test Flask API"
def test_create_note_rejects_empty_title(client):
response = client.post("/api/notes", json={"title": " "})
assert response.status_code == 422
body = response.get_json()
assert body["error"]["code"] == "validation_error"
def test_create_note_requires_json(client):
response = client.post("/api/notes", data="title=Note")
assert response.status_code == 415
Tiga test tersebut mewakili happy path dan dua kegagalan yang memang dijanjikan endpoint. Mengecek code error membuat test lebih bermakna daripada hanya memastikan body tidak kosong.
Jalankan dan Baca Hasil Test
Jalankan seluruh suite dari root project:
# File: terminal
python -m pytest -v
Opsi -v menampilkan nama setiap test. Untuk menjalankan satu file saja, gunakan python -m pytest tests/test_api.py -v.
Test yang baik tidak saling bergantung. test_create_note_rejects_empty_title harus tetap lulus meskipun dijalankan sendirian atau urutannya berubah. Hindari memakai database development sungguhan karena test bisa merusak data dan hasilnya bergantung pada keadaan lokal.
Setelah contoh ini lulus, tambahkan test untuk redirect form, route yang membutuhkan login, detail note yang tidak ada, serta delete. Tidak semua baris perlu dites, tetapi jalur yang paling penting dan kegagalan yang paling mungkin terjadi sebaiknya punya perlindungan.
Artikel Terkait
Lanjutkan membaca topik yang masih satu konteks.
Deploy Flask: Gunicorn, Environment, dan Production Checklist
Siapkan deploy Flask ke production dengan Gunicorn, environment variable, database migration, static files, logging, health check, dan checklist rilis.
Flask API JSON: Request Body, jsonify, dan Status Code
Buat Flask API JSON yang membaca request body, memvalidasi payload, menyimpan note, dan mengembalikan response serta status code yang konsisten.
Flask Authentication: Login, Session, dan Logout
Buat authentication Flask dengan password hash, login session, current user, protected route, dan logout tanpa menyimpan password mentah.
Flask CRUD SQLAlchemy: Create, Read, Update, Delete
Bangun CRUD Flask dan SQLAlchemy untuk membuat, membaca, mengubah, serta menghapus note lengkap dengan validasi, form, dan redirect.