Run/Debug Configuration: RSpec
Use this dialog to define run/debug configuration for a RSpec test.
Before you start working with Ruby, make sure that Ruby plugin is installed and enabled. Press Ctrl+Alt+S, go to Plugins and inspect the Installed tab to ensure the plugin is enabled.
Also make sure that the following prerequisites are met:
Ruby SDK is downloaded and installed on your machine.
The required framework SDKs are downloaded and installed on your machine.
For more information, refer to their respective download and installation pages:
Specify the name of the current run/debug configuration.
Define the scope of tests to run:
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.
Specify the name of the script to be executed.
This field is only available, when the Spec script option is selected.
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.
Specify one or several names of the examples within the script to be executed. Use
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
Use square brackets when specifying example IDs and separate multiple IDs with commas, such as
To run an example or example group using its line number, specify it without using square brackets.
Provide additional options to customize RSpec's behavior. Learn more about the available options from Command line.
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.
Output full backtrace
Select this checkbox to enable the
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.
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.
Specify the command-line arguments to be passed to the Ruby interpreter.
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.
Log File Entry
The read-only fields in this column list the log files to show. The list can contain:
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.
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.
Choose coverage runner
Select the desired code coverage runner.
By default, IntelliJ IDEA uses its own coverage engine with the Sampling mode. You can also choose JaCoCo for calculating coverage.
Select this option to measure code coverage with minimal slow-down.
Select this option to collect accurate branch coverage. This mode is available for the IntelliJ IDEA code coverage runner only.
Track per test coverage
Select this checkbox to detect lines covered by one test and all tests covering line. If this checkbox is selected, becomes available on the toolbar of the coverage statistic popup.
For more information, refer to Set coverage in run configurations.
Packages and classes to record code coverage data
Click and select Add Class or Add Package to specify classes and packages to be measured. You can also remove classes and packages from the list by selecting them in the list and clicking the button.
Enable coverage in test folders
If this checkbox is selected, the folders marked as test are included in the code coverage analysis.
When you edit a run configuration (but not a run configuration template), you can specify the following options:
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, IntelliJ IDEA 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 IntelliJ IDEA stores run configuration settings in .idea/workspace.xml.
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.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
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.
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.
Click this icon to add one of the following available tasks:
Click this icon to remove the selected task from the list.
Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
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
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.