Cucumber.js
Cucumber.js is a test framework for behavior driven JavaScript development. Cucumber.js tests are written in the human-readable Gherkin language and are stored in feature files that have the feature
extension. PhpStorm integrates with Cucumber.js and recognizes features written in Gherkin so you can run Cucumber,js test right from the IDE.
Before you start
Download and install Node.js.
Install the Cucumber.js and Gherkin repository plugins on the Plugins page as described in Managing Plugins.
Installing Cucumber.js
- Open the built-in PhpStorm Terminal (Alt+F12) 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
Select a test file in the Project tool window and choose Create <file name> on the context menu. 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.Specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.
In the Cucumber package field, specify the path to the folder where the
cucumber
package is stored or the location of thecucumber-js.cmd
,cucumber-js.bat
, or other executable depending on your operating system.- Optionally:
In the Name Filter text box, type the name of a specific scenario to run instead of all the scenarios from the feature file or directory.
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.
Navigation
With PhpStorm, 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.