pytest-htmlでテスト関数のdocstringをレポートに出力する

テスト関数の詳細情報としてdocstringをpytest-htmlのレポートに出力する方法をまとめます。

1. conftest.pyを編集

testsディレクトリ直下のconftest.py(なければ作成)に以下の設定を追記します。
テーブルヘッダーの３列目にタイトル、テーブルボディの３列目にテスト関数のdocstringの情報を挿入しています。

conftest.py

import pytest
from py.xml import html


def pytest_html_results_table_header(cells):
    cells.insert(2, html.th('Description'))

def pytest_html_results_table_row(report, cells):
    cells.insert(2, html.td(report.description))

@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result()
    report.description = str(item.function.__doc__)

2. テストコードにdocstringを書く

def test_one(self):
    """
    これはテスト１です
    """
    assert True

def test_two(self):
    """
    これはテスト２です
    """
    assert False

3. テスト実行

$ pytest --html=report.html

4. 結果

テーブルの３列目に各テスト関数のdocstringが表示されています。

参考

• https://github.com/pytest-dev/pytest-html