ソフトウェア開発の分野では、テストはソフトウェアの品質と安定性を確保するための鍵となります。Pytest は、Python をベースにしたフル機能のテスト フレームワークです。これにより、テスト ケースを作成するためのよりシンプルで読みやすく、より柔軟な方法が提供され、テスト プロセスの管理、レポートの生成、フィクスチャやプラグイン、その他の機能のサポートが簡単に行えます。 。この記事では、Windows システムで Pytest をインストールして構成し、開発に PyCharm を使用する方法を紹介します。
1.pytestをインストールする
- Pythonをインストールする
まず、Python 環境をインストールする必要があります。Windows システムでは、Python 公式 Web サイト (https://www.python.org/downloads/windows/) から Python インストール パッケージの最新バージョンをダウンロードしてインストールできます。インストール中に、任意のディレクトリにある Python インタープリタにアクセスできるように、システム環境変数に Python を追加することをお勧めします。
2.Pytestをインストールする
Pytest をインストールするにはさまざまな方法がありますが、その 1 つは pip コマンドを使用してインストールすることです。コマンドラインに次のコマンドを入力します。
pip install pytest
3. インストールが完了したら、次のコマンドを使用して、Pytest が正常にインストールされたかどうかを確認できます。
pytest --version
2. 仮想環境の作成 Python の依存ライブラリのバージョンを統一し、システム環境との競合を避けるために、仮想環境の使用を推奨します。Windows では、venv モジュールを使用して仮想環境を作成できます。操作手順は以下のとおりです。
- コマンドラインツールを開き、仮想環境を作成するディレクトリを入力します。
- 次のコマンドを実行して、現在のディレクトリに「venv」という名前の仮想環境を作成します。
python -m venv venv
3. 仮想環境をアクティブ化します。コマンドラインツールに次のコマンドを入力します。
venv\Scripts\activate
仮想環境をアクティブ化すると、コマンド ラインのプロンプトに仮想環境の名前が表示されます。
4. pip コマンドを使用して、Pytest などの依存ライブラリをインストールします。例えば：
pip install pytest
5. 仮想環境が不要になったら、次のコマンドを使用して仮想環境を停止します。
deactivate
3. Pytest の構成 テスト ケースを作成する前に、テスト ケースが正しく実行されることを確認するために、テスト ファイルの指定、テストの実行モードの選択など、Pytest を構成する必要があります。Pytest を設定する方法は次のとおりです。
- 仮想環境で次のコマンドを実行して、pytest.ini ファイルを生成します。
pytest --genscript=pytest.ini
2. pytest.ini ファイルの内容を変更し、テストするディレクトリまたはファイルを指定し、ログ出力を設定し、プラグインを関連付けます。次に例を示します。
[pytest]
addopts = -s -q --alluredir allure-report
testpaths = tests
log_cli = true
log_cli_level = INFO
log_cli_format = %(asctime)s [%(levelname)s] %(message)s (%(filename)s:%(lineno)s)
log_file = logs/test.log
log_file_level = INFO
log_file_format = %(asctime)s [%(levelname)s] %(message)s (%(filename)s:%(lineno)s)
junit_family = xunit2
markers =
smoke: run the smoke test cases
regression: run the regression test cases
performance: run the performance test cases
- addopts: pytest コマンドラインパラメータを指定するために使用されます。上記のコマンドラインパラメータの意味は次のとおりです。
- -s: テスト関数で印刷およびログ情報を出力します。
- -q: 出力を簡略化し、有効な情報のみを表示します。
- --alluredir: allure レポートが生成されるディレクトリを指定します。
- testpaths: テスト ケースを実行するディレクトリまたはファイルを指定します。
- log_cli: コンソールにログを出力するかどうか。
- log_cli_level: コンソール出力のログ レベル。
- log_cli_format: コンソール出力のログ形式。
- log_file: ログをファイルに出力します。
- log_file_level: ファイルに出力されるログのレベル。
- log_file_format: ファイルに出力されるログの形式。
- junit_family: JUnit XML 出力形式を指定します。
- マーカー: マーカー テスト関数のコレクション。
4. PyCharm を使用してテスト環境を構成する PyCharm は、Python コードを作成および実行するための便利なツールを多数提供する強力な Python IDE です。PyCharm でテスト環境を構成する方法は次のとおりです。
- PyCharm を開き、メニュー バーで [ファイル] -> [新しいプロジェクト] をクリックし、新しいプロジェクトを作成します。
- 作成したプロジェクトを右クリックし、ポップアップ ウィンドウで [新規] -> [Python ファイル] を選択し、ファイルに「test_example.py」という名前を付け、このファイルにサンプル テスト ケースを記述します。
def test_addition():
assert 2 + 3 == 5
def test_subtraction():
assert 5 - 3 == 2
3. PyCharm に Pytest プラグインをインストールします。メニュー バーで [ファイル] -> [設定] をクリックし、ポップアップ ウィンドウで [プラグイン] を選択し、Pytest を検索して、[インストール] をクリックして Pytest プラグインをインストールします。
4. PyCharmのテスト環境を設定します。メニュー バーで [実行] -> [構成の編集] を開き、ポップアップ ウィンドウで [Python テスト] を選択し、右上隅の [追加] ボタン (+) をクリックして、[pytest] を選択します。
5. 「スクリプト パス」に実行するテスト ファイルのパスを入力します。例:
D:\project\tests\test_example.py
Python インタープリターを選択します。ここでは、仮想環境 (つまり venv\Scripts\python.exe) でインタープリターを使用することを選択します。
6. 「追加引数」に Pytest に渡す必要があるパラメータを入力します。例:
-s -v
7. 「OK」をクリックして構成を保存します。メニュー バーから [Run] -> [Run 'pytest in test_example.py'] を使用して、PyCharm で Pytest テスト ケースを実行できるようになりました。
V. まとめ
この記事では、Windows システムで Pytest をインストールして構成し、Python 依存ライブラリのバージョンの一貫性を確保するための仮想環境を作成する方法を紹介しました。また、Pytest を構成し、テストのために Pytest を PyCharm に統合する方法についても説明しました。この記事が、読者が Pytest の関連知識をよりよく理解し、習得するのに役立つことを願っています。