Run/Debug Configuration: RSpec
Use this dialog to define run/debug configuration for a RSpec test.
In this section:
- Configuration tab
- Logs tab
- Bundler tab
- Code Coverage tab
- Nailgun tab
- Before Launch
Before you start working with Ruby, make sure that Ruby plugin is installed and 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.
Refer to their respective download and installation pages for details:
In this field, specify the name of the current run/debug configuration.
|Click one of the radio buttons to define the scope of tests to be performed: |
All specs in folder
Select this option, if you want to run all tests in a directory.
Specify the fully qualified path to the directory that contains the desired specs, or 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.
Specify the name of the example within the script to be executed. If no example is specified, all examples will be executed.
Enter runner options
Use this drop-down 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-loaded server
From the list, select the server to be used for executing scripts or examples.
Refer to Executing Tests on DRb Server for details.
Output full backtrace
Select this checkbox to enable the
Specify the current directory to be used by the running task. By default, the project directory is used as a working directory.
Specify the list of environment variables as the name-value pairs, separated with semi-colons. Alternatively, click the ellipsis button to create variables and specify their values in the Environment Variables dialog.
Specify the arguments to be passed to the Ruby interpreter.
Classpath property is added to Nailgun settings.
Specify the desired Ruby interpreter. You can opt to 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
If this checkbox is selected, the script will be executed as specified in the Gemfile.
Code Coverage tab
Use this tab to configure code coverage monitoring options.
Choose coverage runner
Select the desired code coverage runner.
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.
Refer to the sectionConfigure code coverage options.
Packages and classes to record code coverage data
Click and buttons 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.
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, IntelliJ IDEA 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.
When you edit a run configuration (but not a run configuration template), you can specify the following options:
In this field, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example, from the Run popup Shift+Alt+F10.
Share through VCS
Select this checkbox to put the run/debug configuration under version control and make it available to other team members.
If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.
If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.
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.
View and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and used for newly created configurations.
Move the selected run/debug configuration up and down in the list.
The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.
Default templates of run/debug configurations are always sorted alphabetically.
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 that must 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 isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.