PhpStorm 2018.2 Help

Run/Debug Configuration: JSTestDriver

In this dialog box, create a configuration to be used for running JavaScript unit tests in the browser against a JSTestDriver server. Configurations of this type enable running unit tests based on the JSTestDriver Assertion, Jasmine, and QUnit frameworks.

The dialog box is available when the JSTestDriver plugin is activated. The plugin is not bundled with PhpStorm, but it can be installed from the JetBrains plugin repository as described in Managing Plugins.

On this page:

Configuration tab

In this tab, specify the tests to run, the configuration files to use, and the server to run the tests against.

Test

In this area, tell PhpStorm where to find the tests to execute and how to get test runner configuration files that define which test files to load and in which order. The main approaches are:

  • Specify the location of one or several previously created configuration files.
  • Point at the target test file, test case, or test method, and then specify the location of the corresponding configuration file.
The way to find tests and configuration files is defined in the Test drop-down list. This choice determines the set of other controls in the area.

ItemDescriptionAvailable for
Test In this drop-down list, specify how PhpStorm will get test runner configuration files.
  • All configuration files in directory: select this option to use all the test runner configuration files in a specific folder.
  • Configuration file: select this option to use a specific test runner configuration file.
  • JavaScript test file: select this option to have tests from a specific file executed using one of the previously defined configuration files.
  • Case: select this option to run a specific test case using one of the previously defined configuration files.
  • Method: select this option to run a specific test method using one of the previously defined configuration files.
Directory In this text box, specify the folder to look for test runner configuration files in. Type the path manually or click Browse browseButton.png and select the required folder in the dialog box, that opens. All configuration files in directory
Matched configuration files This read-only field shows a list of all the *jstd and JSTestDriver.conf test runner configuration files detected in the specified folder. All configuration files in directory
Configuration file In this text box, specify the test runner configuration file to use. Type the path manually or click Browse browseButton.png and select the required file in the dialog box that opens. Configuration file
JS test file In this text box, specify the JavaScript files with tests to be executed. Type the path manually or click Browse browseButton.png and select the required file in the dialog box, that opens. JavaScript test file
Case
Method
Case In this text box, type the name of the target case from the specified JavaScript file. Case
Method
Method In this text box, type the name of the target method from the specified test case within the specified JavaScript file. Method

Server

In this area, appoint the test server to run tests against.

ItemDescription
At address Choose this option to have the test execution handles by a remote test server. In the text box, specify the URL address to access the server through.
Running in IDE Choose this option to have test execution handles through the JSTestDriver server that comes bundled with PhpStorm and can be launched from it.
Test Connection Click this button to check that the specified test server is accessible.

The server must be running. Start the server from PhpStorm or manually, according to the server-specific instructions.

Debug tab

In this tab, appoint the browser to debug the unit test in when two or more browsers are captured simultaneously.

ItemDescription
Debug From this drop-down list, choose the browser to debug the specified tests in when two browsers are captured at a time. The available options are:
  • Chrome
  • Firefox

Coverage tab

In this tab, specify the files that you do not want to be involved in coverage analysis.

ItemDescription
Exclude file path In this area, create a list of files to be skipped during coverage analysis.
  • To add an item to the list, click the Add button icons general add svg and choose the required file in the dialog that opens.
  • To delete a file from the list so coverage is measured for it, select the file and click the Remove button icons general remove svg.

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.

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.

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.

icons actions newFolder svg 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, click folder, and specify folder name. 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 the alphabetical order.

Templates

Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.

When you select the Templates node itself, you will be able to adjust general settings that apply to 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 — a tool window that helps you execute and manage multiple run/debug configurations.

Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Thus, 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 option is selected for a particular run/debug configuration.
  • If this checkbox is selected, in case of a single instance, launching a new process (for example, by clicking icons toolwindows toolWindowRun 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), PhpStorm starts the new process silently.
Temporary configurations limit Specify 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 must be be performed before starting the selected run/debug configuration. The 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 to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in PhpStorm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
  • Run File Watchers: select this option to have PhpStorm apply all the currently active file watchers.
  • 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 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.
  • Run Phing target: add this task to execute the specified Phing target prior to running or debugging. To appoint a Phing target, click Browse browse and select the desired target in the dialog that opens.
  • Compile TypeScript: select 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.
  • Run Remote External tool: adds a remote SSH external tool.
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: 21 September 2018

See Also