IntelliJ IDEA 2018.2 Help

Run/Debug Configuration: PHPUnit by HTTP

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

Before you start

To run PHPUnit tests:

  1. Install and configure the PHPUnit tool on your computer, see http://www.phpunit.de/manual/current/en/installation.html.
  2. Make sure the PHP plugin is installed and enabled. The plugin is not bundled with IntelliJ IDEA, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

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 Browse 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 Browse 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 Browse 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 Browse 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 Browse 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 the test runner execute the tests from an XML configuration file.
    • To use the default configuration file specified on the Test Frameworks page of the Settings dialog, clear the Use alternative configuration file checkbox. If no default configuration file is appointed on the PHPUnit page, the run/debug configuration is invalid.
    • To run the tests from a custom configuration file, select the Use alternative configuration file checkbox and specify the location of the file to use in the text box.
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 Browse 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 checkbox 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 checkbox to have the tests from the selected test group executed.
Exclude Select this checkbox to have the tests from the selected test group skipped.

Remote tab

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 Browse browseButton and define a new configuration in the Servers dialog box that opens.

Upload test directory before run
  • When this checkbox is selected, IntelliJ IDEA automatically uploads tests to the default server according to the deployment options.
  • When the checkbox is cleared, you have to upload tests manually, see Uploading and Downloading Files.
The checkbox is by default selected.
Remove test files after run
  • When this checkbox is selected, IntelliJ IDEA automatically removes the executed tests from the server upon execution.
  • When the checkbox 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 checkbox to have test deployment logged.

Common options

When you edit a run configuration (but not a run configuration template), you can specify the following options for it:

ItemDescription
Name In this text box, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example. from the Run popup (Shift+Alt+F10).
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.

Toolbar

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

ItemShortcutDescription
icons general add svgAlt+InsertCreate a run/debug configuration.
icons general remove svgAlt+Delete Delete the selected run/debug configuration. Note that you cannot delete default configurations.
icons actions copy svg Ctrl+D Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
icons general settings svg Edit Templates View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.
icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+Down

Move the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

folder Move into new folder / Create new folder

You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category to be grouped, click folder, and specify the name for the folder. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag-and-drop or icons actions moveUp svg and icons actions moveDown svg buttons.

To remove grouping, select a folder and click icons general remove svg.

icons objectBrowser sorted svg Sort configurations Click this button to sort configurations in alphabetical order.

Templates

When you select Templates in the tree view of the run configurations, you can adjust some settings that apply for all run debug configurations.

ItemDescription
Configurations available in Run Dashboard

In this section you can create a list of run configurations available in the Run Dashboard — tool window that helps you execute and manage multiple run/debug configurations.

Note that the dashboard will only display those configuration types for which you have created one ore more configurations.
So if you add a configuration type for which no configurations exist in the project, this type will not be displayed on the dashboard until you create a configuration of this type.

Confirm rerun with process terminationThe behavior of this checkbox depends on whether the Single instance only checkbox is selected for a particular run/debug configuration.
  • If this checkbox is selected, then, in case of a single instance, launching a new process (for example, by clicking run on the main toolbar) while another process is still running, results in showing a dialog box prompting to terminate the current process before launching a new one.
  • If this checkbox is not selected (or in case of multiple instances), IntelliJ IDEA starts the new process silently.
Temporary configurations limit Specify here the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.

Before Launch options

In this area you can specify tasks that should be carried out before starting the selected run/debug configuration. The specified tasks are performed in the order they appear in the list.

ItemShortcutDescription
icons general add svgAlt+Insert Click this icon to add one of the following available tasks:
  • 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 build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built.
  • Run Another Configuration — select this option to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
  • Run Ant target — select this option to run an Ant target. In the dialog that opens, select the target to be run.
  • 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 Gulp 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 Maven Goal — select this option to run a Maven goal. In the dialog that opens, select the goal to be run.
  • Run npm Script — select this option to execute an npm script. In the NPM Script dialog box that opens, specify the npm run/debug configuration settings.
  • Compile TypeScript — elect 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 checkbox to configure the behaviour of the compiler in case any errors are detected:
    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.
    • If the Check errors checkbox 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 generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.
  • 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.
  • Run Remote External tool — adds a remote SSH external tool.
  • Run Rake task — add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button browseButton, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    runConfigRakeTask
  • Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
icons general remove svgAlt+Delete Click this icon to remove the selected task from the list.
icons actions edit svg Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+DownClick these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)
Show this pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window

If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.

Last modified: 18 June 2018

See Also