Cucumber.js

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

2. Make sure you have Node.js on your computer.

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

4. Make sure the Gherkin plugin is enabled in the settings. Press Ctrl+Alt+S to open the IDE settings and select Plugins. Click the Installed tab. In the search field, type Gherkin. For more details about plugins, see Managing plugins.

• In the embedded Terminal (Alt+F12) , type one of the following commands:

  • 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.

  See also Cucumber.js demo on the Cucumber.js official website.

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

   

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

   

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

   

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

   

   Gif

Create a Cucumber.js run configuration

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

   tip

   To create a run/debug configuration for all the tests in a single test file, select Run <test filename> from its context menu.

   To create a run/debug configuration for one scenario, select Create Scenario:<Scenario_name> from its context menu in the editor.

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. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.

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 or choose a previously used folder from the list.

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 details, see native built-in help available through the cucumber-js --help command.

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

   tip

   If you create a run/debug configuration for one scenario (Create Scenario:<Scenario_name>), PyCharm fills in the name of the scenario in the Name Filter field automatically.

Run tests via a run configuration

1. Select the Cucumber.js run/debug configuration from the list on the main toolbar and click  to the right of the list.

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 and analyze test results in the Test Runner tab of the Run tool window, see Explore test results for details.

Run and debug tests from a test file

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

• To run or 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 Run <test filename> or Debug <test filename> from the context menu.

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

• 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.

  

  Gif

• 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 cursor placed at the test definition.

1. In the Settings/Preferences 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.