PhpStorm 2020.1ヘルプ

Codeception

PhpStorm provides support for running unit, functional, and acceptance tests with the Codeceptionテストフレームワーク(英語) , versions 2.2.0 and later.

始める前に

ローカルPHPインタープリターを構成するおよびリモート PHP インタープリターの構成の説明に従って、PHPインタープリターがPHPページのPhpStormに設定されていることを確認してください。

Codeceptionをダウンロードしてインストールする

開始する前に、Composerがマシンにインストールされ、Composer依存関係マネージャーに従って現在のプロジェクトで初期化されていることを確認してください。

Codeceptionを手動でダウンロードしてインストールする

  • Download codeception.phar at the Codeceptionインストールページ(英語) and save it under the root of the project where Codeception will be later used.

    You can also save codeception.phar in a different location and configure it as an include path. In either case, PhpStorm will include codeception.phar in indexing, so it will successfully resolve references to the Codeception classes and thus provide you with full coding assistance.

Composerを使用してCodeceptionをダウンロードしてインストールする

  1. composer.json内で、codeception / codeception依存関係レコードを require または require-dev セクションに追加します。 Ctrl+Space を押して、パッケージ名とバージョンの両方のコード補完を取得します。

  2. 以下のいずれか 1 つを実行します:

    • エディターパネルの上部にある インストールショートカットリンクをクリックします。

    • インストールされていないComposerパッケージ インスペクションが有効になっている場合、PhpStormは、現在インストールされていない宣言済みの依存関係を強調表示します。 Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。

Codeception公式サイト(英語)からCodeceptionをインストールする方法の詳細を参照してください。

PhpStormプロジェクトでCodeceptionを初期化する

Having installed Codeception, you need to initialize it in your project by generating a codeception.yml configuration file.

codeception.yml設定ファイルを生成する

  • ビルトインPhpStorm ターミナル Alt+F12 を開き、コマンドプロンプトで、インストールモードと現在のオペレーティングシステムに応じて、次のコマンドのいずれかを入力します。

    • If you installed codeception.phar in your project, type php codecept.phar bootstrap for Windows and macOS or codecept bootstrap for Linux.

    • Composerを介してCodeceptionをグローバルにインストールした場合は、すべてのプラットフォームで codecept bootstrap と入力します。

プロジェクトでCodeceptionをPhpStormと統合する

If you use a local PHP interpreter, PhpStorm performs initial Codeception configuration automatically. In the case of remote PHP interpreters, manual Codeception configuration is required.

Codeceptionを自動的に設定する

  1. Store the codeception.yml or codeception.yml.dist configuration file under the project root.

  2. ComposerとCodeceptionをインストール

PhpStormはテストフレームワークページおよびCodeception実行/デバッグ構成上にローカルフレームワーク構成を作成します。

Codeceptionを手動で設定する

  1. 設定/環境設定ダイアログ Ctrl+Alt+S で、言語とフレームワークノードを展開し、PHPテスト・フレームワーク を選択します。

    開いているテストフレームワークページの中央ペインで Add icon をクリックし、リストから設定タイプを選択します。

    ps_settings_php_test_frameworks.png
    • ローカル設定では、デフォルトのプロジェクトPHPインタープリターが使用されます。詳細はデフォルトのプロジェクトCLIインタープリターを参照してください。

    • リモート PHPインタープリターでCodeceptionを使用するには、表示されるダイアログで以下のいずれかの設定を選択します。

      ps_settings_php_test_frameworks_codeception_choose_php_interpreter.png
  2. In the Codeceptionライブラリ area, specify the location of the Codeception executable file or codeception.phar archive in the target environment. For example, if you installed Codeception through Composer, the executable file is stored in vendor/bin/codecept . Click the Reload button next to the Codeceptionディレクトリまたはpharファイルへのパス field. PhpStorm detects the version of Codeception and displays it below the field.

  3. In the テスト・ランナー area, appoint the configuration YML file to use for launching and executing scenarios.

    By default, Codeception looks for a codeception.yml configuration file in the project root folder. You can appoint a custom configuration file.

    • Clear the デフォルト構成ファイル checkbox to have Codeception use the codeception.yml configuration file from the project root folder. If no such file is found, test execution fails, therefore it may be more reliable to specify the configuration file explicitly.

    • Select the デフォルト構成ファイル checkbox to specify your own YML configuration file. This file will be later used as default in all Codeception run/debug configurations.

      このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、the Browse button をクリックして表示されるダイアログでファイルを選択します。

