Flaskの単体テスト

Flaskでは、flask.testingという単体テスト用のモジュールが提供されている。 これをpytestで利用する場合の使い方をメモしておく。

appオブジェクトの取得・設定の更新

テストコードの中で、テスト対象となるflaskのappオブジェクトを取得する。 このオブジェクトに対して.config.updateを呼び出し、{"TESTING": True}を設定する。

例

from some_package import server

app = server.app
app.config.update({
    "TESTING": True
})

clientの取得・リクエストの送信

上で取得したappオブジェクトに対して、.test_clientを呼び出すと、テスト用のクライアントが手に入る。 このオブジェクトのget, postメソッドなどを呼び出すと、appのhttpリクエストに対する応答をテストできる。

例

client = app.test_client()
ret = client.get("/api/hello")
ret2 = client.post("/api/someFunc", data=data)
# ret, ret2に、httpリクエストに対するレスポンスが返ってくる

fixtureにする

pytestでは、複数のテストで共通に使うようなコード片はfixtureとしてまとめておくことができる。 fixtureは、テストファイルの中に書いても良いが、複数のファイルで共通に使うような物は、conftest.pyに記述することができる。

conftest.py

from typing import Generator
import pytest

from flask import Flask
from flask.testing import FlaskClient
from some_package import server

@pytest.fixture
def app() -> Generator[Flask, None, None]:
    app = server.app
    app.config.update({
        "TESTING": True
    })
    yield app

@pytest.fixture
def client(app: Flask) -> FlaskClient:
    return app.test_client()

上のconftest.pyと同じ階層に、例えばtest_server.pyというファイルを作ると、以下のようにサーバーをテストすることができる。

test_server.py

from flask.testing import FlaskClient

def test_filter(client: FlaskClient):
    ret = client.get("/hello")
    assert "hello" == ret.data.decode()