This dialog is available only when the PHP and Codeception plugins are enabled. The plugins are activated by default. If the plugins are disabled, enable them on the Plugins page as described in Managing plugins.
Use this dialog to create a configuration to be used for running and debugging unit tests on PHP applications using the Codeception framework.
In this area, specify the tests to launch and the command line switches to be passed to Codeception.
In this area, specify the location of unit tests or the configuration file where they are listed.
Type: select this option to launch the tests of a specific type. From the drop-down list, choose the type of test to run: acceptance, functional, or unit. Choose All to launch all the tests regardless of their type that are detected recursively in the folder specified as tests in the current configuration file.
Directory: select this option to have all the tests in a directory launched. In the Directory text box, specify the directory to search for tests in. Type the path to the directory manually or click Browse and select the desired directory in the Choose Test Directory dialog, that opens.
File: select this option to have all the tests in a specific file launched. In the File text box, specify the file with the tests to run.
Method: select this option to have a specific test method or function launched.
In the File text box, specify the file to search for the test method or scenario in. Type the file name manually or click Browse and select the desired file in the tree view, that opens.
In the Method text box, specify the desired test function or method to run. Click Browse and select the desired function from the list:
Defined in the configuration file: select this option to have Codeception execute the tests from a dedicated .yml configuration file.
By default, Codeception uses the configuration file appointed in the Test Runner area of the Test Frameworks page.
To have the default for all Codeception run configurations file used, clear the Use alternative configuration file checkbox.
To launch method/functions from a custom configuration file, select the Use alternative configuration file checkbox and specify the location of the desired YML file in the field next to it.
To open the Codeception page and specify another default configuration file to use, click the button.
Test Runner options: In this text box, specify the command line options to be passed to Codeception. For example, adding -vvv –colors as command line option results in debug verbosity of colored output messages. See Codeception Console Commands: Run for details.
Command Line area
In this area, customize the behavior of the current PHP interpreter by specifying the options and arguments to be passed to the PHP executable file.
In this field, specify the options to be passed to the PHP executable file. They override the default behavior of the PHP interpreter and/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 folder from which tests will be executed, that is, the parent folder of the tests root as it is specified in the paths section of codeception.yml. By default, the field is empty and the working directory is the root of the project.
When you edit a run configuration (but not a run configuration template), you can specify the following options:
In this field, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example, from the Run popup Shift+Alt+F10.
Share through VCS
Select this checkbox to put the run/debug configuration under version control and make it available to other team members.
The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml .
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.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
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.
View and edit the template (that is, the default settings) for the selected run/debug configuration. The templates are displayed under the Templates node and used for newly created configurations.
Move the selected run/debug configuration up and down in the list.
The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.
Default templates of run/debug configurations are always sorted alphabetically.
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.
In this area you can specify tasks that must be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
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, see External tools and External Tools.
Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
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.
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.
Upload files to Remote Host: select this option to have the application files automatically uploaded to the server according to the default server access configuration.