Pest

PhpStorm 内から Pest をインストールするには:

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

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

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

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

3. ターミナル ツールウィンドウで、 ./vendor/bin/pest --init コマンドを実行して現在の PHP プロジェクトで Pest を初期化し、サンプルテストファイルを含む tests フォルダーと phpunit.xml 構成ファイルをテストスイートのルートレベルに追加します。

Pest を自動的に設定する

プロジェクトに Pest をインストールすると、PhpStorm はインストールされた Pest 実行可能ファイルを検出し、 テストフレームワークページにテストフレームワーク構成を作成します。

phpunit.xml または phpunit.xml.dist 構成ファイルがプロジェクト (またはサブプロジェクト) ルートで自動的に検出された場合、または 手動構成中に明示的に指定された場合、PhpStorm はそれぞれの Pest 実行 / デバッグ構成も作成します。

Pest を手動で設定する

1. 設定 ダイアログ（Ctrl+Alt+S ）で、 PHP | テストフレームワーク に移動します。

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

   

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

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

     

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

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

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

2. 開いた 新しい PHP テストを作成する ダイアログで、生成されたテストのパラメーターを指定します。

   

   • テストファイルテンプレート: PhpStorm がテストクラスを生成するためのテンプレート。 リストから Pest が選択されていることを確認します。

   • Name: テストクラスの名前。 PhpStorm は、本番クラス名から名前を自動的に作成します。

   • Directory: テストクラスファイル用のフォルダーです。これは、本番クラスの格納ディレクトリと名前空間、構成済みの テストソースルート とその PSR-4 パッケージ接頭辞 、または構成ファイルで指定された値に基づいて自動的に提案されます。

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

   • 名前空間: テストクラスが属する名前空間です。これは、プロダクションクラスを含むディレクトリと名前空間、構成済みの テストソースルート とその psr-4 パッケージプレフィックス に基づいて自動的に提案されます。

   • メンバー: テストメソッドスタブを生成する製品クラスメソッドのリスト。 必要な製品クラスメソッドの横にあるチェックボックスをオンにします。 親クラスから継承されたメソッドを含めるには、 継承メソッドの表示 チェックボックスをオンにします。

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

テストが作成されたら、 移動 | テスト対象に移動 を選択して実稼働クラスに戻ることができます。 詳細については、 個別のファイルを適用するを参照してください。

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

PhpStorm で Pest テストを実行するには、いくつかの代替方法があります。

• Project ツールウィンドウから: テストを実行するファイルまたはフォルダーを選択し、選択項目のコンテキストメニューから 実行 '<file or folder>'、 デバッグ '<file or folder>' 、または さらに実行/デバッグ を選択します。

  

• ファイルエディターウィンドウから: エディターでテストファイルを開き、テストの横のガターにある をクリックして、コンテキストメニューから '<テスト名>' の実行、 '<テスト名>' のデバッグ、 '<test_name>' を並列で実行する、 ミューテーションを使用して '<test_name>' を実行する を選択します。

  または、対応する行にキャレットを置いて Ctrl+Shift+F10 を押します。

  

• 実行ウィジェットから: ドロップダウンリストから 現在のファイル を選択し、 または をクリックして現在開いているテストファイルを実行またはデバッグするか、 をクリックして '<test_name>' を並列で実行する または ミューテーションを使用して '<test_name>' を実行する オプションを選択します。

  

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

一時停止した実行を再開する

Pest 4.0 以降では、 debug() 方式によるブラウザーテスト(英語)を実行すると実行が一時停止され、ブラウザーウィンドウが開きます。 PhpStorm でテスト実行を再開するには、ツールバーの「テスト実行の続行 」ボタンをクリックします。

Pest テストを移動する

テストファイル内の特定のテストにすばやく移動するには、 ファイル構造 ビューを使用します。 開いているファイル内の任意の場所にキャレットを置き、 Ctrl+F12 を押して ファイル構造 ポップアップを開きます。

Alt+7 を押すと、 構造 ツールウィンドウでファイル構造が開きます。

設定を永続的に保存する

• テストセッションが終了したら、実行ウィジェットのそれぞれの実行 / デバッグ構成のコンテキストメニューから Save Configuration を選択します。

  

保存した実行 / デバッグ構成を実行する

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

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

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

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

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

2. 実行 ツールバーで、 自動的に再実行 をクリックします。

   

3. オプションで、コードの変更時にテストを開始するまでの遅延時間を設定します。 これを行うには、 実行 ツールバーで をクリックし、 テストランナーの設定 | 自動テスト遅延の設定 を選択します。