pytest入門 †

↑

インストール †

pip install pytest
pip install pytest-cov
↑

ファイル/フォルダ構成 †

https://docs.pytest.org/en/latest/goodpractices.html#choosing-a-test-layout-import-rules

pytestのドキュメントにはいくつかの構成が記載されている。
規模や用途に応じて選択すれば良いと思うが、src と tests とフォルダ分けする場合のPATHの指定方法がいまいち良くわからない。
テストコード自体をどこから探すのかは、pytest.ini または pytest 実行時のオプションで testpaths を指定すれば良いらしいが、
テスト対象のソースの格納先をどのように指定するのか良くわからない。（現時点では深く追ってないので詳細不明）

setup.py
mypkg/
　...
tests/
　__init__.py
　foo/
　　__init__.py
　　test_view.py
　bar/
　　__init__.py
　　test_view.py

setup.py
src/
　mypkg/
　　__init__.py
　　app.py
　　view.py
tests/
　__init__.py
　foo/
　　__init__.py
　　test_view.py
　bar/
　　__init__.py
　　test_view.py

↑

セットアップコードと conftest.py †

↑

テストコードの基本形 †

以下の命名規則に従っていれば、テストコードとして認識される。

例)

def test_sample_function1():
    print("test_sample_function1")
    assert True

def test_sample_function2():
    print("test_sample_function2")
    assert False

class TestSampleClass():
    def test_class_function():
        print("test_class_function1")               
        assert True
↑

assert の書き方 †

https://docs.pytest.org/en/latest/assert.html

↑

基本形 †

assert 条件(※)  [, エラーメッセージ]

※ True の時に成功となる。

↑

文字列マッチング †

assert 'match string' in str(result)
↑

例外を期待する場合 †

with pytest.raises(ZeroDivisionError):
    1 / 0



with pytest.raises(ValueError, match=r'.* 123 .*'):
    myfunc()
↑

fixtureの利用(テスト前後に行う処理) †

fixtureを使用してテストの前後に行う処理を指定する事ができる。

↑

scope について †

fixture に scope を指定する事で、どの単位の前処理、後処理なのか明示する事ができる。

scope説明
sessionテスト全体の前後処理
function各テストfunction毎に行う前後処理
class各テストclass毎に行う前後処理
module各テストモジュール毎に行う前後処理
package各テストパッケージ毎に行う前後処理

例)

import pytest

@pytest.fixture(scope='session', autouse=True)
def session_fixture():
    print("テスト全体の前処理")
    yield
    print("テスト全体の後処理")

@pytest.fixture(scope='module', autouse=True)
def module_fixture():
    print("モジュールの前処理")
    yield
    print("モジュールの後処理")


@pytest.fixture(scope='class', autouse=True)
def class_fixture():
    print("クラスの前処理")
    yield
    print("クラスの後処理")


@pytest.fixture(scope='function', autouse=True)
def function_fixture():
    print("関数の前処理")
    yield
    print("関数の後処理")
↑

yield について †

fixture 内に yield を記述する事で、テスト後に行う処理を記述する事が出来る。
yield が記述されていないと、全てテストの前に実行されてしまうので注意が必要。

@pytest.fixture(scope='function', autouse=True)
def module_fixture():
    print("関数の前処理")
    yield
    print("関数の後処理")
↑

fixture からパラメータを受け取る †

yield に引数を付けて実行すると、テストコード側で yield の引数を受け取る事ができる。
セットアップコードで生成したインスタンス等を利用してテストコードを実行したい場合等に利用できる。

import pytest
import datetime

@pytest.fixture(scope='module', autouse=True)
def module_fixture1():
    print("モジュールの前処理")
    now = datetime.datetime.now()
    yield {'now': now}
    print("モジュールの後処理")

def test_fixture_param(module_fixture1):  # 引数に対象のfixtureの関数名を指定する
    #print(f'now: {module_fixture1["now"]')
    now = module_fixture1['now']
    print(f'now: {now}')
↑

実行する fixture をテストコード毎に指定する †

以下の例では、test_fixture_sample2 の時のみ、前処理、後処理として fixture_for_sample2 が実行される。

import pytest

@pytest.fixture
def fixture_for_sample2():
    print("サンプル2用の前処理")
    yield
    print("サンプル2用の後処理")

def test_fixture_sample1():
    print('test_fixture_sample1')

def test_fixture_sample2(fixture_for_sample2):  # 引数に実行するfixtureを指定する
    print('test_fixture_sample2')

def test_fixture_sample3():
    print('test_fixture_sample3')
↑

mark の利用 †

↑

同じテストを値を変えて行う †

pytest.mark.parametrize を使用すると、同じメソッドのテストを引数を得変えてテストする事ができる。

pytest.mark.parametrize を使用しない場合

import pytest

# テスト用に直書き
def sample_div(a, b): 
    return a / b 

def test_sample_div():
    assert sample_div(10, 5) == 2
    assert sample_div(1, 1) == 1
    assert sample_div(10, 1) == 10
    with pytest.raises(ZeroDivisionError):
        sample_div(a, b)

pytest.mark.parametrize を使用する場合

import pytest

# テスト用に直書き
def sample_div(a, b): 
    return a / b 

@pytest.mark.parametrize('a, b, expected', [
    (10, 5, 2), 
    (1, 1, 1), 
    (10, 1, 10),
    (10, 0, ZeroDivisionError),
])

def test_sample_div(a, b, expected):
    if type(expected) == int:
        assert sample_div(a, b) == expected
    else:
        with pytest.raises(expected):
            sample_div(a, b)
↑

テストをグループ化する †

pytest.mark に続いて任意の名前を付けておくと、テストコードをグループ化する事ができ、グループ毎にテストを実行する事ができる。

import pytest

@pytest.mark.service1
def test_sample_func1():
    print('test_sample_func1')

@pytest.mark.service1
def test_sample_func2():
    print('test_sample_func2')

@pytest.mark.service2
def test_sample_func3():
    print('test_sample_func3')

実行例 ( service1 のテストコードのみ実行する )

mytest -m service1 -v
↑

Tips †

↑

標準出力に表示する †

pytest -s
↑

処理時間を計測する †

pytest --durations=0
pytest -v --duration=0
↑

テストケース別に結果を表示する †

pytest -v
↑

前回NGだったケースだけテストする †

pytest -v --lf
↑

前回NGだったケースからテストする †

pytest -v --ff
↑

遅いテストケースを見つける †

pytest -v --duration=5
↑

テストのログをファイルに出力する †

pytest -v --result-log=tests/log.txt
↑

カバレッジを確認する †

pytest -v --cov=ディレクトリ
↑

HTML形式のカバレッジレポートを出力する †

pytest -v --cov=ディレクトリ --cov-report=html
↑

テストで実行されなかった行を表示する †

pytest -v --cov=ディレクトリ --cov-report=term-missing
トップ   一覧 単語検索 最終更新   ヘルプ   最終更新のRSS