RubyMine 2021.2 Help

Run/Debug Configuration: Test::Unit/Shoulda/MiniTest

Use this dialog to define run/debug configuration for a Test::Unit, Shoulda, or Minitest test.

The dialog has the following tabs:

Configuration tab

ItemDescription
NameSpecify the name of the current run/debug configuration.
Mode

Define the scope of tests to run:

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

  • Test scripts: Select this option to run tests from one or several specified test files.

  • Test method: Select this option to run an individual method of a test class.

Test folder

Specify the fully qualified path to the directory that contains the desired tests. Alternatively, click the Browse button and select the test directory in the dialog that opens.

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

Test file name mask

Specify the mask for a test filename, for example: **/{*_test,test_*}.rb.

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

Ruby scripts

Specify one or multiple fully qualified paths to the desired tests. Alternatively, click the Browse button and select one or multiple test files in the dialog that opens.

This field is only available, when the Test scripts option is selected.

Ruby script

Specify the fully qualified path to the test that contains the method you want to run. Alternatively, click the Browse button and select the test file in the dialog that opens.

This field is only available, when the Test method option is selected.

Test name filter

Type a filtering expression or the name of a test method. The test name filter can be a regular expression.

This field is only available, when the Test method option is selected.

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.

Runner optionsSpecify the options to be passed to the test runner.
Working directorySpecify 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 the Browse button 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.

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:

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

Classpath property is added to Nailgun settings.

Ruby SDKSpecify 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

ItemDescription
Run the script in the context of the bundle ('bundle exec')

Select one of the options:

  • Enabled: Select this option to run your code with bundle exec. In this case, RubyMine will use the gem versions specified in your Gemfile.

  • Auto-detection: Select this option to let RubyMine automatically detect if it is possible to run your code with bundle exec.

  • Disabled: Select this option to disable the use of bundle exec when running your code.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

ItemDescription
the Add button

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.

the Add buttonClick this button to delete the selected pattern from the list.
the Edit buttonClick this button to change the selected code coverage pattern.
Do not use the optimized C runtimeSelect 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 root_Test.png are included in the code coverage analysis.

Nailgun tab

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

ItemDescription
Is ActiveSelect 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 ContentSelect this checkbox to have the previous content of the selected log skipped.
Save console output to fileSelect 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 streamSelect 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 streamSelect this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.
the Add buttonClick this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
the Edit buttonClick this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
the Delete buttonClick this button to remove the selected log entry from the list.
the Browse buttonClick 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:

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to 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 to stop the running instance and start another one. This is helpful when a run/debug 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.

ItemShortcutDescription
the Add buttonAlt+InsertCreate a run/debug configuration.
the Remove buttonAlt+DeleteDelete the selected run/debug configuration. Note that you cannot delete default configurations.
CopyCtrl+DCreate a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe 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

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

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

Sort configurations 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.

ItemShortcutDescription
the Add buttonAlt+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 External 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 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 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 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 the Browse button, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    Code completion for the Rake tasks

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

the Remove buttonAlt+DeleteClick this icon to remove the selected task from the list.
EditEnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/ Method downAlt+Up/ Alt+DownClick 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 pageSelect 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.

Last modified: 28 October 2021