PhpStorm 2020.2 ヘルプ

テストフレームワーク

このページを使用して、PHP 固有のテストフレームワークと現在のプロジェクトの PhpStorm を統合します。PhpStorm を使用すると、PHPUnit(英語)Behat(英語)Codeception(英語)、および PHPSpec(英語) テストを実行およびデバッグできます。

ページは 2 つのペインで構成されています。

  • 中央ペインには、異なるインタープリター用のテストフレームワークの既存の設定が表示されます。

  • 右側のペインの内容は、テストフレームワークと選択されたインタープリターのタイプによって異なります。

プロジェクトでテストフレームワークを設定する

  1. フレームワークの使用方法を選択します。Add iconをクリックし、リストから関連する構成タイプを選択します。

    ps_settings_php_test_frameworks.png

    任意のテストフレームワークを、ローカルまたはリモート PHP インタープリターで使用するように設定できます。

  2. リモートの設定では、設定済みの PHP インタープリターのいずれかを選択します:

    ps_settings_php_test_frameworks_choose_php_interpreter.png

  3. 右側のペインで、テストフレームワークをどこから取得するかを選択します。

    • Behat、PHPSpec、Codeception の場合は、フレームワークの実行可能ファイルへのパスを入力します。

    • PHPUnit の場合、使用しているフレームワークインストールのタイプを指定します。使用可能なオプションは、composer オートローダー autoload.phpphpunit.phar アーカイブ、または PEAR です。

  4. 選択したリモート PHP インタープリターとパスのマッピングを確認してください。

  5. 必要に応じて、構成ファイルを指定します。PHPUnit では、使用するブートストラップファイルを指定することもできます。

PHPUnit

このペインでは、PHP インタープリターで使用する PHPUnit のインストールを設定します。

PHPUnit ライブラリ

この領域に、PHPUnit のインストールのタイプを指定します。使用可能なオプションは次のとおりです。

Composer オートローダーを使用する Composer 依存関係マネージャーによってインストールされた PHPUnit を実行するには、このオプションを選択します。パッケージは、autoload.php ファイルによってベンダーフォルダーから取得およびロードされます。スクリプトのパスフィールドで autoload.php の場所を指定します。
phpunit.phar のパス

このオプションを選択して、phar アーカイブから PHPUnit を実行します。

  • プロジェクトにすでに phpunit.phar アーカイブがある場合は、phpunit.phar のパスフィールドでその場所を指定します。パスを手動で入力するか、the Browse buttonをクリックして、開いたダイアログでファイルを選択します。

  • コンピューターにまだ phar アーカイブがない場合は、phpunit.phar をダウンロード ... リンクをクリックして、PhpStorm に自動的にダウンロードさせます。

    どちらの場合でも、PhpStorm はテストの実行前にアーカイブをロードします。

CLI インタープリター

この領域はリモートインタープリターによる PHPUnit 構成の場合にのみ表示され、以下が表示されます。

  • リモートと PHPUnit を併用する PHP CLI インタープリターCLI インタープリターフィールドは読み取り専用です。the Browse buttonをクリックして、インタープリターダイアログで選択したインタープリターを更新します。

  • ローカルソースと Vagrant インスタンス内のソース、または Docker コンテナー間、またはリモートホスト間のパスマッピング

  • イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。

ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。または、フィールドの横にあるthe Browse buttonをクリックして手動で設定を指定します。詳細はリモート PHP インタープリターの構成を参照してください。

テストランナー

この領域で、シナリオの起動と実行に使用する構成 XML ファイルを指定します。
デフォルトでは、PHPUnit はプロジェクトのルートフォルダーまたは config フォルダーで phpunit.xml 構成ファイルを探します。カスタム構成ファイルを指定できます。

ブートストラップファイルへのパスを入力して、テストを起動する前に常に PHP スクリプトを実行することもできます。フィールドで、スクリプトの場所を指定します。パスを手動で入力するか、the Browse buttonをクリックして、表示されるダイアログで目的のフォルダーを選択します。

デフォルト構成ファイル

独自の XML 設定ファイルを指定するには、このチェックボックスを選択してください。このファイルは、後ですべての PHPUnit 実行 / デバッグ構成でデフォルトとして使用されます。PHPUnit の実行 / デバッグ構成を編集するときに代替構成ファイルを提供することもできます。

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

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

デフォルトブートストラップファイル

テストを開始する前に PHP スクリプトを常に実行するには、このチェックボックスを選択します。フィールドに、スクリプトの場所を指定します。パスを手動で入力するか、またはthe Browse buttonをクリックして表示されるダイアログで目的のフォルダーを選択します。PHPUnit の実行 / デバッグ構成を編集するときに、代替のブートストラップファイルを提供することもできます。

Behat

このペインでは、構成済みのローカルおよびリモート PHP インタープリターを介して利用可能な Behat(英語) フレームワークのインストールを設定します。

CLI インタープリター

