Test Frameworks
Use this page to integrate PHP testing frameworks with PhpStorm in the current project. With PhpStorm, you can run and debug PHPUnit, Behat, PHPSpec, Codeception, and Pest tests.
Configure a test framework in a project
Click
and choose the test framework and the PHP interpreter to run it with:
For a remote configuration, choose one of the configured PHP interpreters:
In the right-hand pane, choose where to take the test framework from.
For Behat, PHPSpec, and Codeception, type the path to the framework executable.
For PHPUnit, specify the type of framework installation you are using, the available options are composer autoloader autoload.php or a phpunit.phar archive.
Check the chosen remote PHP interpreter and path mappings.
Optionally, specify the configuration file. For PHPUnit, you can also specify a bootstrap file to use.
PHPUnit
In this pane, configure installations of PHPUnit to be used with PHP interpreters.
PHPUnit Library
In this area, specify the type of PHPUnit installation. The available options are as follows:
Use Composer autoloader | Choose this option to run PHPUnit installed by the Composer dependency manager. The package is retrieved and loaded by the autoload.php file from the vendor folder. Specify the location of autoload.php in the Path to script field. |
Path to phpunit.phar | Choose this option to run PHPUnit from the phar archive.
|
Test Runner
In this area, specify the path to the XML configuration file to be used when launching PHPUnit tests from PhpStorm.
You can also specify the path to a bootstrap file to have a PHP script always executed before launching tests.
Default configuration file | Select this checkbox to specify the path to the phpunit.xml or phpunit.xml.dist file to be used as the default configuration file in all PHPUnit run/debug configurations. Note that you can also provide an alternative configuration file for a specific PHPUnit run/debug configuration when editing it. If no XML configuration file is specified, PhpStorm by default runs PHPUnit tests with the |
Default bootstrap file | Select this checkbox to have a PHP script always executed before launching tests. In the field, specify the location of the script. Type the path manually or click |
CLI Interpreter | The remote PHP CLI Interpreter to use PHPUnit with. The CLI Interpreter field is read-only. Click |
Path mappings | The Path mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host. In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click |
Docker container | The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed ports, the network, and so on. |
to update the chosen interpreter in the PHPUnit Library
In this area, specify the type of PHPUnit installation. The available options are as follows:
Use Composer autoloader | Choose this option to run PHPUnit installed by the Composer dependency manager. The package is retrieved and loaded by the autoload.php file from the vendor folder. Specify the location of autoload.php in the Path to script field. |
Path to phpunit.phar | Choose this option to run PHPUnit from the phar archive.
|
Test Runner
In this area, set the path to the configuration XML file to be used for launching and executing scenarios.
You can also type the path to a bootstrap file to have a PHP script always executed before launching tests. In the field, specify the location of the script. Type the path manually or click 
and select the desired folder in the dialog that opens.
Default configuration file | Select this checkbox to specify the path to the phpunit.xml or phpunit.xml.dist file to be used as the default configuration file in all PHPUnit run/debug configurations. Note that you can also provide an alternative configuration file for a specific PHPUnit run/debug configuration when editing it. If no XML configuration file is specified, PhpStorm by default runs PHPUnit tests with the Clear the checkbox to have PHPUnit use the phpunit.xml or phpunit.xml.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. |
Default bootstrap file | Select this checkbox to have a PHP script always executed before launching tests. In the field, specify the location of the script. Type the path manually or click |
Behat
In this pane, configure installations of the Behat framework available through configured local and remote PHP interpreters.
Behat Library
In this area, specify the Behat installation to use.
Path to Behat executable | In this field, specify the location of the behat.phar archive or the folder with the Behat executable file. Behat does not necessarily have to be installed under the current project root. You can type the path manually or click |
Behat releases | Click this link to navigate to the Behat repository on GitHub where you can choose the relevant version of behat.phar archive. |
Behat version | This read-only field shows the version of the specified Behat installation. PhpStorm detects the version when you click the Refresh icon |
. The default value is Test Runner
In this area, set the path to the configuration YML file to be used for launching and executing scenarios.
Default configuration file | Select this checkbox to specify the path to the YML file to be used as the default configuration file in all Behat run/debug configurations. Clear the checkbox to have Behat use the behat.yml or behat.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. |
CLI Interpreter | The remote PHP CLI Interpreter to use Behat with. The CLI Interpreter field is read-only. Click |
Path mappings | The Path mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host. In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click |
Docker container | The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed ports, the network, and so on. |
Behat Library
In this area, specify the Behat installation to use.
Path to Behat executable | In this field, specify the location of the behat.phar archive or the folder with the Behat executable file. Behat does not necessarily have to be installed under the current project root. You can type the path manually or click |
Behat releases | Click this link to navigate to the Behat repository on GitHub where you can choose the relevant version of behat.phar archive. |
Behat version | This read-only field shows the version of the specified Behat installation. PhpStorm detects the version when you click the Refresh icon |
Test Runner
In this area, set the path to the configuration YML file to be used for launching and executing scenarios.
Default configuration file | Select this checkbox to specify the path to the YML file to be used as the default configuration file in all Behat run/debug configurations. Clear the checkbox to have Behat use the behat.yml or behat.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. |
PHPSpec
In this pane, configure installations of the PHPSpec toolset available through configured local and remote PHP interpreters.
PHPSpec Library
In this area, specify the PHPSpec installation to use.
Path to PHPSpec executable | In this field, specify the location of phpspec. PHPSpec does not necessarily have to be installed under the current project root. 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. |
Prefix ('spec_prefix') | This read-only field shows the namespace prefix for specifications. PhpStorm detects |
Test Runner
In this area, set the path to the configuration YML file to be used for launching and executing scenarios.
Default configuration file | Select this checkbox to specify the path to the YML file to be used as the default configuration file in all PHPSpec run/debug configurations. Clear the 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. |
CLI Interpreter | The remote PHP CLI Interpreter to use PHPSpec with. The CLI Interpreter field is read-only. Click |
Path mappings | The Path mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host. In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click |
Docker container | The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed ports, the network, and so on. |
PHPSpec Library
In this area, specify the PHPSpec installation to use.
Path to PHPSpec executable | In this field, specify the location of phpspec. PHPSpec does not necessarily have to be installed under the current project root. 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. |
Test Runner
In this area, set the path to the configuration YML file to be used for launching and executing scenarios.
Default configuration file | Select this checkbox to specify the path to the YML file to be used as the default configuration file in all PHPSpec run/debug configurations. Clear the 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. |
Codeception
In this pane, configure installations of the Codeception framework available through configured local and remote PHP interpreters.
Codeception Library
In this area, specify the Codeception installation to use.
Path to Codeception executable | In this field, specify the location of the codeception.phar archive or the folder with the Codeception executable file. |
Codeception releases | Click this link to navigate to the Codeception repository on GitHub where you can choose the relevant version of codeception.phar archive. |
Codeception version | This read-only field shows the version of the specified Codeception installation. PhpStorm detects the version when you click |
Test Runner
In this area, set the path to the configuration YML file to be used for launching and executing scenarios.
Default configuration file | Select this checkbox to specify the path to the YML file to be used as the default configuration file in all Codeception run/debug configurations. Clear the checkbox to have Codeception use the codeception.yml or codeception.dist.yml 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. |
CLI Interpreter | The remote PHP CLI Interpreter to use Codeception with. The CLI Interpreter field is read-only. Click |
Path mappings | The Path mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host. In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click |
Docker container | The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed ports, the network, and so on. |
Codeception Library
In this area, specify the Codeception installation to use.
Path to Codeception executable | In this field, specify the location of the codeception.phar archive or the folder with the Codeception executable file. |
Codeception releases | Click this link to navigate to the Codeception repository on GitHub where you can choose the relevant version of codeception.phar archive. |
Codeception version | This read-only field shows the version of the specified Codeception installation. PhpStorm detects the version when you click |
Test Runner
In this area, set the path to the configuration YML file to be used for launching and executing scenarios.
Default configuration file | Select this checkbox to specify the path to the YML file to be used as the default configuration file in all Codeception run/debug configurations. Clear the checkbox to have Codeception use the codeception.yml or codeception.dist.yml 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. |
Pest
In this pane, configure installations of the Pest test framework available through configured local and remote PHP interpreters.
Pest Library
Path to Pest executable | The absolute path to the pest executable file. Click If you install the Pest dependency in your project using Composer, PhpStorm detects the installed Pest executable automatically. |
and choose the relevant location in the dialog that opens.Test Runner
Default configuration file | By default, PhpStorm detects and uses the phpunit.xml or phpunit.xml.dist configuration file in the project root folder. To use a custom configuration file, select the checkbox and specify the location of the configuration file to use. Type the path manually or click |
CLI Interpreter | The remote PHP CLI Interpreter to use Pest with. The CLI Interpreter field is read-only. Click |
Path mappings | The Path mappings between your local sources and the sources inside the Vagrant instance, or the Docker container, or on the remote host. In most cases, PhpStorm detects the path mappings and the container settings and fills in all the fields automatically. Alternatively, click |
Docker container | The Docker container settings that will be used to start the container from an image. These settings may include the volume configuration, the exposed ports, the network, and so on. |
Pest Library
Path to Pest executable | The absolute path to the pest executable file. Click |
Test Runner
Default configuration file | By default, PhpStorm detects and uses the phpunit.xml or phpunit.xml.dist configuration file in the project root folder. To use a custom configuration file, select the checkbox and specify the location of the configuration file to use. Type the path manually or click |