テストカバレッジの計測

テストカバレッジとは、テストによってプログラムのコードがどの程度実行されたかを示す指標です。パーセンテージで表され、数値が高いほど多くのコードがテストで検証されていることを意味します。

カバレッジにはいくつかの種類があります。

  • 行カバレッジ(Line Coverage): コードの各行のうち、テストで実行された行の割合
  • 分岐カバレッジ(Branch Coverage): if文などの条件分岐のうち、テストで通過した分岐の割合
  • 関数カバレッジ(Function Coverage): 定義された関数のうち、テストで呼び出された関数の割合

pytestでは、pytest-covプラグインを使ってカバレッジを計測できます。requirements.txtにすでにpytest-covを含めてインストール済みです。

以下のコマンドでカバレッジ付きでテストを実行します。

Windowsの場合:

pytest tests/ --cov=src --cov-report=term-missing -v

Macの場合:

python3 -m pytest tests/ --cov=src --cov-report=term-missing -v
オプション 説明
--cov=src srcディレクトリのカバレッジを計測
--cov-report=term-missing カバレッジレポートをターミナルに表示し、未カバーの行番号も表示

実行結果の例は以下の通りです。

---------- coverage: platform darwin, python 3.12.x -----------
Name                    Stmts   Miss  Cover   Missing
-----------------------------------------------------
src/__init__.py             0      0   100%
src/calculator.py          10      0   100%
src/user_service.py        18      0   100%
src/weather_client.py      18      0   100%
-----------------------------------------------------
TOTAL                      46      0   100%

出力の読み方は以下のとおりです。

  • Stmtsは、ファイル内の実行可能な文(ステートメント)の総数を表します
  • Missは、テストで実行されなかった文の数を表します
  • Coverは、カバレッジ率((Stmts - Miss) / Stmts × 100)を表します
  • Missingは、テストで実行されなかった行番号を表します

前のセクションのモックテストで、weather_client.py の成功パス(fetch_weather の try ブロック内の HTTP レスポンス解析)とエラーパス(except ブロック)の両方を検証しました。両方の分岐が実行されたことで、weather_client.py を含めた全ファイルが100%のカバレッジとなっています。Missing列に行番号が並んだ場合は、その行を通過していないテストが不足していることを示すため、必要に応じてテストケースを追加します。

📝 カバレッジの目安
カバレッジ80%以上を目標にすることが一般的ですが、数値だけを追い求めず、重要なビジネスロジックが確実にテストされていることが重要です。