Run and Debug RSpec Tests Directly from RubyMine

Desired Outcome

Execute and debug RSpec tests inside RubyMine, seeing real‑time results, stack traces, and the ability to pause at breakpoints for state inspection.

Prerequisites

• Ruby SDK – RubyMine must be aware of the Ruby interpreter used by the project. Check File | Project Structure | SDKs and ensure an SDK is listed.
• Gemfile – The rspec gem must be included, typically under the test group:

  group :test do
    gem 'rspec'
  end

• Bundler – Run bundle install so the Gemfile.lock reflects the installed gems.
• RSpec configuration – A spec_helper.rb or rails_helper.rb should exist in the spec directory.

Focused Procedure

1. Open the Test File
   • Navigate to spec/models/user_spec.rb (or any RSpec file).
   • The gutter next to the file name shows a green ▶ icon if the file contains tests.
2. Create or Use a Run Configuration
   • Right‑click the file or a specific it block and select Run ‘RSpec’.
   • RubyMine will open the Run/Debug Configuration dialog. The following fields are most important:
     • Working directory – Usually the project root.
     • RSpec path – Leave blank to use the bundled bundle exec rspec command.
     • Arguments – Add options like --tag focus to run a subset.
     • Environment variables – Set RAILS_ENV=test if needed.
   • Click OK to create the configuration. It will appear under the Run dropdown.
3. Set a Breakpoint
   • Open the test file and click the gutter left of a line inside an it block, e.g., expect(user.valid?).to be true.
   • The red dot indicates a breakpoint; it will be hit when the test runs.
4. Run or Debug
   • Click the Run icon (green triangle) or Debug icon (bug) next to the configuration name.
   • RubyMine launches the test runner. If debugging, the IDE will pause at the breakpoint, opening the Debug tool window.
5. Review Results
   • The Run tool window shows a tree of examples, each colored green (passed) or red (failed). The total count appears at the top.
   • Click a failed example to see the stack trace and highlighted code.
6. Rerun or Debug Again
   • In the Run window, the Rerun button (two arrows) re‑executes the last configuration.
   • The Debug button (bug) starts a fresh debugging session, useful after code changes.

Expected Checks

• Breakpoint Hit – When debugging, the IDE should pause at the breakpoint, displaying variable values in the Variables pane.
• Pass/Fail Count – The Run window should show the same number of tests as defined in the file. A mismatch indicates the test file was not loaded correctly.
• Stack Trace Accuracy – For a failing test, the stack trace should point to the exact line in your test or production code that caused the failure.

Recovery Options

• Configuration Reset – If tests do not run, open Run | Edit Configurations and verify the working directory and arguments. Removing the RSpec path field forces RubyMine to use bundle exec rspec.
• Environment Variable Fix – Missing RAILS_ENV=test can cause tests to run in production mode. Add it in the Environment variables field.
• Gemfile Consistency – If the rspec gem is missing, run bundle install and restart RubyMine to refresh the project SDK.
• Project Sync – Use File | Synchronize to reload the file system and ensure RubyMine sees the latest test files.

Concrete Example

Suppose you have the following test:

require 'rails_helper'

RSpec.describe User, type: :model do
  it 'is valid with a name' do
    user = User.new(name: 'Alice')
    expect(user.valid?).to be true
  end
end

Set a breakpoint on the expect line. Create a run configuration with no special arguments. Run in debug mode. RubyMine should pause at the breakpoint, letting you inspect user in the Variables pane. After stepping over, the test will finish and the Run window will show a green checkmark.

Limitations

• Run configurations are project‑specific. When sharing the project, export the configuration via .run files or commit the .idea directory.
• RSpec options such as --tag must be entered in the configuration’s Arguments field; otherwise they are ignored.
• Debugging is limited to the Ruby interpreter configured for the project. Switching SDKs requires restarting RubyMine.

Practical Verification

1. Create a new RSpec test file as shown above.
2. Set a breakpoint and run in debug mode.
3. Confirm the debugger stops at the breakpoint and the Run window reports one passed test.
4. Delete the name attribute to force a failure and rerun. Verify the failure appears in the Run window with a red exclamation mark.

Conclusion

RubyMine offers a streamlined path to run and debug RSpec tests, combining visual configuration, real‑time debugging, and comprehensive result reporting. By following the steps above, you can quickly identify flaky tests, inspect state at critical points, and iterate faster on your Ruby or Rails codebase.