PhpStorm 8.0.0 Web Help

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.

Item Description
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 a dedicated XML file. Specify the XML file to use in the Use XML configuration file text box.
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.

Note

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.

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.

Item Description
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.

Item Description
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 logs Select this check box to have test deployment logged.

Toolbar

Item Shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertCtrl+N or Alt+InsertAlt+InsertAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this button to add a new configuration to the list.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this button to remove the selected configuration from the list.
copy Ctrl+DCtrl+DCtrl+DCtrl+DMeta+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCommand DCommand DCommand 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+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpControl UpControl UpControl Alt Up or Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownControl DownControl DownControl 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.

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.

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+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter 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.
  • 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+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this icon to remove the selected task from the list.
edit1 EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpControl UpControl UpControl Alt Up Click this icon to move the selected task one line up in the list.
arrowDown Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownControl DownControl DownControl 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

Concepts:

Procedures:

Reference:

Web Resources: