PhpStorm 2016.1 Help

Run/Debug Configuration: PHPUnit by HTTP

Use this dialog box to configure running unit tests of PHP applications on a remote server.

PHP unit testing requires the following prerequisites to be fulfilled:

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

The dialog box contains the following tabs and areas:

Configuration Tab

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

ItemDescription
Test In this area, specify the location of tests or the configuration file where they are listed.
  • All in 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.

  • All in File: select this option to have all the unit tests in a test class or a file launched. In the File text box, specify the file to search the class or suite 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.
  • Class or Suite: select this option to have all the unit tests in a test class or a test suite launched.
    1. In the File text box, specify the file to search the class or suite 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.
  • XML file: select this option to have test runner execute the tests from an XML configuration file.

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

    • To have the default for all PHPUnit 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 XML file in the text box next to it.
    • To open the PHPUnit page and specify another default configuration file to use, click the settings button.
Test Runner options
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 setting 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.

Test Groups Tab

In this tab, appoint the groups of tests to execute when the tests are run according to the current run configuration.

Grouping tests is helpful, for example, to distinguish between tests to run in a production environment from those to run in your development environment. You just need to create two groups and then include or exclude them depending on the current environment.

To attach a test to a group, tag it with the @group annotation in the format:

/** @group <group specification> */
To enable filtering tests based on their authors, tag the tests with the @author annotation.

ItemDescription
Include/Exclude groups Select this check box to enable configuring execution of test groups.
Group Name In this read-only list, select the test group to be involved or skipped in testing.
Include Select this check box to have the tests from the selected test group executed.
Exclude Select this check box to have the tests from the selected test group skipped.

Remote

In this tab, configure deployment of tests to a remote server.

ItemDescription
Debug server In this field, specify the configuration through which the debugging engine will interact with the server through HTTP. Actually, a configuration consist of a URL address of the target environment, the debugger type, and possibly mappings between folders in your project and their correspondences on the server.

Choose a configuration from the drop-down list or click the Browse button browseButton and define a new configuration in the Servers dialog box that opens.

Upload test directory before run
  • When this check box is selected, PhpStorm automatically uploads tests to the default server according to the deployment options.
  • When the check box is cleared, you have to upload tests manually, see Uploading and Downloading Files.
The check box is by default selected.
Remove test files after run
  • When this check box is selected, PhpStorm automatically removes the executed tests from the server upon execution.
  • When the check box is cleared, tests remain on the server after execution and you will have to download them manually, see Uploading and Downloading Files.
Show transfer logsSelect this check box to have test deployment logged.

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

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 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.
  • 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.
  • 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. For more information, see Configuring Synchronization with a Web Server and Uploading and Downloading Files.
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

Last modified: 12 July 2016