Run/Debug Configuration: Codeception
This dialog box is available only when the PHP and Codeception plugins are installed and enabled. The plugins are not bundled with IntelliJ IDEA, but they can be installed from the JetBrains plugin repository as described in Managing Plugins. Once enabled, the plugins are available at the IDE level, that is, you can use them in all your IntelliJ IDEA projects.
Use this dialog box to create a configuration to be used for running and debugging unit tests on PHP applications using the Codeception framework.
On this page:
- Before you start
- Test Runner area
- Command Line area
- Common options
- Toolbar
- Templates
- Before Launch options
Before you start
Install and configure the Codeception framework on your computer as described in Testing with Codeception.
Test Runner area
In this area, specify the tests to launch and the command line switches to be passed to Codeception.
Item | Description |
---|---|
Test scope | In this area, specify the location of unit tests or the configuration file where they are listed.
|
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.
Item | Description |
---|---|
Interpreter options | In this text box, 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 box. Type each option on a new line. When you close the dialog box, they are all displayed in the Command line options text box 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 |
Environment variables | In this field, specify the environment variables be passed to the built-in server. See Environment Variables in Apache for details. |
Common options
When you edit a run configuration (but not a run configuration template), you can specify the following options for it:
Item | Description |
---|---|
Name | In this text box, 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 | Select this check box to make the run/debug configuration available to other team members. If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the If the file-based format is used, the settings are stored in the |
Single instance only |
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. |
| Edit Templates | View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations. |
/ | Alt+Up/Alt+Down | 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. |
| 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 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-and-drop or and buttons. To remove grouping, select a folder and click . |
| Sort configurations | Click this button to sort configurations in the alphabetical order. |
Templates
Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.
When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:
Item | Description |
---|---|
Configurations available in Run Dashboard | In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations. Note that the dashboard will only display the configuration types for which you have created one ore more configurations. |
Confirm rerun with process termination | The behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration.
|
Temporary configurations limit | Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list. |
Before Launch options
In this area you can specify tasks that must be 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 | If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5. |