JavScript unit tests are run in a browser against a test server which actually handles the testing process.
This server allows you to capture a browser to run tests in, loads the test targets to the captured browser, controls the testing process, and exchanges data between the browser and WebStorm, so you can view test results without leaving the IDE.
The test server does not necessarily have to be on your machine, it can be launched right from WebStorm through the Karma test runner. Cucumber.js runs tests that are called features and are written in the Gherkin language. Each feature is described in a separate file with the extension feature.
On this page:
Download and install Node.js. The framework is required for two reasons:
- The transpiledLanguage toolType is started through Node.js.
- NPM, which is a part of the framework, is also the easiest way to download the transpiledLanguage toolType.
For details on using Node.js in WebStorm, see the section Node.js
If you are going to use the command line mode, make sure the following paths are added to the PATH variable:
- The path to the parent folder of the Node.js executable file.
- The path to the npm folder.
This enables you to launch the transpiledLanguage toolType and npm from any folder.
- Make sure the Cucumber.js test runner is installed as described in Preparing to Use Cucumber.Js Test Runner.
- Make sure the Node.js plugin is enabled. The plugin is bundled with WebStorm and activated by default. If it is not, enable it as described in Enabling and Disabling Plugins.
- Make sure the Cucumber.js and Gherkin plugins are enabled. The plugins are bundled with WebStorm and activated by default. If not, enable them as described in Enabling and Disabling Plugins.
Open the Run/Debug Configuration dialog box by doing one of the following:
- On the main menu, choose .
- Press RunConfigurationRunConfigurationRunConfigurationRunConfigurationRunConfigurationRunConfigurationRunConfigurationRunConfigurationRunConfigurationRunConfigurationRunConfiguration and choose Edit Configuration on the context menu.
- 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 on the toolbar and select the Cucumber.js configuration type. The Run/Debug Configuration:Cucumber.Js dialog box opens.
In the Feature file or directory text box, specify the tests to run.
Cucumber.js runs tests that are called features
and are written in the Gherkin language. Each feature is described in a separate file
with the extension feature.
- To have one feature executed, specify the path to the corresponding .feature file.
- To have a bunch of features executed, specify the folder where the .feature files to run are stored.
- In the Executable path text box, specify the location of the cucumber executable file, .cmd, .bat, or other depending on the operating system used. The location depends on the installation mode, see Installing the Cucumber.js test runner.
specify the command line arguments to be passed to the Cucumber.js executable file, such as -r (--require LIBRARY|DIR),
-t (--tags TAG_EXPRESSION), or --coffee.
For details, see Cucumber's native built-in help available through the following command:
- Apply the changes and close the dialog box.
To launch the tests according to a run configuration, select the Cucumber.js run/debug configuration from the list on the main toolbar.
Then click the Run button to the right of the list.
- The test server starts automatically without any steps from your side. View and analyze messages from the test server in the Run tool window.
- Monitor test execution in the Test Runner tab of the Run tool window as described in Monitoring and Managing Tests.