【Docker × VScode × pytest 】pytestの環境別実行方法

Copy
from unittest.mock import Mock
import pytest
from main import create_app

def test_1():
    mock = Mock()

def test_2():
    mock = Mock()

def test_3():
    mock = Mock()

def test_4():
    mock = Mock()

def test_5():
    mock = Mock()

def test_6():
    mock = Mock()

Copy
rootdir: C:\develop\01_TechSamples\Python\FastApi\fastApi_pytest
plugins: anyio-4.6.2.post1, cov-5.0.0
collected 6 items

tests/test_main.py::test_1 PASSED [ 16%]
tests/test_main.py::test_2 PASSED [ 33%]
tests/test_main.py::test_3 PASSED [ 50%]
tests/test_main.py::test_4 PASSED [ 66%]
tests/test_main.py::test_5 PASSED [ 83%]
tests/test_main.py::test_6 PASSED [100%]

======================== 6 passed in 0.96s ========================

Copy
.
|-- .vscode
|   |-- .env
|   |-- launch.json
|   `-- settings.json
|-- app
|   |-- __init__.py
|   |-- asgi.py
|   |-- endpoints.py
|   `-- main.py
|-- requirements.txt
`-- tests
    |-- test_asgi.py
    |-- test_endpoints.py
    `-- test_main.py

Copy
fastapi
uvicorn[standard]
pytest
pytest-asyncio

Copy
from main import create_app

app = create_app()

Copy
from fastapi import APIRouter
from fastapi.responses import JSONResponse

router = APIRouter()

# ディクショナリリスト
users = [
    {"user_id": "1", "name": "Tujimura", "age": 11},
    {"user_id": "2", "name": "mori", "age": 20},
    {"user_id": "3", "name": "shimada", "age": 50},
    {"user_id": "4", "name": "kyogoku", "age": 70}
]

# ディクショナリの一覧を取得
@router.get("/")
async def get_users():
    return JSONResponse(status_code=200, content=users)

Copy
from fastapi import FastAPI
import endpoints as endpoints

def create_app():
    # アプリケーションインスタンスの作成
    app = FastAPI()
    # ルーティング設定
    app.include_router(endpoints.router)

    return app

Copy
from unittest.mock import Mock
import importlib
import asgi

def test_asgi(monkeypatch):
    # create_app()が実行された場合にmock_appが返るように置き換え
    mock_app = Mock()
    monkeypatch.setattr("main.create_app", mock_app)

    # asgiモジュールを再インポートして評価させる
    importlib.reload(asgi)

    # create_app関数(mock)が呼び出されたか確認
    mock_app.assert_called_once()

Copy
from unittest.mock import Mock
from main import create_app
import endpoints

def test_create_app(monkeypatch):
    # Mockの FastAPIインスタンスを作成
    mock_app_instance = Mock()

    # include_routerメソッドを設定
    mock_app_instance.include_router.return_value = True

    # FastAPI()が実行された場合にmock_app_instanceが返るように置き換え
    mock_app = Mock(return_value=mock_app_instance)
    monkeypatch.setattr("main.FastAPI", mock_app)

    # create_app 関数を実行
    create_app()

    # include_router が endpoints.router を引数に呼び出されたか確認
    mock_app_instance.include_router.assert_called_with(endpoints.router)

Copy
from unittest.mock import Mock
from main import create_app
import endpoints

def test_create_app(monkeypatch):
    # Mockの FastAPIインスタンスを作成
    mock_app_instance = Mock()

    # include_routerメソッドを設定
    mock_app_instance.include_router.return_value = True

    # FastAPI()が実行された場合にmock_app_instanceが返るように置き換え
    mock_app = Mock(return_value=mock_app_instance)
    monkeypatch.setattr("main.FastAPI", mock_app)

    # create_app 関数を実行
    create_app()

    # include_router が endpoints.router を引数に呼び出されたか確認
    mock_app_instance.include_router.assert_called_with(endpoints.router)

Copy
PYTHONPATH=./app

Copy
from fastapi import FastAPI
import endpoints as endpoints

def create_app():
    # アプリケーションインスタンスの作成
    app = FastAPI()
    # ルーティング設定
    app.include_router(endpoints.router)

    return app

Copy
from unittest.mock import Mock
from main import create_app
import endpoints

def test_create_app(monkeypatch):
    # Mockの FastAPIインスタンスを作成
    mock_app_instance = Mock()

    # include_routerメソッドを設定
    mock_app_instance.include_router.return_value = True
    print("dddd")

    # FastAPI()が実行された場合にmock_app_instanceが返るように置き換え
    mock_app = Mock(return_value=mock_app_instance)
    monkeypatch.setattr("main.FastAPI", mock_app)

    # create_app 関数を実行
    create_app()

    # include_router が endpoints.router を引数に呼び出されたか確認
    mock_app_instance.include_router.assert_called_with(endpoints.router)

