Cucumber.js
WebStorm supports integration with the Cucumber.js test framework. WebStorm recognizes features written in the Gherkin language.
On this page:
Before you start
- Make sure the Node.js runtime environment is installed on your computer.
- Make sure the Node.js, Cucumber.js, and Gherkin plugins are enabled.
Installing Cucumber.js
Open the built-in WebStorm Terminal (press Alt+F12 or choose on the main menu) and type one of the following commands at the command prompt:
-
npm install cucumber
for local installation in your project. -
npm install -g cucumber
for global installation. -
npm install --save-dev cucumber
to install Cucumber.js as a development dependency.
Running tests
Cucumber.js tests are launched only through a run/debug configuration.
To create a Cucumber.js run configuration
- Open the Run/Debug Configuration dialog box ( on the main menu).
- Click on the toolbar and select Cucumber.js from the list. The Run/Debug Configuration: Cucumber.js dialog box opens.
- In the Feature file or directory text box, specify the tests to run. Type the path to a specific
.feature
file or to a folder, if you want to run a bunch of features. - In the Executable path text box, specify the location of the
cucumber-js.cmd
,cucumber-js.bat
, or other depending on your operating system. The location depends on the installation mode. - Optionally, specify the command line arguments to be passed to the executable file, such as
-r
(--require LIBRARY|DIR
),-t
(--tags TAG_EXPRESSION
), or--coffee
. For details, see native built-in help available through thecucumber-js --help
command.
To run tests via a run configuration:
- Select the Cucumber.js run/debug configuration from the list on the main toolbar and click 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.
Navigation
With WebStorm, you can jump between a file and the related test file. Navigation from a test result in the Test Runner Tab to the test is also supported.
To jump between a file and the related test file
Open the file in the editor and choose or on the context menu, or just press Ctrl+Shift+T.
To jump from a test result to the test
Select the test name in the Test Runner tab and choose Jump to Source on the context menu. The test file opens in the editor with the cursor placed at the test definition.