テストフレームワーク
このページを使用して、現在のプロジェクトで PHP テストフレームワークを PhpStorm と統合します。PhpStorm を使用すると、PHPUnit(英語)、Behat(英語)、PHPSpec(英語)、Codeception(英語)、Pest(英語) テストを実行およびデバッグできます。
プロジェクトでテストフレームワークを設定する
をクリックし、テストフレームワークとそれを実行する PHP インタープリターを選択します。
リモートの設定では、設定済みの PHP インタープリターのいずれかを選択します:
右側のペインで、テストフレームワークをどこから取得するかを選択します。
Behat、PHPSpec、Codeception の場合は、フレームワークの実行可能ファイルへのパスを入力します。
PHPUnit の場合、使用しているフレームワークインストールのタイプを指定します。使用可能なオプションは、composer オートローダー autoload.php または phpunit.phar アーカイブです。
選択したリモート PHP インタープリターとパスのマッピングを確認してください。
必要に応じて、構成ファイルを指定します。PHPUnit では、使用するブートストラップファイルを指定することもできます。
PHPUnit
このペインでは、PHP インタープリターで使用する PHPUnit のインストールを設定します。
PHPUnit ライブラリ
この領域に、PHPUnit のインストールのタイプを指定します。使用可能なオプションは次のとおりです。
Composer オートローダーを使用する | Composer 依存関係マネージャーがインストールした PHPUnit を実行するには、このオプションを選択します。パッケージは、vendor フォルダーから autoload.php ファイルによって読み込まれ、ロードされます。スクリプトのパスフィールドに autoload.php の位置を指定します。 |
phpunit.phar のパス | phar アーカイブから PHPUnit を実行するには、このオプションを選択します。
|
テストランナー
この領域で、シナリオの起動と実行に使用する構成 XML ファイルを指定します。
デフォルトでは、PHPUnit はプロジェクトルートフォルダーで phpunit.xml または phpunit.xml.dist 構成ファイルを検索します。カスタム構成ファイルを指定できます。
ブートストラップファイルへのパスを入力して、テストを起動する前に常に PHP スクリプトを実行することもできます。フィールドで、スクリプトの場所を指定します。パスを手動で入力するか、 をクリックして、表示されるダイアログで目的のフォルダーを選択します。
デフォルト構成ファイル | 独自の XML 設定ファイルを指定するには、このチェックボックスを選択してください。このファイルは、後ですべての PHPUnit 実行 / デバッグ構成でデフォルトとして使用されます。PHPUnit の実行 / デバッグ構成を編集するときに代替構成ファイルを提供することもできます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 チェックボックスをオフにすると、PHPUnit でプロジェクトルートフォルダーの phpunit.xml または phpunit.xml.dist 構成ファイルを使用できるようになります。そのようなファイルが見つからない場合、テストの実行は失敗するため、構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
デフォルトブートストラップファイル | テストを開始する前に PHP スクリプトを常に実行するには、このチェックボックスを選択します。フィールドに、スクリプトの場所を指定します。パスを手動で入力するか、 をクリックして表示されるダイアログで目的のフォルダーを選択します。PHPUnit の実行 / デバッグ構成を編集するときに、代替のブートストラップファイルを提供することもできます。 |
CLI インタープリター | PHPUnit を使用するためのリモート PHP CLI インタープリター。CLI インタープリターフィールドは読み取り専用です。インタープリターダイアログで選択したインタープリターを更新するには、 をクリックします。 |
パスマッピング | ローカルソースと、Vagrant インスタンス内、Docker コンテナー内、またはリモートホスト上のソース間のパスマッピング。 ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。あるいは、フィールドの横にある をクリックして、設定を手動で指定します。詳細については、リモート PHP インタープリターの構成を参照してください。 |
Docker コンテナー | イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。 |
PHPUnit ライブラリ
この領域に、PHPUnit のインストールのタイプを指定します。使用可能なオプションは次のとおりです。
Composer オートローダーを使用する | Composer 依存関係マネージャーがインストールした PHPUnit を実行するには、このオプションを選択します。パッケージは、vendor フォルダーから autoload.php ファイルによって読み込まれ、ロードされます。スクリプトのパスフィールドに autoload.php の位置を指定します。 |
phpunit.phar のパス | phar アーカイブから PHPUnit を実行するには、このオプションを選択します。
|
テストランナー
この領域で、シナリオの起動と実行に使用する構成 XML ファイルを指定します。
デフォルトでは、PHPUnit はプロジェクトルートフォルダーで phpunit.xml または phpunit.xml.dist 構成ファイルを検索します。カスタム構成ファイルを指定できます。
ブートストラップファイルへのパスを入力して、テストを起動する前に常に PHP スクリプトを実行することもできます。フィールドで、スクリプトの場所を指定します。パスを手動で入力するか、 をクリックして、表示されるダイアログで目的のフォルダーを選択します。
デフォルト構成ファイル | 独自の XML 設定ファイルを指定するには、このチェックボックスを選択してください。このファイルは、後ですべての PHPUnit 実行 / デバッグ構成でデフォルトとして使用されます。PHPUnit の実行 / デバッグ構成を編集するときに代替構成ファイルを提供することもできます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 チェックボックスをオフにすると、PHPUnit でプロジェクトルートフォルダーの phpunit.xml または phpunit.xml.dist 構成ファイルを使用できるようになります。そのようなファイルが見つからない場合、テストの実行は失敗するため、構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
デフォルトブートストラップファイル | テストを開始する前に PHP スクリプトを常に実行するには、このチェックボックスを選択します。フィールドに、スクリプトの場所を指定します。パスを手動で入力するか、 をクリックして表示されるダイアログで目的のフォルダーを選択します。PHPUnit の実行 / デバッグ構成を編集するときに、代替のブートストラップファイルを提供することもできます。 |
Behat
このペインでは、構成済みのローカルおよびリモート PHP インタープリターを介して利用可能な Behat(英語) フレームワークのインストールを設定します。
Behat ライブラリ
この領域に、使用する Behat インストールを指定します。
Behat 実行可能ファイルへのパス | このフィールドで、behat.phar アーカイブの場所、Behat 実行可能ファイルのあるフォルダーを指定します。Behat は必ずしも現在のプロジェクトルートにインストールする必要はありません。手動でパスを入力するか、 をクリックして表示されるダイアログで適切な場所を選択できます。 |
Behat リリース | このリンクをクリックして GitHub の Behat リポジトリに移動し、そこで behat.phar アーカイブの関連バージョンを選択できます。 |
Behat バージョン | この読み取り専用フィールドには、指定した Behat インストールのバージョンが表示されます。PhpStorm は、リフレッシュアイコン をクリックするとバージョンを検出します。デフォルト値は未インストールです。 |
テストランナー
この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。
デフォルトでは、Behat はプロジェクトルートフォルダーで behat.yml または behat.yml.dist 構成ファイルを検索します。カスタム構成ファイルを指定できます。
デフォルト構成ファイル | 独自の YML 設定ファイルを指定するには、このチェックボックスを選択します。このファイルは、後ですべての Behat 実行 / デバッグ構成でデフォルトとして使用されます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 チェックボックスをオフにすると、Behat でプロジェクトルートフォルダーの behat.yml または behat.yml.dist 構成ファイルを使用できるようになります。そのようなファイルが見つからない場合、テストの実行は失敗するため、構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
CLI インタープリター | Behat を使用するためのリモート PHP CLI インタープリター。CLI インタープリターフィールドは読み取り専用です。インタープリターダイアログで選択したインタープリターを更新するには、 をクリックします。 |
パスマッピング | ローカルソースと、Vagrant インスタンス内、Docker コンテナー内、またはリモートホスト上のソース間のパスマッピング。 ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。あるいは、フィールドの横にある をクリックして、設定を手動で指定します。詳細については、リモート PHP インタープリターの構成を参照してください。 |
Docker コンテナー | イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。 |
Behat ライブラリ
この領域に、使用する Behat インストールを指定します。
Behat 実行可能ファイルへのパス | このフィールドで、behat.phar アーカイブの場所、Behat 実行可能ファイルのあるフォルダーを指定します。Behat は必ずしも現在のプロジェクトルートにインストールする必要はありません。手動でパスを入力するか、 をクリックして表示されるダイアログで適切な場所を選択できます。 |
Behat リリース | このリンクをクリックして GitHub の Behat リポジトリに移動し、そこで behat.phar アーカイブの関連バージョンを選択できます。 |
Behat バージョン | この読み取り専用フィールドには、指定した Behat インストールのバージョンが表示されます。PhpStorm は、リフレッシュアイコン をクリックするとバージョンを検出します。デフォルト値は未インストールです。 |
テストランナー
この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。
デフォルトでは、Behat はプロジェクトルートフォルダーで behat.yml または behat.yml.dist 構成ファイルを検索します。カスタム構成ファイルを指定できます。
デフォルト構成ファイル | 独自の YML 設定ファイルを指定するには、このチェックボックスを選択します。このファイルは、後ですべての Behat 実行 / デバッグ構成でデフォルトとして使用されます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 チェックボックスをオフにすると、Behat でプロジェクトルートフォルダーの behat.yml または behat.yml.dist 構成ファイルを使用できるようになります。そのようなファイルが見つからない場合、テストの実行は失敗するため、構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
PHPSpec
このペインでは、構成済みのローカルおよびリモート PHP インタープリターを介して利用可能な PHPSpec(英語) ツールセットのインストールを設定します。
PHPSpec ライブラリ
この領域に、使用する PHPSpec のインストールを指定します。
PHPSpec 実行ファイルへのパス | このフィールドに、phpspec の場所を指定します。PHPSpec は必ずしも現在のプロジェクトルートにインストールする必要はありません。 ローカルインタープリターに PHPSpec へのパスが指定されていない場合、PhpStorm は PHPSpec の完全なサポートを提供しません。たとえば、コード補完の提案を表示せず、参照を解決しません。 |
接頭辞 ('spec_prefix' ) | この読み取り専用フィールドには、仕様の名前空間プレフィックスが表示されます。PhpStorm は、デフォルト構成ファイルフィールドで指定された構成ファイルから |
テストランナー
この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。
デフォルトでは、PHPSpec はプロジェクトのルートフォルダーで phpspec.yml または phpspec.yml.dist 構成ファイルを検索します。カスタム構成ファイルを指定できます。
デフォルト構成ファイル | 独自の YML 設定ファイルを指定するには、このチェックボックスを選択します。このファイルは後ですべての PHPSpec 実行 / デバッグ構成でデフォルトとして使用されます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 PHPSpec にプロジェクトルートフォルダーの phpspec.yml または phpspec.yml.dist 設定ファイルを使用させるには、チェックボックスをオフにします。そのようなファイルが見つからない場合、テストの実行は失敗します。構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
CLI インタープリター | PHPSpec を使用するためのリモート PHP CLI インタープリター。CLI インタープリターフィールドは読み取り専用です。 をクリックすると、インタープリターダイアログで選択したインタープリターが更新されます。 |
パスマッピング | ローカルソースと、Vagrant インスタンス内、Docker コンテナー内、またはリモートホスト上のソース間のパスマッピング。 ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。あるいは、フィールドの横にある をクリックして、設定を手動で指定します。詳細については、リモート PHP インタープリターの構成を参照してください。 |
Docker コンテナー | イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。 |
PHPSpec ライブラリ
この領域に、使用する PHPSpec のインストールを指定します。
PHPSpec 実行ファイルへのパス | このフィールドに、phpspec の場所を指定します。PHPSpec は必ずしも現在のプロジェクトルートにインストールする必要はありません。 ローカルインタープリターに PHPSpec へのパスが指定されていない場合、PhpStorm は PHPSpec の完全なサポートを提供しません。たとえば、コード補完の提案を表示せず、参照を解決しません。 |
テストランナー
この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。
デフォルトでは、PHPSpec はプロジェクトのルートフォルダーで phpspec.yml または phpspec.yml.dist 構成ファイルを検索します。カスタム構成ファイルを指定できます。
デフォルト構成ファイル | 独自の YML 設定ファイルを指定するには、このチェックボックスを選択します。このファイルは後ですべての PHPSpec 実行 / デバッグ構成でデフォルトとして使用されます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 PHPSpec にプロジェクトルートフォルダーの phpspec.yml または phpspec.yml.dist 設定ファイルを使用させるには、チェックボックスをオフにします。そのようなファイルが見つからない場合、テストの実行は失敗します。構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
Codeception
このペインでは、構成済みのローカルおよびリモート PHP インタープリターを介して利用可能な Codeception(英語) フレームワークのインストールを設定します。
Codeception ライブラリ
この領域に、使用する Codeception インストールを指定します。
Codeception 実行可能ファイルへのパス | このフィールドで、codeception.phar アーカイブの場所、Codeception 実行可能ファイルのあるフォルダーを指定します。 |
Codeception リリース | このリンクをクリックして GitHub の Codeception リポジトリに移動し、そこで codeception.phar アーカイブの関連バージョンを選択できます。 |
Codeception バージョン | この読み取り専用フィールドは、指定された Codeception インストールのバージョンを表示します。 をクリックすると、PhpStorm がバージョンを検出します。デフォルト値は未インストールです。 |
テストランナー
この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。
デフォルトでは、Codeception はプロジェクトルートフォルダーで codeception.yml または codeception.dist.yml 構成ファイルを検索します。カスタム構成ファイルを指定できます。
デフォルト構成ファイル | 独自の YML 設定ファイルを指定するには、このチェックボックスを選択します。このファイルは、後ですべての Codeception 実行 / デバッグ構成でデフォルトとして使用されます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 チェックボックスをオフにすると、Codeception でプロジェクトルートフォルダーの codeception.yml または codeception.dist.yml 構成ファイルを使用できるようになります。そのようなファイルが見つからない場合、テストの実行は失敗するため、構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
CLI インタープリター | Codeception を使用するためのリモート PHP CLI インタープリター。CLI インタープリターフィールドは読み取り専用です。インタープリターダイアログで選択したインタープリターを更新するには、 をクリックします。 |
パスマッピング | ローカルソースと、Vagrant インスタンス内、Docker コンテナー内、またはリモートホスト上のソース間のパスマッピング。 ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。あるいは、フィールドの横にある をクリックして、設定を手動で指定します。詳細については、リモート PHP インタープリターの構成を参照してください。 |
Docker コンテナー | イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。 |
Codeception ライブラリ
この領域に、使用する Codeception インストールを指定します。
Codeception 実行可能ファイルへのパス | このフィールドで、codeception.phar アーカイブの場所、Codeception 実行可能ファイルのあるフォルダーを指定します。 |
Codeception リリース | このリンクをクリックして GitHub の Codeception リポジトリに移動し、そこで codeception.phar アーカイブの関連バージョンを選択できます。 |
Codeception バージョン | この読み取り専用フィールドは、指定された Codeception インストールのバージョンを表示します。 をクリックすると、PhpStorm がバージョンを検出します。デフォルト値は未インストールです。 |
テストランナー
この領域で、シナリオの起動と実行に使用する構成 YML ファイルを指定します。
デフォルトでは、Codeception はプロジェクトルートフォルダーで codeception.yml または codeception.dist.yml 構成ファイルを検索します。カスタム構成ファイルを指定できます。
デフォルト構成ファイル | 独自の YML 設定ファイルを指定するには、このチェックボックスを選択します。このファイルは、後ですべての Codeception 実行 / デバッグ構成でデフォルトとして使用されます。 このフィールドで、使用する構成ファイルの場所を指定します。手動でパスを入力するか、 をクリックして表示されるダイアログでファイルを選択します。 チェックボックスをオフにすると、Codeception でプロジェクトルートフォルダーの codeception.yml または codeception.dist.yml 構成ファイルを使用できるようになります。そのようなファイルが見つからない場合、テストの実行は失敗するため、構成ファイルを明示的に指定する方が信頼性が高い場合があります。 |
Pest
このペインでは、構成されたローカルおよびリモート PHP インタープリターを通じて利用可能な Pest(英語) テストフレームワークのインストールを構成します。
Pest ライブラリ
Pest 実行可能ファイルへのパス | pest 実行可能ファイルへの絶対パス。 をクリックし、開いたダイアログで関連する場所を選択します。 Composer を使用してプロジェクトに Pest 依存関係をインストールすると、PhpStorm はインストールされた Pest 実行可能ファイルを自動的に検出します。 |
テストランナー
デフォルト構成ファイル | デフォルトでは、PhpStorm はプロジェクトルートフォルダー内の phpunit.xml または phpunit.xml.dist 構成ファイルを検出して使用します。 カスタム構成ファイルを使用するには、チェックボックスをオンにして、使用する構成ファイルの場所を指定します。パスを手動で入力するか、 をクリックして、表示されるダイアログで適切な場所を選択します。 |
CLI インタープリター | Pest を使用するためのリモート PHP CLI インタープリター。CLI インタープリターフィールドは読み取り専用です。インタープリターダイアログで選択したインタープリターを更新するには、 をクリックします。 |
パスマッピング | ローカルソースと、Vagrant インスタンス内、Docker コンテナー内、またはリモートホスト上のソース間のパスマッピング。 ほとんどの場合、PhpStorm はパスマッピングとコンテナー設定を検出し、すべてのフィールドに自動的に入力します。あるいは、フィールドの横にある をクリックして、設定を手動で指定します。詳細については、リモート PHP インタープリターの構成を参照してください。 |
Docker コンテナー | イメージからコンテナーを開始するために使用される Docker コンテナー設定。これらの設定には、ボリューム構成、公開ポート、ネットワークなどが含まれます。 |
Pest ライブラリ
Pest 実行可能ファイルへのパス | pest 実行可能ファイルへの絶対パス。 をクリックし、開いたダイアログで関連する場所を選択します。 |
テストランナー
デフォルト構成ファイル | デフォルトでは、PhpStorm はプロジェクトルートフォルダー内の phpunit.xml または phpunit.xml.dist 構成ファイルを検出して使用します。 カスタム構成ファイルを使用するには、チェックボックスをオンにして、使用する構成ファイルの場所を指定します。パスを手動で入力するか、 をクリックして、表示されるダイアログで適切な場所を選択します。 |
関連ページ:
Composer 依存関係マネージャー
PhpStorm は Composer 依存関係マネージャーと統合されています。これにより、Packagist またはカスタムリポジトリからのパッケージをプロジェクトの依存関係として宣言し、IDE から管理できます。PhpStorm は以下を提供します。一般的な Composer コマンド (init、install、update、および多数の追加 Composer コマンド) を実行するための専用ユーザーインターフェース。コマンド出力は Composer ログコンソールに表示されます。PhpStorm...
パス選択ダイアログ
このダイアログを使用して、さまざまな状況でファイルまたはフォルダーの場所を指定します。たとえば、実行する実行可能ファイル、使用する構成ファイル、テストまたはインスペクション結果をエクスポートするファイルなどを指定します。ダイアログ名と使用可能な機能は、現在実行しているタスクによって異なります(通常、不適切な機能は無効になっています)。例: 状況に応じて、1 つのアイテムのみ、またはいくつかのアイテムを選択できる場合があります。1 つまたは複数のフォルダーを選択できるが、1 つまたは複数のファイル...
リモート PHP インタープリターの構成
リモート PHP インタープリターという用語は、リモートホストまたは仮想環境にインストールされた PHP エンジンを指します。リモート PHP インタープリターという用語は、コンピューターにインストールされているローカル PHP インタープリターの対義語として使用されます (ローカル PHP インタープリターの構成を参照)。SSH、Docker、Docker Compose、Vagrant、WSL を介してリモート PHP インタープリターにアクセスできます。SSH を使用すると、PHP インター...