WebStorm 2016.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 WebStorm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling 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 WebStorm 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 WebStorm 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 the Browse button 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 the Browse button 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 the Browse button 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 WebStorm 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 WebStorm 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 new.png 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 delete.png.

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, WebStorm 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 WebStorm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in WebStorm 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 WebStorm apply all the currently active file watchers, see Using File Watchers for details.
  • 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 Grunt 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 check box to execute an npm script. In the NPM Script dialog box that opens, specify the package.json file where the required script is defined, select the script to execute, choose the command to apply to it, and specify the arguments to execute the script with.

    Specify the location of the Node.js interpreter and the parameters to pass to it.

  • Compile TypeScript. Select 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 check box to configure the behaviour of the compiler in case any errors are detected:
    • If the Check errors check box is selected, the compiler will show all the errors and the run configuration will not start.
    • If the Check errors check box 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 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.
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: 15 November 2016