PhpStorm 2024.3 Help

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

  1. To work with Cucumber.js versions 6.0.0+, make sure you are using PhpStorm 2020.3.1 or later.

  2. Download and install Node.js.

  3. Make sure the JavaScript and TypeScript and Gherkin required plugins are enabled on the Settings | Plugins page, tab Installed. For more information, refer to Managing plugins.

  4. Install and enable the Cucumber.js plugin on the Settings | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains Marketplace.

Install Cucumber.js

Create test definitions

With PhpStorm, you can write step definitions both in JavaScript and in TypeScript. PhpStorm detects and highlights the steps where definitions are missing and suggests a quick-fix to generate them.

  1. Place the caret at the step without a definition, press Alt+Enter, and select Create step definition or Create all step definitions.

    Create Cucumber.js step definitions: quick-fix

    Alternatively, hover over the step and use the links in the popup.

    Creating Cucumber.js step definitions: invoke actions from the pop-up

  2. In the dialog that opens, specify the name for the new file and the language to write the definitions in.

    Creating Cucumber.js step definitions: choose language version

    If such file already exists, PhpStorm displays a popup where you have to select a file to add the definition to or choose to create a new file.

    Creating Cucumber.js step definitions: select target file

Run tests

Cucumber.js tests are launched only through a run/debug configuration.

Create a Cucumber.js run configuration

  1. Open the Run/Debug Configuration dialog (Run | Edit Configurations in the main menu), click the Add button in the left-hand pane, and select Cucumber.js from the list. The Run/Debug Configuration: Cucumber.js dialog opens.

  2. In the Feature file or directory field, 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.

  3. Specify the Node.js interpreter to use.

    If you choose the Project alias, PhpStorm will automatically use the project default interpreter from the Node interpreter field on the Node.js page . In most cases, PhpStorm detects the project default interpreter and fills in the field itself.

    You can also choose another configured local or remote interpreter or click the Browse button and configure a new one.

  4. In the Cucumber package field, specify the path to the folder where the cucumber package is stored.

  5. Specify the working directory of the application. By default, the Working directory field shows the project root folder. To change this predefined setting, specify the path to the desired folder.

  6. Optionally:

    • In the Name Filter field, 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 more information, refer to native built-in help available through the cucumber-js --help command.

    • In the Environment variables field, specify the environment variables for your application.

Run tests via a run configuration

  1. Select the Cucumber.js run/debug configuration from the list of configurations and click the Run icon   in the list or on the toolbar.

  2. Monitor test execution and analyze test results in the Test Runner tab of the Run tool window. For more information, refer to Explore test results.

Run tests from a test file

  • To run a single test, open the test file in the editor, place the caret at the scenario to run, and then select Run Scenario: <scenario name> from the context menu.

  • To run all tests from a single test file, open the test file in the editor or select it in the Project tool window and choose Run <test filename> from the context menu.

In either case, PhpStorm creates a run/debug configuration which you can save and use later.

Debug tests

Debug tests via a run configuration

  1. Select the Cucumber.js run/debug configuration from the list of configurations and click the Debug icon   in the list or on the toolbar.

  2. Monitor test execution and analyze test results in the Test Runner tab of the Run tool window. For more information, refer to Explore test results.

Debug tests from a test file

  • To debug a single test, set the breakpoints where necessary, place the caret at the scenario to debug, and then select Debug Scenario: <scenario name> from the context menu.

  • To debug all tests from a single test file, open the test file in the editor or select it in the Project tool window and choose Debug <test filename> from the context menu.

In either case, PhpStorm creates a run/debug configuration which you can save and use later.

Run and debug tests written in TypeScript

  1. Create a Cucumber.js run/debug configuration as described above.

  2. In the Before launch area, click the Add button, select Compile TypeScript from the list, and then specify the tsconfig.json file to use. PhpStorm will run the TypeScript compiler with this tsconfig.json before running Cucumber.js.

    Cucumber.js Run configuration: adding a Compile TypeScript Before launch task

  3. To debug tests written in TypeScript, open your tsconfig.json and set "sourceMap": true to enable source maps.

With PhpStorm, you can jump between a file and the related test file or from a test result in the Test Runner Tab to the test.

  • To jump between a test and its subject or vice versa, open the file in the editor and select Go to | Test or Go to | Test Subject from the context menu, or just press Ctrl+Shift+T.

  • To jump from a step in a .feature file to the step definition, press and hold Ctrl, hover over the step, and click the step when it turns into a link.

    Cucumber.js: Navigate from a step to its definition

  • To jump from a test result to the test definition, click the test name in the Test Runner tab twice, or select Jump to Source from the context menu, or just press F4. The test file opens in the editor with the caret placed at the test definition.

Configure syntax highlighting

You can configure Cucumber.js-aware syntax highlighting according to your preferences and habits.

  1. In the Settings dialog (Ctrl+Alt+S) , go to Editor | Color Scheme | Cucumber.

  2. Select the color scheme, accept the highlighting settings inherited from the defaults or customize them as described in Colors and fonts.

Last modified: 26 September 2024
Testing JavaScriptJest