Copy
{
    // PYTHONPATHの設定
    "python.envFile": "${workspaceFolder}/.vscode/.env",
    // pytestを実行する際の引数を設定
    "python.testing.pytestArgs": [
        "${workspaceFolder}", //--rootdir テスト実行のルートディレクトリを指定
        "--cov=${workspaceFolder}", //カバレッジ計測を指定
        "-v", // 詳細モード有効化
        "-s", // printやlogをターミナル表示
    ],
    "python.testing.unittestEnabled": false,
    "python.testing.pytestEnabled": 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
{
    // PYTHONPATHの設定
    "python.envFile": "${workspaceFolder}/.vscode/.env",
    // pytestを実行する際の引数を設定
    "python.testing.pytestArgs": [
        "."
    ],
    "python.testing.unittestEnabled": false,
    "python.testing.pytestEnabled": true
}

Copy
$ pytest -v
C:\Users\lunaj\AppData\Local\Programs\Python\Python311\Lib\site-packages\pytest_asyncio\plugin.py:208: PytestDeprecationWarning: The configuration option "asyncio_default_fixture_loop_scope" is unset.
The event loop scope for asynchronous fixtures will default to the fixture caching scope. Future versions of pytest-asyncio will default the loop scope for asynchronous fixtures to function scope. Set the default fixture loop scope explicitly in order to avoid unexpected behavior in the future. Valid fixture loop scopes are: "function", "class", "module", "package", "session"

  warnings.warn(PytestDeprecationWarning(_DEFAULT_FIXTURE_LOOP_SCOPE_UNSET))
========================================================================= test session starts =========================================================================
platform win32 -- Python 3.11.1, pytest-8.2.2, pluggy-1.5.0 -- C:\Users\lunaj\AppData\Local\Programs\Python\Python311\python.exe
cachedir: .pytest_cache
rootdir: C:\develop\01_TechSamples\Python\FastApi\fastApi_pytest
plugins: anyio-4.6.2.post1, asyncio-0.24.0, cov-5.0.0
asyncio: mode=Mode.STRICT, default_loop_scope=None
collected 0 items / 3 errors

=============================================================================== ERRORS ================================================================================ 
_________________________________________________________________ ERROR collecting tests/test_asgi.py _________________________________________________________________ 
ImportError while importing test module 'C:\develop\01_TechSamples\Python\FastApi\fastApi_pytest\tests\test_asgi.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
C:\Users\lunaj\AppData\Local\Programs\Python\Python311\Lib\importlib\__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests\test_asgi.py:3: in <module>
    import asgi
E   ModuleNotFoundError: No module named 'asgi'
______________________________________________________________ ERROR collecting tests/test_endpoints.py _______________________________________________________________ 
ImportError while importing test module 'C:\develop\01_TechSamples\Python\FastApi\fastApi_pytest\tests\test_endpoints.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
C:\Users\lunaj\AppData\Local\Programs\Python\Python311\Lib\importlib\__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests\test_endpoints.py:3: in <module>
    from endpoints import get_users
E   ModuleNotFoundError: No module named 'endpoints'
_________________________________________________________________ ERROR collecting tests/test_main.py _________________________________________________________________ 
ImportError while importing test module 'C:\develop\01_TechSamples\Python\FastApi\fastApi_pytest\tests\test_main.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
C:\Users\lunaj\AppData\Local\Programs\Python\Python311\Lib\importlib\__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests\test_main.py:2: in <module>
    from main import create_app
E   ModuleNotFoundError: No module named 'main'
======================================================================= short test summary info ======================================================================= 
ERROR tests/test_asgi.py
ERROR tests/test_endpoints.py
ERROR tests/test_main.py
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 3 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 
========================================================================== 3 errors in 0.58s ==========================================================================

Copy
# 環境変数でPYTHONPATHを設定
$ export PYTHONPATH=$(pwd)/app

# 環境変数の確認
$ echo $PYTHONPATH
/c/develop/01_TechSamples/Python/FastApi/fastApi_pytest/app

# pytest実行
$ pytest -v
C:\Users\lunaj\AppData\Local\Programs\Python\Python311\Lib\site-packages\pytest_asyncio\plugin.py:208: PytestDeprecationWarning: The configuration option "asyncio_default_fixture_loop_scope" is unset.
The event loop scope for asynchronous fixtures will default to the fixture caching scope. Future versions of pytest-asyncio will default the loop scope for asynchronous fixtures to function scope. Set the default fixture loop scope explicitly in order to avoid unexpected behavior in the future. Valid fixture loop scopes are: "function", "class", "module", "package", "session"

  warnings.warn(PytestDeprecationWarning(_DEFAULT_FIXTURE_LOOP_SCOPE_UNSET))
============================== test session starts ==================================
platform win32 -- Python 3.11.1, pytest-8.2.2, pluggy-1.5.0 -- C:\Users\lunaj\AppData\Local\Programs\Python\Python311\python.exe
cachedir: .pytest_cache
rootdir: C:\develop\01_TechSamples\Python\FastApi\fastApi_pytest
plugins: anyio-4.6.2.post1, asyncio-0.24.0, cov-5.0.0
asyncio: mode=Mode.STRICT, default_loop_scope=None
collected 3 items

tests/test_asgi.py::test_asgi PASSED                                           [ 33%]
tests/test_endpoints.py::test_get_users_directly PASSED                        [ 66%]
tests/test_main.py::test_create_app PASSED                                     [100%]

=============================== 3 passed in 1.68s ===================================

Copy
|-- .vscode
# |   |-- .env
|   |-- launch.json
|   `-- settings.json
|-- app
|   |-- __init__.py
|   |-- asgi.py
|   |-- endpoints.py
|   `-- main.py
|-- docker-compose.yml
|-- dockerfile
|-- requirements.txt
`-- tests
    |-- test_asgi.py
    |-- test_endpoints.py
    `-- test_main.py

Copy
FROM python:3.12

# PYTHONPATHの設定
ENV PYTHONPATH=/workspace/app

# workspaceディレクトリ作成、移動
WORKDIR /workspace

# プロジェクトディレクトリにコピー
COPY requirements.txt /workspace

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

# uvicorn実行
CMD ["uvicorn", "asgi:app", "--reload", "--host", "0.0.0.0", "--port", "8000"]

Copy
version: "3"
services:
  fastapi:
    container_name: "fastapi"
    build:
      context: .
      dockerfile: Dockerfile
    volumes:
      - .:/workspace
    tty: true
    ports:
      - 8000:8000 # ホストマシンのポート8000を、docker内のポート8000に接続する

Copy
{
    // // PYTHONPATHの設定
    // "python.envFile": "${workspaceFolder}/.vscode/.env",
    // pytestを実行する際の引数を設定
    "python.testing.pytestArgs": [
        "${workspaceFolder}", //--rootdir テスト実行のルートディレクトリを指定
        "--cov=${workspaceFolder}", //カバレッジ計測を指定
        "-v", // 詳細モード有効化
        "-s", // printやlogをターミナル表示
    ],
    "python.testing.unittestEnabled": false,
    "python.testing.pytestEnabled": true
}

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

# 確認
$ docker ps
CONTAINER ID   IMAGE                    COMMAND                   CREATED         STATUS         PORTS                    NAMES
4a4b4b7d08a7   fastapi_pytest-fastapi   "uvicorn asgi:app --…"   3 minutes ago   Up 3 minutes   0.0.0.0:8000->8000/tcp   fastapi

Copy
root@4a4b4b7d08a7:/workspace# pytest -v
/usr/local/lib/python3.12/site-packages/pytest_asyncio/plugin.py:208: PytestDeprecationWarning: The configuration option "asyncio_default_fixture_loop_scope" is unset.
The event loop scope for asynchronous fixtures will default to the fixture caching scope. Future versions of pytest-asyncio will default the loop scope for asynchronous fixtures to function scope. Set the default fixture loop scope explicitly in order to avoid unexpected behavior in the future. Valid fixture loop scopes are: "function", "class", "module", "package", "session"

  warnings.warn(PytestDeprecationWarning(_DEFAULT_FIXTURE_LOOP_SCOPE_UNSET))
============================= test session starts =======================================
platform linux -- Python 3.12.8, pytest-8.3.4, pluggy-1.5.0 -- /usr/local/bin/python3.12
cachedir: .pytest_cache
rootdir: /workspace
plugins: anyio-4.7.0, asyncio-0.24.0
asyncio: mode=Mode.STRICT, default_loop_scope=None
collected 3 items                                                                                                                                                               

tests/test_asgi.py::test_asgi PASSED                                          [ 33%]
tests/test_endpoints.py::test_get_users_directly PASSED                       [ 66%]
tests/test_main.py::test_create_app PASSED                                    [100%]

============================== 3 passed in 2.36s =========================================
root@4a4b4b7d08a7:/workspace#