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 構成ファイルをテストスイートのルートレベルに追加します。

PhpStorm に Pest を自動的に設定させる

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

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

Pest を手動で設定する

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

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

   

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

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

     

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

   デフォルトでは、Pest はプロジェクトルートフォルダーで phpunit.xml または phpunit.xml.dist 構成ファイルを検索します。カスタム構成ファイルを指定できます。

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

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

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

   

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

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

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

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

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

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

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

テストが作成されたら、移動 | テスト対象に移動を選択して実稼働クラスに戻ることができます。詳細については、「テストとそのテスト対象の間を移動する」を参照してください。

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

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

  

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

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

ファイルエディターウィンドウから、特定のテストクラスまたはテストメソッドの単一のテストを実行またはデバッグできます。

• エディターでテストファイルを開き、テストの横のガターで をクリックし、コンテキストメニューから実行 '<test_name>' またはデバッグ '<test_name>' を選択します。あるいは、対応する行にキャレットを置き、Ctrl+Shift+F10 を押します。

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

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

自動生成された構成を永続的なものとして保存する

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

  

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

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

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

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

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

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

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

   

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