RubyMine 2018.3 Help

Run/Debug Configuration: RSpec

Use this dialog box to define run/debug configuration for a RSpec test.

In this section:

Configuration tab

Item

Description

Name

In this text box, specify the name of the current run/debug configuration.

Mode

Click one of the radio buttons to define the scope of tests to be performed:
  • All specs in a folder: Click this radio button, if you want to run all tests in a directory.

  • Spec script: Click this radio button, if you want to run the specified test script.

All specs in folder

Click this radio button, if you want to run all tests in a directory.

Specs folder

Specify the fully qualified path to the directory that contains the desired specs, or click browseButton 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.

Example name

Specify the name of the example within the script to be executed. If no example is specified, all examples will be executed.
This field is only available, when the Spec script option is selected.

Runner options

Enter runner options (spec --help).

'rspec' gem

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 browseButton, and select the desired runner in the dialog that opens.

Use pre-loaded server

From the drop-down list, select the server to be used for executing scripts or examples.
Select None if you want to execute a test script or example locally, without any server.

Refer to Executing Tests on DRb Server or Executing Tests on Zeus Server for details.

Output full backtrace

Select this check box to enable the --trace option.

Working directory

Specify the current directory to be used by the running task. By default, the project directory is used as a working directory.

Environment variables

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 box.

Ruby arguments

Specify the arguments to be passed to the Ruby interpreter.

Classpath property is added to Nailgun settings.

Ruby SDK

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

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 check boxes 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 check box to have the previous content of the selected log skipped.

Save console output to file

Select this check box 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 check box 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 check box to activate the output console and bring it forward if an associated process writes to Standard.err.

icons general add svg

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.

icons actions edit svg

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

icons general remove svg

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

browseButton.png

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

Bundler tab

Item

Description

Run the script in the context of the bundle

If this check box is selected, the script in question will be executed as specified in the gemfile.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

Item

Description

icons general add

Click this button to define the scope of code coverage analysis. In the Add Pattern dialog box 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 check box next to a pattern. By default, all newly created patterns are enabled.

icons general remove svg

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

icons actions edit svg

Click this button to change the selected code coverage pattern.

Do not use the optimized C runtime

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

Enable coverage in test folders.

If this check box is selected, the folders marked as test root_Test.png are included in the code coverage analysis.

Nailgun tab

Item

Description

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

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

When a run/debug configuration, with this check box 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 check box is not selected, then the script is launched in a usual way, without Nailgun.

Common options

When you edit a run configuration (but not a run configuration template), you can specify the following options for it:

Item

Description

Name

In this text box, 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

Select this checkbox to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea \runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

Allow running in parallel

When disabled, every time a new run/debug configuration is launched, RubyMine checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this checkbox is selected, it is possible to launch as many instances of the run/debug configuration as required. So doing, each runner will start in its own tab of the Run Tool Window or Debug Tool Window.

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

icons general add svgAlt+Insert

Create a run/debug configuration.

icons general remove svgAlt+Delete

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

Copy

Ctrl+D

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

Edi Templates

Edit Templates

View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.

icons actions moveUp svg/icons actions moveDown svg

Alt+Up/Alt+Down

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

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 Folder, 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-and-drop or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations

Sort configurations

Click this button to sort configurations in the alphabetical order.

Templates

Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.

When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:

Item

Description

Configurations available in Run Dashboard

In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations.

Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Thus, if you add a configuration type for which no configurations exist in the project, this type will not be displayed on the dashboard until you create a configuration of this type.

Confirm rerun with process termination

The behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration.
  • If this checkbox is selected, in case of a single instance, launching a new process (for example, by clicking Run on the main toolbar) while another process is still running, results in showing a dialog box prompting to terminate the current process before launching a new one.

  • If this checkbox is not selected (or in case of multiple instances), RubyMine starts the new process silently.

Temporary configurations limit

Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.

Before Launch options

In this area you can specify tasks that must be be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

Item

Shortcut

Description

icons general add svgAlt+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 Configuring Third-Party Tools and External Tools.

  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

  • 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 box 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 box 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 box 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 Add, 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 Browse, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    runConfigRakeTask
  • 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).

icons general remove svgAlt+Delete

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

Edit

Enter

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

icons actions moveUp svg/icons actions moveDown svg

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

If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, 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.

Last modified: 6 December 2018

See Also