Testing with PHPSpec
With PhpStorm, you can practice behaviour-driven development by running specifications using the PHPSpec toolset.
Before you start
Installing PHPSpec with Composer
Before you start, make sure Composer is installed on your machine and initialized in the current project as described in Composer Dependency Manager.
From the composer.json context menu, choose . Alternatively choose from the main menu.
In the Manage Composer Dependencies Dialog that opens, select the phpspec/phpspec package from the Available Packages list, possibly using the search field.
Learn more about PHPSpec installation from PHPSpec Official website.
Integrating PHPSpec with a PhpStorm project
Configure PHPSpec automatically
Store the phpspec.yml or phpspec.yml.dist configuration file under the project root.
Configure PHPSpec manually
On the Test Frameworks page that opens, click in the central pane and choose the configuration type from the list:
In local configurations, the default project PHP interpreter is used, see Default project CLI interpreters for details.
To use PHPSpec with a remote PHP interpreter, choose one of the configurations in the dialog that opens:
- In the Path to PHPSpec executable field, specify the location of phpspec. PHPSpec does not necessarily have to be installed under the current project root. Click next to the Path to PHPSpec directory or phar file field. PhpStorm detects the version of PHPSpec and displays it below the field.
If no path to PHPSpec is specified for a Local interpreter, PhpStorm does not provide full support of PHPSpec, for example, it does not show suggestions for code completion and does not resolve references.
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 checkbox 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.
In the field, specify the location of the configuration file to use. Type the path manually or click and choose the file in the dialog that opens.
spec_prefixfrom 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.
Generating a PHPSpec test for a class
Open the Create New PHP Test dialog by doing any of the following:
From the main menu, choose PHP Test | PHPSpec Spec from the context menu.. Then, choose
In the Project tool window, press Alt+Insert or right-click the PHP class to be tested and choose New | PHP Test | PHPSpec Spec.
In the editor of the PHP class to be tested, position the caret inside the definition of the class. Then, choose Go To | Test from the context menu or press Ctrl+Shift+T and select Create New Test from the popup menu. This way, you can generate a test for a PHP class defined among several classes within a single PHP file.
To create a test for a certain method, position the caret within the method declaration. The chosen method will be automatically selected in the Generate test methods for area of the Create New PHP Test dialog.
The Create New PHP Test dialog opens.
Provide the parameters of the generated test:
The test file template, that is, the template based on which PhpStorm will generate the test class. Make sure that PHPSpec is selected in the Test file template list.
The name of the test class. PhpStorm automatically composes the name from the production class name as <production class>Spec.php.
The folder for the test class file, which is automatically suggested based on the containing directory and namespace of the production class, the configured test sources root and its psr-4 package prefix, or the
src_pathvalue specified in the phpspec.yml configuration file. Note that for the automatic folder suggestion to work correctly, the test suite and the production class namespaces have to match.
To specify a different folder, click next to the Directory field and choose the relevant folder.
The namespace the test class will belong to, which is automatically suggested based on the containing directory and namespace of the production class, the configured test sources root and its psr-4 package prefix, or the
namespacevalues specified in the phpspec.yml configuration file.
The production class methods to generate test method stubs for. In the Generate test methods for area, select the checkboxes next to the required production class methods. To include inherited methods from parent classes, select the Show inherited methods checkbox.
PhpStorm will automatically compose the test methods' names as
test<production method>. You can customize the code templates used for generating test method stubs on the Code tab of the File and Code Templates settings page.
When the test is ready, you can navigate back to the production class by choosing Navigate | Go to Test Subject. For details, see Navigating between test and test subject.
Running and debugging PHPSpec tests
For information about writing PHPSpec specifications, see the PHPSpec Documentation. To run or debug your tests, do one of the following:
Run or debug PHPSpec tests
Save an automatically generated default configuration
Run or debug tests through a previously saved run/debug configuration
Create a custom run/debug configuration
In the Project tool window, select the file or folder with the tests to run and choose Create run configuration from the context menu. Alternatively, choose from the main menu, then click and choose PHPSpec from the list.
In the Run/Debug Configuration: PHPSpec dialog that opens, specify the scenarios to run, choose the PHP interpreter to use, and customize its behavior by specifying the options and arguments to be passed to the PHP executable.
Monitoring test results
The tab is divided into 2 main areas:
The left-hand area lets you drill down through all unit tests to see the succeeded and failed ones. You can filter tests, export results, and use the context menu commands to run specific tests or navigate to the source code.
The right-hand area displays the raw PHPSpec output.