PhpStorm 2020.2ヘルプ

PHPUnit

PhpStormは、PHPUnit(英語)テストフレームワークとの統合によるPHPアプリケーションの単体テストをサポートしています。

始める前に

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

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

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

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

  • phpunit.pharPHPUnit公式サイト(英語)からダウンロードし、コンピューターに保存します。

    • PHPUnitテストを実行する機能に加えて完全なコーディング支援が必要な場合は、phpunit.pharをPHPUnitが後で使用されるプロジェクトのルートに格納します。

    • PHPUnitテストを実行するだけで、コーディング支援が必要ない場合、phpunit.pharをプロジェクトの外に保存することができます。

Composerを使ってphpunit.pharをダウンロードしてインストールする

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

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

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

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

composer.jsonエディターのガターでパッケージレコードの横にある the Settings/Preferences button をクリックして、対応する設定/環境設定ページにジャンプし、PHPUnitを手動で構成します

Gutter icon for phpunit settings in composer.json

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

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

PHPUnitを自動的に設定する

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

  2. PHPUnitをComposerと一緒にインストールします

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

PHPUnitを手動で設定する

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

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

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

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

      ps_settings_php_test_frameworks_phpunit_choose_php_interpreter.png
  2. 右側のペインで、PHPUnitライブラリのインストールタイプを選択します。

    • Composerオートローダーを使用するには、ベンダーフォルダー内のautoload.phpファイルへのパスを指定します。詳細については、Composerを参照してください。

    • phpunit.pharからPHPUnitを実行するには、phpunit.phar(英語)をダウンロードし、プロジェクトのルートフォルダーにアーカイブを保存して、そのパスを指定します。ローカル構成の場合、ダウンロードリンクをクリックしてアーカイブをダウンロードできます。現在のプロジェクトで使用するには、デフォルトのPHPインタープリターが定義されていることを確認してください。

      Reload buttonをクリックすると、PhpStormが検出され、PHPUnitのバージョンが表示されます。

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

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

    PHPUnitの実行/デバッグ構成を編集するときに、別の設定とブートストラップファイルを指定することもできます。

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

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

    • メインメニューからファイル | 新規を選択します。次に、コンテキストメニューからPHP テスト | PHPUnit テストを選択します。

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

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

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

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

    the Create new phpunit test dialog

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

    • テストファイルテンプレート、つまりPhpStormがテストクラスを生成するテンプレート。PHPUnit <6テストファイルテンプレートリストで選択されていることを確認してください。

    • テストクラスの名前。PhpStormは、本番クラス名から自動的に名前を<本番クラス> Test.phpとして作成します。

    • テストクラスファイルのフォルダー。本番クラスを含むディレクトリと名前空間、構成済みのテストソースルートとそのpsr-4パッケージプレフィックス、またはphpunit.xml(英語)構成ファイルで指定された directory 値に基づいて自動的に提案されます。

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

    • テストクラスが属する名前空間。これは、本番クラスを含むディレクトリと名前空間、構成されたテストソースルート、およびそのpsr-4パッケージプレフィックスに基づいて自動的に提案されます。

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

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

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

PHPUnitテストメソッドを生成する

  1. エディターで必要なテストクラスを開き、クラス定義内の任意の場所にキャレットを配置します。

  2. コンテキストメニューで生成を選択するか、Alt+Insertを押します。次に生成リストからテスト・メソッドを選択します。

  3. テストフィクスチャをセットアップします。つまり、テスト開始前に必要な環境をエミュレートし、テスト終了後に元の環境を返すコードのスタブを生成します。

    • コンテキストメニューで生成を選択するか、Alt+Insertを押します。次に、生成リストからsetUp メソッドまたはTearDown メソッドを選択します。

    詳細については、PHPUnit公式サイトのフィクスチャ(英語)を参照してください。

設定/環境設定ダイアログ Ctrl+Alt+Sファイルおよびコード・テンプレートページで、PHPUnitテストメソッドの生成に使用するコードテンプレートをカスタマイズできます。このページにすばやくアクセスするには、生成リストで、メソッドのサブメニューからテンプレートを編集を選択します。

Edit PHPUnit method template

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

単一のテストだけでなく、ファイルやフォルダー全体のテストも実行してデバッグすることができます。PhpStormは、デフォルト設定で実行/デバッグ構成を作成し、テストを起動します。後でこの設定を保存して、さらに再利用することができます。

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

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

    ps_test_frameworks_phpunit_launch_tests.png

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

単一のテストを実行またはデバッグする

  • エディターでテストファイルを開き、テストの呼び出しを右クリックして、コンテキストメニューから実行 '<test_name>'またはデバッグ '<test_name>'を選択します。

選択したテストを実行する

  1. エディターでターゲットファイルを開き、目的のテストターゲット、つまりテストするクラスまたはメソッドを右クリックし、ジャンプ | テストを選択するか Ctrl+Shift+Tを押します。

  2. ポップアップメニューから、実行するテストを選択します。複数選択の場合は、Ctrl および Shiftを使用します。

    Run a selection of tests
  3. テスト選択を実行するには、Ctrl+Shift+F10 を押します。

テストセッションが終了すると、PhpStormは自動的にテスト・スコープコンポジットに設定された実行/デバッグ構成を作成します。詳細は実行/デバッグ構成: PHPUnitを参照してください。

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

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

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

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

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

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

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

テスト結果を監視する

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

ps_test_result_phpunit.png

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

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

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

PHPUnitテストを自動的に実行する

影響を受けるコードが変更された場合、自動的にPhpStormを再実行することができます。このオプションは、実行/デバッグ構成ごとに構成され、この実行/デバッグ構成で指定されたテスト範囲に応じて、テスト、テストファイル、フォルダー、またはテストの複合選択に適用できます。

自動的に再実行テストを設定する

  1. テストを実行します。

  2. テスト・ランナータブで、ツールバーの ps_icon_phpunit_run_test_automatically.png トグルボタンを押します。

    ps_phpunit_enable-auto-test.png
  3. 必要に応じて、Settings button ボタンをクリックして、コードの変更時にテストを開始するための遅延時間を設定します。

    ps_phpunit_set-auto-test-delay.png
最終更新日: 2020年7月15日

関連ページ:

ローカル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 インタープリターの構成

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

Composer依存関係マネージャー

PhpStorm integrates with theComposerdependency manager, which allows you to declare packages fromPackagistor a custom repository as your project's dep...

テスト・フレームワーク

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

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

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

プロジェクトでPHP名前空間を構成する

PhpStormには、プロジェクトルートフォルダーがパッケージおよび名前空間のルートでもあることを指定する構成可能な規則が付属しています。つまり、プロジェクトのルートフォルダーはデフォルトでソースとしてマークされ、そに作成されるすべてのディレクトリは個別のネームスペースと見なされます。これは、オート...