IntelliJ IDEA 14.0.0 Web Help

Run/Debug Configuration: PHPUnit

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

Running PHPUnit tests requires the following prerequisites to be fulfilled:

The dialog box consists of the following areas:

Click here for the description of the options that are common for all run/debug configurations.

Test Runner

In this area, specify the unit tests to launch and the command line switches to be passed to the test runner.

Item Description
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 text box, specify the directory to search the unit test 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.

  • Class: select this option to have all the unit tests in a test class launched.
    1. In the File text box, specify the file to search the class in. Type the path to the file manually or click the Browse button browseButton.png and select the desired directory in the Choose Test File 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.
  • Method: select this option to have a specific test method launched.
    1. In the File text box, specify the file to search for the test method 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 method.
  • Defined in the configuration file: select this option to have test runner execute the tests from a dedicated XML file. Specify the XML file to use in the Configuration file text box.
Configuration file In this text box, specify the XML file with additional test runner configuration options and possibly definitions of tests to execute.

When such file is specified, its configuration options override the default test runner configuration settings. If you have selected the Defined in the configuration file option in the Test scope area, the tests to execute are also taken from this file.

Type the path manually or click the Browse button browseButton.png and appoint the desired file in the Choose Test File dialog box, that opens.

Bootstrap file In this text box, specify the PHP script to be always executed before launching tests. Type the path manually or click the Browse button browseButton.png and select the desired folder in the dialog that opens.
Test runner options In this text box, specify the test runner switches.

If necessary, click shift-enter-button and type the desired switches in the Command Line Options dialog box. Type each switch on a new line. When you close the dialog box, the specified switches are displayed in the Test runner options text box with spaces as separators.

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.

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 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 for the NodeJS executable file, if applicable. Click the Browse button browseButton.png to the right of the field and configure a list of variables in the Environment Variables dialog box, that opens:
  • To define a new variable, click the Add toolbar button add.png and specify the variable name and value.
  • To discard a variable definition, select it in the list and click the Delete toolbar button delete.png.
  • Click OK, when ready

The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators. The acceptable variables are:

NODE_PATH A :-separated list of directories prefixed to the module search path.
NODE_MODULE_CONTEXTS Set to 1 to load modules in their own global contexts.
NODE_DISABLE_COLORS Set to 1 to disable colors in the REPL.

Toolbar

Item Shortcut Description
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 defaults Click 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.

folder Move into new folder / Create new folder Use this button to create a new folder.

If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created.

Move run/debug configurations to a folder using drag-and-drop, or the arrowUp arrowDown buttons.

sortAlphabetically Sort configurations Click this button to sort configurations in alphabetical order.

Common Options

Item Description
Name In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.
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.
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 .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.

If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.

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

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

Every time a new run/debug configuration is launched, IntelliJ IDEA 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 make sense, when 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 launch Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
Item Keyboard shortcut Description
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 IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Build Artifacts. Select this option to have an artifact or artifacts built. In the dialog that opens, select the artifact or artifacts that should be built.

    See also, Configuring Artifacts.

  • Run Ant target. Select this option to have an Ant target run. In the dialog that opens, select the target to be run. For more information, see Ant.
  • 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 Maven Goal. Select this option to have a Maven goal run. In the dialog that opens, select the goal to be run.

    For more information, see Maven.

  • 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.

See Also

Last modified: 12 November 2014
comments powered by Disqus