Run/Debug Configuration: RSpec

Name

Specify the name of the current run/debug configuration.

Mode

Define the scope of tests to run:

• All specs in a folder: Select this option to run all tests in a particular directory.

• Spec script: Select this option to run a specific test.

• Multiple specs: Select this option to run tests from multiple spec files.

Specs folder

Specify the fully qualified path to the directory that contains the desired specs. Alternatively, click and select the specs directory in the dialog that opens.

This field is only available, when the All specs in folder option is selected.

File name mask

Specify the mask of the spec file name, for example, **/*_spec.rb.

This field is only available, when the All specs in folder option is selected.

Spec script

Specify the name of the script to be executed.

This field is only available, when the Spec script option is selected.

Specs

Specify the names of the desired specs. Alternatively, click and select the specs in the dialog that opens.

This field is only available, when the Multiple specs option is selected.

Example names

Specify one or several names of the examples within the script to be executed. Use || to separate example names.

If no example is specified, all examples will be executed.

This field is only available, if either the Spec script or Multiple specs option is selected.

Example IDs/line number

Specify the Unique ID of an example or example group to run or, alternatively, specify the line number with the desired example or example group.

An example ID consists of a combination of the example number and the numbers of example groups that contain it, separated by colons. For instance, if you have a test file with three example groups, the second group contains three examples, and you want to run the first example, its example ID will be [2:1].

Use square brackets when specifying example IDs and separate multiple IDs with commas, such as [1:2:1],[2:3]. To run all examples of a particular group at once, specify the example group number in square brackets, for instance, [2].

To run an example or example group using its line number, specify it without using square brackets.

note

RubyMine does not update line numbers or IDs used in the run/debug configuration automatically. Make sure to update the necessary settings manually when you change your file.

Runner options

Provide additional options to customize RSpec's behavior. Learn more about the available options from Command line.

'rspec' 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 RSpec runner script

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

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.

For more information, refer to Spork DRb.

Output full backtrace

Select this checkbox to enable the --trace option.

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.

Ruby arguments

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

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.

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.

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.

Name

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

Allow multiple instances

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.

AltInsert

Create a run/debug configuration.

AltDelete

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

Ctrl0D

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.