Run/Debug Configuration: Cucumber Ruby
Use this dialog to define run/debug configuration for Cucumber features.
The dialog has the following tabs:
Configuration tab
Item | Description |
---|---|
Mode | Click one of the radio buttons to define the scope of features:
|
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. |
Element name filter | RubyMine will execute the feature elements with the names that contain matching substrings |
Tags filter | Specify the tags to be considered on running tests |
Runner options | Enter runner options. |
'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 |
Show the files and features loaded | Select this checkbox to enable the |
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. 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 Now this setting is not used any more. If defining the environment variable |
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:
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. |
Bundler tab
Item | Description |
---|---|
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:
|
Code Coverage tab
Use this tab to configure code coverage monitoring options.
Item | Description |
---|---|
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 |
Enable coverage in test folders. | If this checkbox is selected, the folders marked as test are included in the code coverage analysis. |
Nailgun tab
Item | Description |
---|---|
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 this checkbox is not selected, then the script is launched in a usual way, without Nailgun. |
Logs tab
Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.
Item | Description |
---|---|
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:
|
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. |
Common settings
When you edit a run configuration (but not a run configuration template), you can specify the following options:
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. |
Toolbar
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Item | Shortcut | Description |
---|---|---|
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. |
Before launch
In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Click this icon to add one of the following available tasks:
| |
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. |