pallinder / rails-test-runner

Extension for Visual studio code to run your specs from within vscode

Rails Test Runner README

Run your rails tests smoothly from within Visual Studio Code

Quickly run your tests

Run them through menus as well

Project goal

To allow users to easily and quickly run either individual tests or the whole test suite in a rails project no matter if they use minitest, rspec or cucumber.

Features

The extension currently only supports rspec but should eventually support the most popular test runners.

Configuration

railsTestRunner.rspecCommand

Configures what command will be used to execute the tests

• Type: string
• Default: bundle exec rspec

railsTestRunner.clearTerminal

If set to true (default) the terminal will be cleared on each new run.

• Type: boolean
• Default: true

railsTestRunner.focusTerminal

If set to true (default) the terminal will be focused when a test run is being initiated

• Type: boolean
• Default: true

railsTestRunner.railsTestRunner.rspec.failFast

If set to true rspec will be run with --fail-fast meaning that execution will stop after first failed test is encountered (great to use in combination with running only failed tests)

• Type: boolean
• Default: false

Features

The extension currently only supports rspec but should eventually support the most popular test runners.

Run all tests in the currently opened file

cmd-shift-p railsTestRunner.runAllTestsInFile

Or select the option via the context menu

Run tests on current line

cmd-shift-p railsTestRunner.runTestAtLine

Or select the option via the context menu

Run last test(s)

cmd-shift-p railsTestRunner.runLastTests

Run all tests in current folder

Right click on folder in explorer menu and select Rails Test Runner: Run all tests in folder

Run all tests

cmd-shift-p railsTestRunner.runAllTests

Run only failing tests

For this to work you need to also configure your rspec setup to support saving the last failures to a text file. Please take a look at: https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures

After that is done simply run the command and you should only be running failed tests. cmd-shift-p railsTestRunner.runLastFailedTests

Keybindings

To change your keyboard shortcuts, paste the rules in Code -> Preferences -> Keyboard Shortcuts -> keybindings.json:

{
  "key": "cmd+shift+f",
  "command": "railsTestRunner.runAllTestsInFile"
},
{
    "key": "cmd+shift+l",
    "command": "railsTestRunner.runTestAtLine"
},
{
    "key": "cmd+shift+y",
    "command": "railsTestRunner.runLastTests"
},
{
    "key": "cmd+shift+r",
    "command": "railsTestRunner.runLastFailedTests"
},

Todo

• Support rspec
• Support minitest
• Support cucumber

rails-test-runner's Issues

Environment issue when using rbenv.

So the workaround I've found when having multiple ruby versions installed (OS X) with rbenv is to set the runner command like this:

{
    "railsTestRunner.rspecCommand": " /Users/me/.rbenv/shims/ruby bin/rails test"
}

Any other way to get VS Code to use the correct shell environment when running this or other Tasks?

New tests not being run and getting odd error "command 'python.refreshTests' not found"

I installed the extension yesterday and it rescued me from this and ran my tests. Today I have added another file of tests but they remain undiscovered. When I click the second of the two refresh buttons I get the VSCode error "command 'python.refreshTests' not found", whcih is odd given that this is all Ruby.

How can it work with test runner inside docker?

My development environment is inside docker, so are there any way can this plugin work with rspec inside the docker?

Uncaught TypeError: Cannot read property 'closeMessage' of undefined

👋 I'm on Code Version 1.33.0 (1.33.0) and Rails Test Runner 0.0.4, and the runner isn't working anymore. This is my first code issue, so please ask for any info you need that I didn't provide!

Doesn't work anymore

Great extension but freeze on terminal for a month now. Related to VsCode update i would guess.

Run test in external terminal

Hi,

Thanks for your extension, I'd really appreciate to be able to get it to run the specs in iTerm, any idea how I might be able to configure rails-test-runner to do so please?

Best,

Romain

Customize the command when running the tests

Would be nice to customize the way that we wanna run the tests.

In my case, I've been using bin/rspec path_to_the_test instead of bundle exec rspec path_to_the_test.

We could have the default as bundle exec rspec, but that could be customizable.