Pest
Use this dialog to create a configuration to be used for running and debugging unit tests on PHP applications using the Pest testing framework.
Before you start
Enable Pest support
Install and initialize Pest in your project. For instructions on installing Pest from within PhpStorm, refer to Install and initialize Pest.
Make sure the Pest plugin is enabled. The Pest plugin is bundled with PhpStorm and activated by default. If the plugin is disabled, enable it in as described in Managing plugins.
Common settings
When you edit a run configuration (but not a run configuration template), you can specify the following options:
Item | Description |
---|---|
Name | Specify a name for the run configuration to quickly identify it among others when editing or running. |
Allow multiple instances | Allow running multiple instances of this run configuration in parallel. By default, it is disabled, and when you start this configuration while another instance is still running, PhpStorm suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances. |
Store as project file | Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project. By default, it is disabled, and PhpStorm stores run configuration settings in .idea/workspace.xml. |
Test Runner area
In this area, specify the unit tests to launch and the command line switches to be passed to the test runner.
Item | Description |
---|---|
Test scope | In this area, specify the location of tests or the configuration file where they are listed.
|
Use alternative configuration file | If required, select the checkbox and click to specify the path to an alternative phpunit.xml configuration file. To use the default configuration file, leave the checkbox unselected. To quickly check if the default configuration file for Pest is set on the Test Frameworks page, click to the right of the field. |
Test Runner options | In this field, specify the options to be passed to Pest when running tests. For the full list of available options, refer to Pest documentation. If necessary, click and type the desired options in the dialog that opens. Type each option on a new line. When you close the dialog, the specified options are displayed in the Test Runner options field with spaces as separators. |
Preferred Coverage engine | From this list, choose one of the configured code coverage runners:
|
Command Line area
In this area, choose a PHP interpreter and customize its behavior by specifying the options and arguments to be passed to the PHP executable file.
Item | Description |
---|---|
Interpreter | The list contains all the currently configured local and remote PHP interpreters. Choose one of the configured PHP interpreters from the list, or click and define a new interpreter as described in Configure local PHP interpreters and Configure remote PHP interpreters. |
Interpreter options | In this field, specify the options to be passed to the PHP executable file. They override the default behavior of the PHP interpreter or ensure that additional activities are performed. If necessary, click and type the desired options in the Command Line Options dialog. Type each option on a new line. When you close the dialog, they are all displayed in the Command line options field with spaces as separators. |
Custom working directory | In this field, specify the location of the files that are outside the folder with tests and are referenced in your tests through relative paths. This setting does not block the test execution because the location of tests is always specified through a full path to the corresponding files and directories. By default, the field is empty, and the working directory is the root of the project. |
Environment variables | In this field, specify the environment variables to be passed to the built-in server. You can add the name-value pairs of environment variables manually by clicking , or click and browse to the For more information, refer to Environment Variables in Apache. |
Docker Compose area
This area only appears if you select a Docker Compose-based remote interpreter in the Interpreter field. Here, you can add some Docker Compose commands with options to the run configuration.
Item | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Commands and options | You can use the following commands of the Docker Compose Command-Line Interface:
| ||||||||
Command preview | Use this field to preview the complete command string. For example, the |
Before launch
In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Click this icon to add one of the following available tasks:
| |
Alt+Delete | Click this icon to remove the selected task from the list. | |
Enter | Click this icon to edit the selected task. Make the necessary changes in the dialog that opens. | |
Alt+Up Alt+Down | Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list. | |
Show this page | Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration. | |
Activate tool window | By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5. |
Toolbar
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Create a run/debug configuration. | |
Alt+Delete | Delete the selected run/debug configuration. Note that you cannot delete default configurations. | |
Ctrl+D | Create a copy of the selected run/debug configuration. Note that you create copies of default configurations. | |
The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent. | ||
Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders. To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created. Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons. To remove grouping, select a folder and click . | ||
Click this button to sort configurations in the alphabetical order. |