WebStorm 2017.1 Help

Testing JavaScript with Mocha

The Mocha test framework supports executing unit tests against the Node.js server. The tests themselves can use BDD, TDD, Exports, and QUnit interfaces.

On this page:

Before you start

  1. Make sure the Node.js runtime environment is installed on your computer.
  2. Make sure the NodeJS plugin is enabled. The plugin is bundled with WebStorm and activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Installing Mocha

Open the built-in WebStorm Terminal (press Alt+F12 or choose View | Tool Windows | Terminal on the main menu) and at the command line prompt type npm install --global mocha for global installation or npm install --save-dev mocha to install Mocha as a development dependency.
See NPM documentation for more details about installing the Mocha test runner and npm operation modes. You can also install the mocha package on the Node.js and NPM page of the Settings dialog box as described in Node Package Manager (npm).

Quick test launch

You can run and debug Mocha tests and suites right from the editor: click run.png or rerun.png in the left gutter and choose Run <test_file_name> or Debug <test_file_name> from the pop-up list.

ws_run_test_from_editor.png

You can also see whether a test has passed or failed right in the editor, thanks to the test status icons ws_icon_test_status.png in the left gutter.

Creating a Mocha run/debug configuration

  1. Open the Run/Debug Configuration dialog box by doing one of the following:
    • On the main menu, choose Run | Edit Configurations.
    • Open the test file in the editor, and then choose Create <file name> on the context menu.
    • Select the test file in the Project tool window, and then choose Create <file name> on the context menu of the selection.

    Click the Add button /help/img/idea/2017.1/new.png on the toolbar and select the Mocha configuration type. The Run/Debug Configuration: Mocha dialog box opens.

  2. Specify the Node interpreter to use and the location of the mocha package.
  3. Specify the working directory of the application. All references in test scripts will be resolved relative to this folder, unless such references use full paths.

    By default, the field shows the project root folder. To change this predefined setting, choose the desired folder from the drop-down list, or type the path manually, or click the Browse button browseButton.png and select the location in the dialog box, that opens.

  4. Specify the tests to run:
    • All in directory: choose this option to run all the tests from files stored in a folder. In the Test directory field, specify the folder with the tests. To have WebStorm look for tests in the subfolders under the specified directory, select the Include subdirectories check box.
    • File pattern: choose this option to have WebStorm look for tests in all the files with the names that match a certain mask and specify the mask in the Test file pattern field.
    • Test file: choose this option to run only the tests from one file and specify the path to this file in the Test file field.
    • Suite: choose this option to run individual suites from a test file. In the Test file field, specify the file where the required suites are defined. Click the Suite name field and configure a list of suites to run. To add a suite to the list, click addRoot.png and type the name of the required suite. To remove a suite, select it in the list and click minusSign.png
    • Test: choose this option to run individual tests from a test file. In the Test file field, specify the file where the required tests are defined. Click the Test name field and configure a list of tests to run. To add a test to the list, click addRoot.png and type the name of the required test. To remove a test, select it in the list and click minusSign.png
  5. Choose the interface used in the test to run.

Launching tests via a run/debug configuration

  1. To launch the tests according to a run configuration, select the Mocha run/debug configuration from the list on the main toolbar and click the Run button /help/img/idea/2017.1/run.png to the right of the list.
    ws_select_run_configuration.png
  2. The test server starts automatically without any steps from your side. View and analyze messages from the test server in the Run tool window.
  3. Monitor test execution in the Test Runner tab of the Run tool window as described in Monitoring and Managing Tests.

See Also

Last modified: 17 July 2017