Pest

Test scope

In this area, specify the location of tests or the configuration file where they are listed.

• Directory: select this option to have all the unit tests in a directory launched.

  In the Directory field, specify the directory to search the unit test in. Type the path to the directory manually or click and select the desired directory in the Choose Test Directory dialog, that opens.

• Class: select this option to have all the unit tests in a test class launched.

  In the Class field, type the name of the desired class. To quickly locate a class, use code completion Ctrl+Space. The location of the selected class will be displayed in the control File read-only field.

• Method: select this option to have a specific test method launched.

  In the Class field, type the name of the desired class. To quickly locate a class, use code completion Ctrl+Space. The location of the selected class will be displayed in the control File read-only field.

  In the Method field, specify the desired method. To quickly locate a class, use code completion Ctrl+Space.

• Defined in the configuration file: select this option to have test runner execute the tests from a dedicated XML configuration file.

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:

• Xdebug, a debugging extension providing both the debugging and code coverage capabilities.

  To enable Xdebug, make sure at least the following settings are specified in the [xdebug] section of the active php.ini file.

  [xdebug] zend_extension="<path to xdebug extension>" xdebug.mode=coverage

  [xdebug] zend_extension="<path to xdebug extension>" xdebug.coverage_enable=1

  For more information, refer to Configure Xdebug.

• PCOV, a lightweight extension only providing code coverage capabilities.

  To enable PCOV, download and install the extension as described in the PCOV documentation. Then, make sure at least the following settings are specified in the active php.ini file:

  extension="<path to pcov extension>"

• phpdbg, a debugging and code coverage module, which is bundled in PHP 5.6 and later and requires no additional configuration.

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 .env file on your computer.

For more information, refer to Environment Variables in Apache.

Alt+Insert

Click this icon to add one of the following available tasks:

• Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in PhpStorm yet, add its definition. For more information, refer to External tools and External Tools.

• Run Another Configuration: select to execute another run/debug configuration and wait until it finishes before starting the current configuration. If you want to run several configurations in parallel, use a compound run/debug configuration.

• Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger.

• Run File Watchers: select this option to have PhpStorm apply all the currently active File Watchers.

• Run Grunt task: select this option to run a Grunt task.

  In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

  Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

• Run gulp task: select this option to run a Gulp task.

  In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

  Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

• Run npm script: select this option to execute an npm script.

  In the NPM Script dialog that opens, specify the npm run/debug configuration settings.

• Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

  • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

  • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

• Run Phing target: add this task to execute the specified Phing target prior to running or debugging. To appoint a Phing target, click Browse and select the desired target in the dialog that opens.

• Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

• Run Remote External Tool: adds a remote SSH external tool.

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.