PhpStorm 2017.2 Help

Run/Debug Configuration: Codeception

This dialog box 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 Enabling and Disabling Plugins.

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

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.

ItemDescription
Test scope 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 the Browse button browseButton.png and select the desired directory in the Choose Test Directory dialog box, 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.
    1. In the File text box, specify the file to search for the test method or scenario in. Type the file name manually or click the Browse button browseButton.png and select the desired file in the tree view, that opens.
    2. In the Method text box, specify the desired test function or method to run. Click the Browse button browseButton.png and select the desired function from the list:
      ps_codeception_choose_method.png
  • 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 check box.
    • To launch method/functions from a custom configuration file, select the Use alternative configuration file check box and specify the location of the desired .yml file in the text box next to it.
    • To open the Codeception page and specify another default configuration file to use, click the /help/img/idea/2017.2/settings.png 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.

ItemDescription
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 /help/img/idea/2017.2/shift-enter-button.png 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 paths section of codeception.yml. 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 be passed to the built-in server. See Environment Variables in Apache for details.

Toolbar

ItemShortcutDescription
/help/img/idea/2017.2/new.png Alt+Insert Click this button to add a new configuration to the list.
/help/img/idea/2017.2/delete.png Alt+Delete Click this button to remove the selected configuration from the list.
/help/img/idea/2017.2/copy.gif Ctrl+D Click this button to create a copy of the selected configuration.
/help/img/idea/2017.2/settings.png Edit defaultsClick this button to edit the default configuration templates. The defaults are used for newly created configurations.
/help/img/idea/2017.2/arrowUp.png or /help/img/idea/2017.2/arrowDown.png Alt+Up or Alt+Down Use these buttons to move the selected configuration or folder up and down in the list.

The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar.

/help/img/idea/2017.2/sortAlphabetically.png Sort configurations Click this button to sort configurations in alphabetical order.

Common options

ItemDescription
Defaults This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.
Temporary configurations limitSpecify here the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.
Share Select this check box to make the run/debug configuration 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.

This check box is not available when editing the run/debug configuration defaults.

Single instance onlyIf this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, PhpStorm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.

Before launchSpecify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
ItemKeyboard shortcutDescription
/help/img/idea/2017.2/new.png Alt+Insert Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to PhpStorm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in PhpStorm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to run.

    This option is available only if you have already at least one run/debug configuration in the current project.

  • Run File Watchers. Select this option to have PhpStorm apply all the currently active file watchers, see Using File Watchers for details.
  • Run Grunt task. Select this option to run a Grunt task. In the Grunt task dialog box 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 Grunt task. In the Gulp task dialog box 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 check box to execute an npm script. In the NPM Script dialog box that opens, specify the package.json file where the required script is defined, select the script to execute, choose the command to apply to it, and specify the arguments to execute the script with.

    Specify the location of the Node.js interpreter and the parameters to pass to it.

  • Compile TypeScript. Select this option 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 check box to configure the behaviour of the compiler in case any errors are detected:
    • If the Check errors check box is selected, the compiler will show all the errors and the run configuration will not start.
    • If the Check errors check box is cleared, the compiler will show all the detected errors but the run configuration still will be launched.
  • Generate CoffeeScript Source Maps. Select this option to have the source maps for your CoffeeScript sources generated. In the dialog that opens, specify where your CoffeeScript source files are located. For more information, see CoffeeScript.
  • Run Phing target: Add this task to execute the specified Phing target prior to running or debugging. To appoint a Phing target, click the Browse button browse and select the desired target in the Choose Phing Target to Execute dialog box, that opens.
  • Run Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details.
/help/img/idea/2017.2/delete.png Alt+Delete Click this icon to remove the selected task from the list.
/help/img/idea/2017.2/edit1.png Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/help/img/idea/2017.2/arrowUp.png Alt+Up Click this icon to move the selected task one line up in the list.
/help/img/idea/2017.2/arrowDown.png Alt+Down Click this icon to move the selected task one line down in the list.
Show this page Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.
Active tool windowSelect this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.

See Also

See Also

Last modified: 19 July 2017