PHPSpecを使用したテスト

1. composer.json コンテキストメニューから、Composer | 依存性の管理を選択します。または、メインメニューからツール | Composer | 依存性の管理を選択します。

2. 開いたComposerの依存関係を管理するダイアログで、使用可能なパッケージ リストからphpspec / phpspecパッケージを選択します。おそらく検索フィールドを使用します。

   インストールするバージョンリストから該当するバージョンを選択します。

3. 必要に応じて、設定隠し領域を展開し、拡張インストールオプションを指定します。コマンド・ライン・パラメーターフィールドに、追加のコマンドラインパラメータを入力します。

4. インストールをクリックします。

PHPSpecを自動的に設定する

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

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

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

PHPSpecを手動で設定する

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

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

   

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

   • ZZC1C PHPインタープリターでPHPSpecを使用するには、表示されたダイアログで設定を1つ選択します：

     

2. PHPSpec実行ファイルへのパスフィールドで、phpspecの場所を指定します。PHPSpecは必ずしも現在のプロジェクトルートにインストールする必要はありません。PHPSpecディレクトリまたはpharファイルへのパスフィールドの横にある をクリックします。PhpStormはPHPSpecのバージョンを検出し、それをフィールドに表示します。

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

3. テスト・ランナー領域では、仕様の起動と実行に使用する構成 YML ファイルを指定します。

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

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

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

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

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

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

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

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

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

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

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

   

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

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

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

   • テストクラスファイルのフォルダー。本番クラスを含むディレクトリとネームスペース、構成済みのテストソースルートとそのpsr-4パッケージプレフィックス、またはphpspec.yml(英語)構成ファイルで指定された src_path 値に基づいて自動的に提案されます。自動フォルダー提案が正しく機能するためには、テストスイートと本番クラスの名前空間が一致する必要があることに注意してください。

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

   • テストクラスが属するネームスペース。本番クラスの含まれるディレクトリとネームスペース、構成されたテストソースルートとそのpsr-4パッケージプレフィックス、またはphpspec.yml(英語)構成ファイルで指定された spec_prefix および namespace 値に基づいて自動的に提案されます。

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

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

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

PHPSpecテストを実行またはデバッグする

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

  

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

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

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

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

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

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

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

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