クラスのCodeceptionテストを生成する

  1. 次のいずれかを実行して新しいPHPテストを作成するダイアログを開きます。

    • メインメニューからファイル | 新規を選択します。次に、コンテキストメニューからPHP テスト | Codeception ユニット・テストまたはPHP テスト | Codeception 機能テストを選択します。

    • プロジェクトツールウィンドウで、Alt+Insert を押すか、テストするPHPクラスを右クリックし、新規 | PHP テスト | Codeception ユニット・テストまたは新規 | PHP テスト | Codeception 機能テストを選択します。

    • テストするPHPクラスのエディターで、クラスの定義にキャレットを配置します。次に、Alt+Enter を押して、ポップアップメニューから新規テストの作成を選択します。このようにして、単一のPHPファイル内の複数のクラス間で定義されたPHPクラスのテストを生成できます。

      特定のメソッドのテストを作成するには、メソッド宣言内にキャレットを配置します。選択したメソッドは、新しいPHPテストを作成するダイアログのメソッドリストで自動的に選択されます。

  2. 新しいPHPテストを作成するダイアログが開きます。

    the Create new codeception test dialog

    生成されたテストのパラメータを提供する:

    • テストファイルテンプレート、つまりPhpStormがテストクラスを生成するためのテンプレート。テストファイルテンプレートリストでCodeceptionユニットまたはCodeception機能性が選択されていることを確認してください。

    • The name of the test class. PhpStorm automatically composes the name from the production class name as <production class>Test.php (for Codeception ユニット・テスト ) or <production class>Cest.php (for Codeception 機能テスト ) .

    • The folder for the test class file, which is automatically suggested based on the containing directory and namespace of the production class, the configured test sources root and its psr-4パッケージプレフィックス , or the tests value specified in the codeception.yml(英語) configuration file.

      別のフォルダーを指定するには、ディレクトリフィールドの横にある the Browse button をクリックし、該当するフォルダーを選択します。

    • The namespace the test class will belong to, which is automatically suggested based on the containing directory and namespace of the production class, the configured test sources root and its psr-4パッケージプレフィックス , or the namespace value specified in the codeception.yml(英語) configuration file.

    • テストメソッドスタブを生成する本番クラスメソッド。必要な本番クラスメソッドの横にあるチェックボックスを選択します。親クラスから継承されたメソッドを含めるには、継承されたメソッドを表示するチェックボックスを選択します。

      PhpStormはテストメソッドの名前を test<production method>として自動的に作成します。テストメソッドスタブの生成に使用されるコードテンプレートは、ファイルおよびコード・テンプレート設定ページのコードタブでカスタマイズできます。

テストが作成されたら、ナビゲート | テスト対象にジャンプを選択して本番クラスに戻ることができます。詳細については、テストとテスト対象間を移動するを参照してください。

Codeceptionテストの実行とデバッグ

Codeceptionテストの記述については、ユニット・テスト(英語)受け入れテスト(英語)、および機能テスト(英語)を参照してください。

Codeceptionテストの実行またはデバッグ

  • プロジェクトツールウィンドウで、テストを実行するファイルまたはフォルダーを選択し、選択したコンテキストメニューから実行 '<file or folder>'またはデバッグ '<file or folder>'を選択します。

    ps_test_frameworks_codeception_launch_tests.png

    PhpStormはデフォルトの実行構成を生成し、実行/デバッグテストセッションを開始します。

自動的に生成されたデフォルト設定を保存する

  • テストセッションが終了したら、ファイルまたはフォルダーのコンテキストメニューから保存<default_test_configuration_name>を選択します。

以前に保存された実行/デバッグ構成によってテストを実行またはデバッグする

  • ツールバーのリストから必要なCodeception構成を選択し、the Run button または the Debug buttonをクリックします。

カスタム実行/デバッグ構成を作成する

  1. プロジェクトツールウィンドウで、実行するテストが含まれているファイルまたはフォルダーを選択し、コンテキストメニューから実行構成の作成 を選択します。または、メインメニューから実行 | 構成の編集を選択してから Add icon をクリックし、リストからCodeceptionを選択します。

  2. 開く実行/デバッグ構成: Codeceptionダイアログで、実行するシナリオを指定し、使用するPHP インタープリターを選択し、PHP実行可能ファイルに渡すオプションと引数を指定してその動作をカスタマイズします。

テスト結果を監視する

PhpStormは実行ツール・ウィンドウテストランナータブにおけるテスト実行結果を示します。

ps_test_result_codeception.png

このタブは大きく2つのエリアに分かれています。

  • 左側の領域では、すべての単体テストをドリルダウンして、成功したテストと失敗したテストを確認できます。テストのフィルタリング、結果のエクスポート、およびコンテキストメニューコマンドを使用して特定のテストを実行したりソースコードに移動したりできます。

  • 右側の領域には、生のCodeception出力が表示されます。

最終更新日: 2020年6月16日

関連ページ:

ローカルPHPインタープリターを構成する

Alocal PHP interpreteris a PHP engine installed on your computer opposite to aremote PHP interpreterthat can be installed on a remote host or in a vir...

リモート PHP インタープリターの構成

The termremote PHP interpreterdenotes a PHP engine installed on a remote host or in a virtual environment. The termremote PHP interpreteris used as th...

Composer依存関係マネージャー

PhpStormはComposer依存マネージャーと統合されています。これにより、Packagistのパッケージをプロジェクトの依存関係として宣言し、IDEから管理することができます。PhpStormは、composer.jsonを操作するための包括的なコーディング支援と、一般的なComposerコ...

テスト・フレームワーク

ファイル | 設定 | 言語とフレームワーク | PHP | テスト・フレームワークfor Windows and LinuxPhpStorm | 環境設定 | 言語とフレームワーク | PHP | テスト・フレームワークfor macOSこのページを使用して、PHP固有のテストフレームワークと現在...

実行/デバッグ構成: Codeception

このダイアログは、PHPとCodeceptionプラグインが有効になっている場合にのみ利用可能です。プラグインはデフォルトで有効になっています。プラグインが無効になっている場合は、プラグインを管理する説明に従ってプラグインページで有効にします。このダイアログを使用して、Codeceptionフレーム...

コンテンツ・ルート内のフォルダーの構成

Within acontent root, PhpStorm can distinguish between the folders that contain source code, and the ones to be ignored while searching, parsing, watc...