PhpStorm 10.0 Help

Run/Debug Configuration:Behat

This dialog box is available only when the PHP and Behat plugins are installed and enabled. The plugins are not bundled with PhpStorm, but they can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins. Once enabled, the plugins are available at the IDE level, that is, you can use it in all your PhpStorm projects.

Use this dialog box to create a configuration to be used for running and debugging unit tests on PHP applications using the Behat framework.

Running Behat tests requires the following prerequisites to be fulfilled:

The dialog box consists of the following areas:

Test Runner

In this area, specify the scenarios to launch and the command line switches to be passed to Behat.

ItemDescription
Test scope In this area, specify the location of scenarios or the configuration file where they are listed.
  • Directory: select this option to have all the scenarios in a directory launched.

    In the Directory text box, specify the directory to search for .feature files with scenarios 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 scenarios in a specific .feature file launched.
    1. In the File text box, specify the .feature file to search the scenarios in. Type the path to the file manually or click the Browse button browseButton.png and select the desired directory in the dialog box, that opens.
    2. In the Class text box, specify the desired class. Type the class name manually or click the Browse button browseButton.png and select the desired class in the tree view, that opens.
  • Scenario: select this option to have a specific scenario launched.
    1. In the File text box, specify the .feature file to search for the 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 Scenario text box, specify the desired scenario.
  • Defined in the configuration file: select this option to have Behat execute the tests from a dedicated .yaml configuration file. Specify the .yaml file to use in the Configuration file text box.

    By default, Behat uses the configuration file appointed in the Test Runner area of the Behat. In its turn, this can be either the behat.yaml file, for which Behat searches in the project root or in the config folder, or any other .yaml configuration file which you specified as Default during the initial configuration of Behat in PhpStorm.

    • To have the default for all Behat run configurations file used, clear the Use alternative configuration file check box.
    • To launch scenarios from a custom configuration file, select the Use alternative configuration file check box and specify the location of the desired .yaml file in the text box next to it.
    • To open the Behat page and specify another default configuration file to use, click the settings button.

Command Line

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 shift-enter-button 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 text box, specify the location of the files that are outside the folder with tests and are referenced in your tests through relative paths. Type the path manually or click the Browse button browseButton and select the desired folder in the dialog that opens.

This settings does not block the test execution because the location of tests is always specified through a full path to the corresponding files and/or directories.

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
add Alt+Insert Click this button to add a new configuration to the list.
delete Alt+Delete Click this button to remove the selected configuration from the list.
copy Ctrl+D Click this button to create a copy of the selected configuration.
settings Edit defaultsClick this button to edit the default configuration templates. The defaults are used for newly created configurations.
arrowUp or arrowDown 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.

sortAlphabetically 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
add 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 File Watchers. Select this option to have PhpStorm apply all the currently active file watchers, see Using File Watchers for details.
  • 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 Support.
  • 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.
delete Alt+Delete Click this icon to remove the selected task from the list.
edit1 Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+Up Click this icon to move the selected task one line up in the list.
arrowDown 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: 23 December 2015