PhpStorm 2019.2ヘルプ

Codeceptionによるテスト

PhpStormはCodeceptionテストフレームワーク(英語)、バージョン2.2.0以降でユニット機能性、および受け入れテストを実行するためのサポートを提供します。

始める前に

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

Codeceptionのダウンロードとインストール

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

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

  • codeception.pharCodeceptionインストールページ(英語)からダウンロードし、Codeceptionが後で使用されるプロジェクトのルートに保存します。

    codeception.phar を別の場所に保存してインクルードパスとして設定することもできます。どちらの場合も、PhpStormは codeception.phar を索引付けに含めるため、Codeceptionクラスへの参照を正常に解決し、それによって完全なコーディング支援を提供します。

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

  1. composer.jsonのコンテキストメニューから、Composer | 依存性の管理を選択します。あるいは、メインメニューからツール | Composer | 依存性の管理を選択してください。

  2. 開いたComposerの依存関係を管理するダイアログで、使用可能なパッケージ リストからcodeception / codeceptionパッケージを選択します。おそらく検索フィールドを使用します。

    インストールするバージョンリストから該当するバージョンを選択します。

  3. 必要に応じて、設定隠し領域を展開し、拡張インストールオプションを指定します。コマンド・ライン・パラメーターフィールドに、追加のコマンドラインパラメータを入力します。

  4. インストールをクリックします。

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

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

Codeceptionをインストールしたら、codeception.yml 設定ファイルを生成してプロジェクトで初期化する必要があります。

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

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

  • プロジェクトに codeception.phar をインストールした場合は、Windowsの場合は php codecept.phar bootstrap、Linuxの場合はmacOSまたは codecept bootstrap と入力します。

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

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

ローカルのPHPインタープリターを使用している場合、PhpStormは自動的にCodeceptionの初期設定を行います。リモート PHPインタープリターの場合、手動Codeception設定が必要です。

Codeceptionを自動的に設定する

  1. codeception.yml または codeception.yml.dist 構成ファイルをプロジェクトルートに保存します。

  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. Codeceptionライブラリー領域で、ターゲット環境内のCodeception実行可能ファイルまたは codeception.phar アーカイブの場所を指定します。例:ComposerからCodeceptionをインストールした場合、実行可能ファイルは vendor/bin/codeceptに保存されます。Codeceptionディレクトリーまたはpharファイルへのパスフィールドの横にある the Reload button をクリックします。PhpStormはCodeceptionのバージョンを検出し、それをフィールドに表示します。

  3. テスト・ランナー領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。

    デフォルトでは、Codeceptionはプロジェクトのルートフォルダー内の codeception.yml 設定ファイルを探します。カスタム構成ファイルを指定できます。

    • デフォルト構成ファイルチェックボックスをオフにすると、Codeceptionはプロジェクトルートフォルダーの codeception.yml 設定ファイルを使用します。そのようなファイルが見つからない場合、テストの実行は失敗します。構成ファイルを明示的に指定する方が信頼性が高い場合があります。

    • デフォルト構成ファイルチェックボックスを選択して、独自の YML 設定ファイルを指定します。このファイルは、後ですべてのCodeception実行/デバッグ設定でデフォルトとして使用されます。

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

クラスのCodeceptionテストの生成

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

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

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

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

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

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

    the Create new codeception test dialog

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

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

    • テストするクラスの完全修飾名。この名前は、テスト・クラス名の提案に使用されます。デフォルトでは、名前ボックスには、テスト生成が呼び出されたクラスの名前が表示されます。完了を使用するには、Ctrl+Spaceを押します。

    • テストクラスの名前。PhpStormは、<production class>Test.phpCodeception ユニット・テストの場合)または <production class>Cest.phpCodeception 機能テストの場合)としてプロダクションクラス名から名前を自動的に作成します。テストクラス名は、テスト・クラス領域の名前フィールドに表示されます。

    • テストクラスのフォルダー。デフォルトでは、テストソースのルートとしてマークされているフォルダーです。そのようなフォルダーが指定されていない場合は、プロダクションクラスを含むフォルダーが代わりに提案されます。

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

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

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

  3. 定義済みの設定を確認、承認、または更新し、OKをクリックしてテスト生成を開始します。

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

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出力が表示されます。

最終更新日: 2019年9月3日

関連事項

関連ページ:

ローカルPHPインタープリターの設定

ローカルPHPインタープリターは、リモートホストまたはVagrantインスタンスに設定された仮想環境にインストールできるリモート PHPインタープリターとは反対に、コンピューターにインストールされたPHPエンジンです。リモート PHPインタープリターの設定を参照してください。設定/環境設定ダイアログ...

リモート PHPインタープリターの設定

リモート PHPインタープリターという用語は、リモートホストまたは仮想環境にインストールされたPHPエンジンを意味します。リモート PHPインタープリターという用語は、コンピューターにインストールされているローカルPHPインタープリターの反対語として使用されます。ローカルPHPインタープリターの設定...

Composer依存マネージャー

PhpStormはComposer依存マネージャーと統合されています。これにより、Packagistのパッケージをプロジェクトの依存関係として宣言し、IDEから管理することができます。PhpStormは、共通のComposerコマンド専用のユーザーインターフェースを提供します。Composerで新し...

テスト・フレームワーク

このページを使用して、PHP固有のテストフレームワークと現在のプロジェクトのPhpStormを統合します。PhpStormを使用すると、PHPUnit、Behat、Codeception、およびPHPSpecテストを実行およびデバッグできます。ページは2つのペインで構成されています。中央ペインには、...

実行/デバッグ構成: Codeception

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

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

コンテンツ・ルート内で、PhpStormは、ソースコードを含むフォルダーと、検索、解析、監視などで無視されるフォルダーを区別できます。さまざまな種類のフォルダーを区別するには、コンテンツ・ルートのフォルダーをソースフォルダーまたは除外フォルダーとしてマークします。コンテンツ・ルート内では、PhpSt...