WebStorm 2021.1 Help

Run/Debug Configuration: JSTestDriver

Run | Edit Configurations | Add New Configuration | JSTestDriver

This page describes the configuration-specific items as well as options that are common for all run/debug configurations. To learn how to use this configuration, see JSTestDriver.

In this dialog, 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.

Configuration tab

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

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 list. This choice determines the set of other controls in the area.

ItemDescriptionAvailable for
Test

In this 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 field, specify the folder to look for test runner configuration files in. Type the path manually or click Browse the Browse button and select the required folder in the dialog, that opens.

All configuration files in directory
Matched configuration filesThis 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 fileIn this field, specify the test runner configuration file to use. Type the path manually or click Browse the Browse button and select the required file in the dialog that opens.Configuration file
JS test fileIn this field, specify the JavaScript files with tests to be executed. Type the path manually or click Browse the Browse button and select the required file in the dialog, that opens.JavaScript test file
Case
Method
CaseIn this field, type the name of the target case from the specified JavaScript file.Case
Method
MethodIn this field, type the name of the target method from the specified test case within the specified JavaScript file.Method

Server tab

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

ItemDescription
At addressChoose this option to have the test execution handles by a remote test server. In the field, specify the URL address to access the server through.
Running in IDEChoose 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 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 the Add button 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 the Remove button.

Common

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

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, WebStorm suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and WebStorm stores run configuration settings in .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
the Add buttonAlt+InsertCreate a run/debug configuration.
the Remove buttonAlt+DeleteDelete the selected run/debug configuration. Note that you cannot delete default configurations.
CopyCtrl+DCreate a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
Move into new folder / Create new 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, click Folder, and specify the 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 or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations Click this button to sort configurations in the alphabetical order.

Before Launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

ItemShortcutDescription
the Add buttonAlt+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 WebStorm yet, add its definition. For more information, see External 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 WebStorm apply all the currently active File Watchers.

  • Run Grunt task: select this option to run a Grunt task.

    In the Grunt task dialog 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 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 that opens, specify the npm run/debug configuration settings.
  • 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.

the Remove buttonAlt+DeleteClick this icon to remove the selected task from the list.
EditEnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/ Method downAlt+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

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window is hidden. 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: 04 August 2021