PhpStorm 2020.2ヘルプ

PHPSpec

PhpStormを使用すると、PHPSpecツールセットを使用して仕様を実行することで、動作駆動型開発を実践できます。

始める前に

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

Composerと一緒にPHPSpecをインストールする

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

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

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

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

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

PHPSpec公式サイト(英語)からのPHPSpecのインストールの詳細を参照してください。

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

Gutter icon for phpspec settings in composer.json

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

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

PHPSpecを自動的に設定する

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

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

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

PHPSpecを手動で設定する

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    the Create new phpspec test dialog

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

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

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

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

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

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

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

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

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

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

PHPSpecの仕様の作成方法については、PHPSpecのドキュメント(英語)を参照してください。テストを実行またはデバッグするには、次のいずれかを実行します。

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

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

    ps_test_frameworks_phpspec_launch_tests.png

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

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

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

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

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

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

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

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

テスト結果を監視する

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

ps_test_result_phpspec.png

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

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

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

最終更新日: 2020年9月03日

関連ページ:

ローカルPHPインタープリターを構成する

ローカルPHPインタープリターは、リモート PHPインタープリターの反対側にコンピューターにインストールされたPHPエンジンであり、リモートホストまたはVagrantインスタンスにセットアップされた仮想環境にインストールできます。リモート PHP インタープリターの構成を参照してください。設定/環境...

リモート PHP インタープリターの構成

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

Composer依存関係マネージャー

PhpStormはComposer依存関係マネージャーと統合されます。これにより、Packagistまたはカスタムリポジトリからのパッケージをプロジェクトの依存関係として宣言し、IDEから管理できます。PhpStormは、composer.jsonを操作するための包括的なコーディング支援と、一般的な...

テスト・フレームワーク

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

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

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

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

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