IntelliJ IDEA 2017.2 Help

Testing with PHPSpec

This feature is supported in the Ultimate edition only.

With IntelliJ IDEA, you can practice behaviour-driven development by running specifications using the PHPSpec toolset.

Before you start

  1. Make sure the PHP and PHPSpec plugins are installed and enabled. The plugins are not bundled with IntelliJ IDEA, but they can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins. Once enabled, the plugins are available at the IDE level, that is, you can use them in all your IntelliJ IDEA projects.
  2. Make sure the PHP interpreter is configured in IntelliJ IDEA on the PHP page, as described in Configuring Local PHP Interpreters and Configuring Remote PHP Interpreters.

How do I install PHPSpec using Composer in IntelliJ IDEA?

  1. On the context menu of composer.json, choose Composer | Manage Dependencies.
  2. In the Manage Composer Dependencies Dialog that opens, select the phpspec/phpspec package from the Available Packages list, possibly using the search field. The list shows all the available packages, the packages that are already installed are marked with a tick.

    Choose the relevant version from the Version to install list.

  3. If necessary, expand the Settings hidden area and specify the advanced installation options. In the Command line parameters text box, type the additional command line parameters. For example, to have the package added to the require-dev section instead of the default require section, type --dev. For more information about Composer command line options during installation, see https://getcomposer.org/doc/03-cli.md.
  4. Click Install.

Learn more about PHPSpec installation from PHPSpec Official website.

How do I integrate PHPSpec with IntelliJ IDEA in a project?

Step 1: Choose how to use Codeception
Open the Test Frameworks page (File | Settings | Languages and Frameworks | PHP | Test Frameworks for Windows and Linux or IntelliJ IDEA | Preferences | Languages and Frameworks | PHP | Test Frameworks for macOS). Click add.png in the central pane and choose the configuration type from the list:

ps_settings_php_test_frameworks.png

Step 2: Choose the PHP interpreter to use
To use PHPSpec with a remote PHP interpreter, choose one of the configurations from the dialog box that opens:

ps_settings_php_test_frameworks_phpspec_choose_php_interpreter.png

Step 3: Specify the PHPSpec library to use
In the Path to PHPSpec executable text box, specify the location of phpspec. PHPSpec does not necessarily have to be installed under the current project root. Click /help/img/idea/2017.2/refresh.png next to the Path to PHPSpec directory or phar file text box. IntelliJ IDEA detects the version of PHPSpec and displays it below the text box.

Specify the PHPSpec configuration file to use
In the Test Runner area, appoint the configuration .yml file to use for launching and executing specifications.

By default, PHPSpec looks for a phpspec.yml or a phpspec.yml.dist configuration file in the project root folder. You can appoint a custom configuration file.

  • Clear the Default configuration file check box to have PHPSpec use the phpspec.yml or phpspec.yml.dist configuration file from the project root folder. If no such file is found, test execution fails, therefore it may be more reliable to specify the configuration file explicitly.
  • Select the Default configuration file check box to specify your own .yml configuration file. This file will be later used as default in all PHPSpec run/debug configurations.

    In the text box, specify the location of the configuration file to use. Type the path manually or click /help/img/idea/2017.2/browseButton.png and choose the file in the dialog box that opens.

In local configurations, the Prefix ('spec_prefix'): read-only field shows the namespace prefix for specifications. IntelliJ IDEA detects spec_prefix from the configuration file specified in the Default Configuration File field. The default value is spec. See PHPSpec Configuration: PSR-4 and PHPSpec Configuration: Spec and Source Location for details.

How do I run and debug PHPSpec tests?

For information about writing PHPSpec specifications, see http://www.phpspec.net/en/stable/manual/getting-started.html#specifying-behaviour. To run or debug your tests, do one of the following:

Option 1: To run or debug PHPSpec tests
In the Project tool window, select the file or folder to run your tests from and choose Run <file_or_folder_name> or Debug <file_or_folder_name> on the context menu of the selection:

ps_test_frameworks_phpspec_launch_tests.png
IntelliJ IDEA generates a default run configuration and starts a run/debug test session with it.

Option 2: To save an automatically generated default configuration
After a test session is over, choose Save <default_test_configuration_name> on the context menu of the file or folder and choose Save <default_configuration_name> on the context menu.

Option 3: To run or debug tests through a previously saved run/debug configuration
Choose the required PHPSpec configuration from the list on the tool bar and click /help/img/idea/2017.2/run.png or /help/img/idea/2017.2/debug.png.

Option 4: To create a custom run/debug configuration

  1. In the Project view, select the file or folder with the tests to run and choose Create run configuration on the context menu. Alternatively, choose Run | Edit Configurations on the main menu, then click /help/img/idea/2017.2/add.png and choose PHPSpec from the list.
  2. In the Run/Debug Configuration: PHPSpec dialog that opens, specify the the tests to run and customize the behavior of the current PHP interpreter by specifying the options and arguments to be passed to the PHP executable file.

How do I monitor test results?

IntelliJ IDEA shows the results of test execution in the Test Runner tab of the Run Tool Window. The tab is divided in 2 main areas. In the left-hand area you can drill down through all unit tests to see which ones succeeded and which ones failed. In this area you can also filter tests and export results.
The right-hand area shows us the raw PHPSpec output: Use the context menu in the left-hand area to run specific tests or navigate to the source code.

Last modified: 30 August 2017

See Also