この領域はリモートインタープリターによる Behat 構成の場合にのみ表示され、以下が表示されます。

  • リモートと Behat を併用する PHP CLI インタープリターCLI インタープリターフィールドは読み取り専用です。the Browse buttonをクリックして、インタープリターダイアログで選択したインタープリターを更新します。

  • ローカルソースと Vagrant インスタンス内のソース、または Docker コンテナー間、またはリモートホスト間のパスマッピング

  • イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。

ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。または、フィールドの横にあるthe Browse buttonをクリックして手動で設定を指定します。詳細はリモート PHP インタープリターの構成を参照してください。

Behat ライブラリ

この領域に、使用する Behat インストールを指定します。

Behat 実行可能ファイルへのパス このフィールドでは、behat.phar アーカイブの場所、または Behat 実行可能ファイルのあるフォルダーを指定します。Behat は、必ずしも現在のプロジェクトルートにインストールする必要はありません。パスを手動で入力するか、the Browse buttonをクリックして、開いたダイアログで関連する場所を選択できます。
Behat リリース このリンクをクリックすると、behat.phar アーカイブの関連バージョンを選択できる github 上の Behat リポジトリに移動します。
Behat バージョン この読み取り専用フィールドには、指定した Behat インストールのバージョンが表示されます。PhpStorm は、リフレッシュアイコンicons.actions.refresh.svgをクリックするとバージョンを検出します。デフォルト値は未インストールです。

テストランナー

この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。
デフォルトでは、Behat はプロジェクトのルートフォルダーまたは config フォルダーで behat.yml 構成ファイルを探します。カスタム構成ファイルを指定できます。

デフォルト構成ファイル

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

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

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

Codeception

このペインでは、構成済みのローカルおよびリモート PHP インタープリターを介して利用可能な Codeception(英語) フレームワークのインストールを設定します。

CLI インタープリター

この領域はリモートインタープリターによる Codeception 構成の場合にのみ表示され、以下が表示されます。

  • リモートと Codeception を併用する PHP CLI インタープリターCLI インタープリターフィールドは読み取り専用です。the Browse buttonをクリックして、インタープリターダイアログで選択したインタープリターを更新します。

  • ローカルソースと Vagrant インスタンス内のソース、または Docker コンテナー間、またはリモートホスト間のパスマッピング

  • イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。

ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。または、フィールドの横にあるthe Browse buttonをクリックして手動で設定を指定します。詳細はリモート PHP インタープリターの構成を参照してください。

Codeception ライブラリ

この領域に、使用する Codeception インストールを指定します。

Codeception 実行可能ファイルへのパス このフィールドで、codeception.phar アーカイブの場所、または Codeception 実行可能ファイルのあるフォルダーを指定します。
Codeception リリース このリンクをクリックすると、codeception.phar アーカイブの関連バージョンを選択できる github 上の Codeception リポジトリに移動します。
Codeception バージョン この読み取り専用フィールドは、指定された Codeception インストールのバージョンを表示します。the Refresh buttonをクリックすると、PhpStorm がバージョンを検出します。デフォルト値は未インストールです。

テストランナー

この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。

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

デフォルト構成ファイル

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

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

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

PHPSpec

このペインでは、構成済みのローカルおよびリモート PHP インタープリターを介して利用可能な PHPSpec(英語) ツールセットのインストールを設定します。

CLI インタープリター

この領域はリモートインタープリターによる PHPSpec 構成の場合にのみ表示され、以下が表示されます。

  • PHZ スペックを使用するリモート PHP CLI インタープリターCLI インタープリターフィールドは読み取り専用です。the Browse buttonをクリックして、インタープリターダイアログで選択したインタープリターを更新します。

  • ローカルソースと Vagrant インスタンス内のソース、または Docker コンテナー間、またはリモートホスト間のパスマッピング

  • イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。

ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。または、フィールドの横にあるthe Browse buttonをクリックして手動で設定を指定します。詳細はリモート PHP インタープリターの構成を参照してください。

PHPSpec ライブラリ

この領域に、使用する PHPSpec のインストールを指定します。

PHPSpec 実行ファイルへのパス

このフィールドで、phpspec の場所を指定します。PHPSpec は、必ずしも現在のプロジェクトルートにインストールする必要はありません。

PHPSpec へのパスがローカルインタープリターに指定されていない場合、PhpStorm は PHPSpec を完全にサポートしません。たとえば、コード補完の提案は表示されず、参照も解決されません。

接頭辞 ('spec_prefix' )

この読み取り専用フィールドには、仕様のネームスペースプレフィックスが表示されます。PhpStorm は、デフォルト構成ファイルフィールドで指定された構成ファイルから spec_prefix を検出します。デフォルト値は spec です。詳細は PHPSpec の設定 : PSR-4(英語)PHPSpec の設定 : 仕様とソースの場所(英語)を参照してください。

テストランナー

この領域では、仕様の起動と実行に使用する構成 YML ファイルを指定します。

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

デフォルト構成ファイル

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

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

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

最終更新日 :