Run/Debug Configuration: Cucumber Ruby

Mode

Click one of the radio buttons to define the scope of features:

• All features in a folder: Click this option, if you want to run all features in a directory.

• Feature file: Click this option, if you want to run the specified feature only.

Feature folder

Specify the fully qualified path to the directory that contains the desired features, or click and select the features directory in the dialog that opens. This field is only available, when the All features in folder option is selected.

Feature file

Specify the name of the script to be executed.

tip

This field is only available, when the Feature file option is selected.

Element name filter

RubyMine will execute the feature elements with the names that contain matching substrings -n, --name NAME.

Tags filter

Specify the tags to be considered on running tests -t, --tags TAGS.

Runner options

Enter runner options.

note

It is important to note that step definitions that reside outside the Features directory, can be skipped by RubyMine, and the tests will fail to run. If you want to make use of the step definitions located elsewhere, you have to specify the required directory with the step definition files, or individual step definition files. To do that, add -r <file or directory name> to the Runner options field.

If the path to a step definition file or directory is relative, it is relative to the Working directory defined in this run/debug configuration.

'cucumber' gem

Use this list to select the desired gem version, which will be used to run the tests. The list shows the versions that are available in the Ruby SDK. By default, the latest available version is taken.

Use custom Cucumber runner script

Select this checkbox if you want to use an alternative Cucumber runner script. You can type the fully qualified path to the Cucumber runner script in the text field, or click , and select the desired runner script in the dialog that opens.

Output full backtrace

Select this checkbox to enable the --trace option.

Show the files and features loaded

Select this checkbox to enable the -v, --verbose option.

Use pre-load server

From the list, select the server to be used for executing scripts or examples.

Select None if you want to execute a script or example locally, without any server.

tip

If both Zeus and Spork DRb servers are running simultaneously, it is Zeus that gets priority.

If a pre-loaded server is already running, it will be selected from the list.

Note that Cucumber features can be run under Zeus server up to version 0.13.4.pre2.

Refer to Spork DRb for details.

Working directory

Specify the working directory used by the running task. For example, this option is in effect when the running script loads other scripts by relative paths.

Environment variables

Specify the list of environment variables as the name-value pairs, separated with semi-colons. Alternatively, click to create variables and specify their values in the Environment Variables dialog.

Formerly, the environment variable RAILS_ENV has been implicitly set to cucumber, if the user has not explicitly set any other value of this variable.

Now this setting is not used any more. If defining the environment variable RAILS_ENV is required, the Cucumber default run/debug configuration should be edited.

Ruby arguments

Specify the command-line arguments to be passed to the Ruby interpreter.

When such a run/debug configuration is launched, RubyMine analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:

• If there is no running Nailgun server, or if there is a Nailgun server on a non-default port, or with a different gemset, then RubyMine suggests to specify the desired port number.

• If a Nailgun server runs on the default port with the required gemset, RubyMine does nothing.

• If a Nailgun server runs on a different port with the required gemset, then RubyMine suggests to specify the desired port number.

• If a Nailgun server runs on the default port with a different gemset, then RubyMine deletes the --ng argument.

Classpath property is added to Nailgun settings.

Ruby SDK

Specify the desired Ruby interpreter. You can choose the project default Ruby SDK, or select a different one from the list of configured Ruby SDKs.

Run the script in the context of the bundle ('bundle exec')

Running the script with Bundler ensures that the gem versions specified in the Gemfile will be used. Select one of the options:

• Auto-detection: select this option to run your code with bundle exec when it is possible.

  note

  When the Auto-detection option is enabled, RubyMine checks whether the following conditions are met:

  • Gemfile and Gemfile.lock are present

  • The version of the bundler gem specified in Gemfile.lock is also installed in the run/debug configuration's SDK

  In case either of these conditions isn't met, the executed command will remain without any changes.

• Disabled: select this option to disable the use of bundle exec.

Click this button to define the scope of code coverage analysis. In the Add Pattern dialog that opens, type the comma-delimited list of Ruby regular expressions, and specify whether the matching files should be included into or excluded from code coverage analysis.

The patterns defining files to be included into code coverage analysis, are marked with +; the ones to be excluded are marked with -.

Each pattern can be enabled or disabled. To do that, select or clear the checkbox next to a pattern. By default, all newly created patterns are enabled.

Click this button to delete the selected pattern from the list.

Click this button to change the selected code coverage pattern.

Do not use the optimized C runtime

Select this checkbox to enable the option --no-rcovrt. Use this option with discretion, since it significantly slows down performance.

Enable coverage in test folders.

If this checkbox is selected, the folders marked as test are included in the code coverage analysis.

Run new instance of the Nailgun server, or use already started one

This checkbox is only available for JRuby used as the project interpreter.

When a run/debug configuration, with this checkbox selected, is launched, RubyMine analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:

• If there is no running Nailgun server, or if there is a Nailgun server on a non-default port, or with a different gemset, then RubyMine suggests to specify the desired port number.

• If a Nailgun server runs on the default port with the required gemset, RubyMine does nothing.

• If a Nailgun server runs on a different port with the required gemset, then RubyMine suggests to specify the desired port number.

• If a Nailgun server runs on the default port with a different gemset, then RubyMine deletes the -ng argument.

If this checkbox is not selected, then the script is launched in a usual way, without Nailgun.

Is Active

Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.

Log File Entry

The read-only fields in this column list the log files to show. The list can contain:

• Full paths to specific files.

• Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

  If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip Content

Select this checkbox to have the previous content of the selected log skipped.

Save console output to file

Select this checkbox to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.

Show console when a message is printed to standard output stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.

Show console when a message is printed to standard error stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.

Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.

Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.

Click this button to remove the selected log entry from the list.

Click this button to edit the select log file entry. The button is available only when an entry is selected.

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow parallel run

Allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, RubyMine suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and RubyMine stores run configuration settings in .idea/workspace.xml.

Alt+Insert

Create a run/debug configuration.

Alt+Delete

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Ctrl+D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons.

To remove grouping, select a folder and click .

Click this button to sort configurations in the alphabetical order.

Alt+Insert

Click this icon to add one of the following available tasks:

• Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in RubyMine yet, add its definition. For more information, see External tools and External Tools.

• Run Another Configuration: select to execute another run/debug configuration and wait until it finishes before starting the current configuration. If you want to run several configurations in parallel, use a compound run/debug configuration.

• Run File Watchers: select this option to have RubyMine apply all the currently active File Watchers.

• Run Grunt task: select this option to run a Grunt task.

  In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

  Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

• Run gulp task: select this option to run a Gulp task.

  In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

  Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

• Run npm script: select this option to execute an npm script.

  In the NPM Script dialog that opens, specify the npm run/debug configuration settings.

• Start React Native Bundler: select this option to run the bundler automatically, as part of a running or debugging session. By default, this is done through react-native start.

  If your application uses Expo, you need to run the development server via the start npm task. To do that, click , then in the Configure React Native dialog, choose npm script and select start from the list.

• Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

  • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

  • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

• Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

• Upload files to Remote Host: select this option to have the application files automatically uploaded to the server according to the default server access configuration.

• Run Remote External Tool: adds a remote SSH external tool.

• Run Rake task: add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button , and select the desired task from the list of available tasks.

  Note that code completion is available here.

  

• Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).

Alt+Delete

Click this icon to remove the selected task from the list.

Enter

Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.

/

Alt+Up/Alt+Down

Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.

Show this page

Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.

Activate tool window

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.