【Docker × Python】コンテナでのpytest実行とカバレッジ確認をVScodeする方法

Copy
.
|-- .coveragerc
|-- Dockerfile
|-- app
|   |-- __init__.py
|   `-- execute_module.py
|-- docker-compose.yml
|-- requirements.txt
|-- tests
|   |-- __init__.py
|   `-- test_execute_module.py
`-- vscode_ex_install.sh

Copy
# イメージ
FROM python:3.12

# パッケージを最新化
RUN python -m pip install --upgrade pip

# workspaceディレクトリを作成
WORKDIR /workspace

# workspaceにrequirements.txtをコピー
COPY requirements.txt /workspace/

# requirements.txtのパッケージをインストール
RUN pip install -r requirements.txt

Copy
pytest==8.2.2
pytest-cov==5.0.0

Copy
version: "3"
services:
  pytest:
    container_name: "container_pytest"

    # Dockerfileをビルド
    build:
      context: .
      dockerfile: Dockerfile
    tty: true

    # プロジェクトをバインドマウント
    volumes:
      - .:/workspace

Copy
[run]
omit = test_*.py

Copy
#!/bin/bash

# 拡張機能のIDリスト
extensions=(
    "ms-python.python"
    "ryanluker.vscode-coverage-gutters"
)

# 各拡張機能をインストール
for extension in "${extensions[@]}"; do
    code --install-extension $extension
done

Copy
class ExecuteClass:
    def __init__(self,param1, param2):
        self.param1 = param1
        self.param2 = param2

    def callParam1(self):
        return self.param1

    def callParam2(self):
        return self.param2

def main():
    instance = ExecuteClass(1,2)
    print(instance.callParam1())
    print(instance.callParam2())

if __name__ == "__main__": # pragma: no cover
    main()

Copy
import pytest
from app.execute_module import ExecuteClass,main

@pytest.fixture
def test_setup():
    # ExecuteClassのインスタンスを作成
    execute_instance = ExecuteClass(1,2)
    return execute_instance

def test_callParam1(test_setup):

    execute_instance = test_setup
    # callParam1を呼び出し、結果を取得
    result = execute_instance.callParam1()
    # 戻り値をアサート
    assert result == 1

def test_callParam2(test_setup):

    execute_instance = test_setup
    # callParam1を呼び出し、結果を取得
    result = execute_instance.callParam2()
    # 戻り値をアサート
    assert result == 2

def test_main(capfd):
    # main関数を呼び出す
    main()
    # 標準出力をキャプチャ
    out, err = capfd.readouterr()
    # 標準出力が期待通りであることをアサート
    assert out == "1\n2\n"
    # エラー出力がないことをアサート
    assert err == ""

Copy
# コンテナ作成
docker compose up -d

# コンテナ確認
docker ps
CONTAINER ID   IMAGE                  COMMAND     CREATED          STATUS          PORTS     NAMES
82374e8c81da   pytest_vscode-pytest   "python3"   22 seconds ago   Up 21 seconds             container_pytest

Copy
root@82374e8c81da:/workspace# bash vscode_ex_install.sh

Copy
{
    // pytestに渡す引数を指定します。
    // --cov=. はカバレッジを計測する対象を現在のディレクトリ（つまりプロジェクト全体）に設定します。
    // --cov-report xml はカバレッジレポートをXML形式で出力するように指定します。
    "python.testing.pytestArgs": [
        "--cov=.",
        "--cov-report",
        "xml"
    ],
    // unittestフレームワークを無効にします。
    "python.testing.unittestEnabled": false,
    // pytestフレームワークを有効にします。これにより、VS Codeはpytestを使ってテストを実行します。
    "python.testing.pytestEnabled": true,
    // エディタのガター（行番号のある領域）にカバレッジ情報を表示するかどうかを設定します。
    // false にすることで、ガターにカバレッジ情報を表示しないようにします。
    "coverage-gutters.showGutterCoverage": false,
    // エディタで各行のカバレッジ情報を表示するかどうかを設定します。
    // true にすることで、各行にカバレッジ情報を表示するようにします。
    "coverage-gutters.showLineCoverage": true
}

Copy
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "debugpy",
            "request": "launch",
            "program": "${file}",
            "purpose": [
                "debug-test"
            ],
            "console": "integratedTerminal",
            "env": {
                "PYTEST_ADDOPTS": "--no-cov"
            }
        }
    ]
}

Copy
root@82374e8c81da:/workspace# pytest
=============================================================================== test session starts ================================================================================
platform linux -- Python 3.12.4, pytest-8.2.2, pluggy-1.5.0
rootdir: /workspace
plugins: cov-5.0.0
collected 3 items                                                                                                                                                                  

tests/test_execute_module.py ...                                                                                                                                             [100%]

================================================================================ 3 passed in 0.77s =================================================================================
root@82374e8c81da:/workspace#

Copy
root@82374e8c81da:/workspace# pytest -v --cov=app
======================================================================================= test session starts =======================================================================================
platform linux -- Python 3.12.4, pytest-8.2.2, pluggy-1.5.0 -- /usr/local/bin/python
cachedir: .pytest_cache
rootdir: /workspace
plugins: cov-5.0.0
collected 3 items                                                                                                                                                                                 

tests/test_execute_module.py::test_callParam1 PASSED                                                                                                                                        [ 33%]
tests/test_execute_module.py::test_callParam2 PASSED                                                                                                                                        [ 66%]
tests/test_execute_module.py::test_main PASSED                                                                                                                                              [100%]

---------- coverage: platform linux, python 3.12.4-final-0 -----------
Name                    Stmts   Miss  Cover
-------------------------------------------
app/__init__.py             0      0   100%
app/execute_module.py      12      0   100%
-------------------------------------------
TOTAL                      12      0   100%

======================================================================================== 3 passed in 4.73s ========================================================================================
root@82374e8c81da:/workspace#

Copy
root@82374e8c81da:/workspace# pytest -v --cov=app --cov-report html
======================================================================================= test session starts =======================================================================================
platform linux -- Python 3.12.4, pytest-8.2.2, pluggy-1.5.0 -- /usr/local/bin/python
cachedir: .pytest_cache
rootdir: /workspace
plugins: cov-5.0.0
collected 3 items                                                                                                                                                                                 

tests/test_execute_module.py::test_callParam1 PASSED                                                                                                                                        [ 33%]
tests/test_execute_module.py::test_callParam2 PASSED                                                                                                                                        [ 66%]
tests/test_execute_module.py::test_main PASSED                                                                                                                                              [100%]

---------- coverage: platform linux, python 3.12.4-final-0 -----------
Coverage HTML written to dir htmlcov