I use RubyMine and Vagrant for my Rails development and run RSpec specs from RubyMine for convenience. The problem is that every time I start rspec, it takes a few seconds to connect to the box, before actually doing anything. This is especially annoying when running single spec which should be fast.
vagrant ssh is slow to connect
% time vagrant ssh -c whoami vagrant Connection to 10.211.55.45 closed. 2,57s user 0,73s system 82% cpu 3,984 total
That’s probably because
vagrant ssh-config takes most of that time to sort things out:
% time vagrant ssh-config > /dev/null 2,53s user 0,79s system 77% cpu 4,269 total
When researching this issue, some people mention DNS or other Vagrant provider specific issues, but they complain of an order of magnitude slower (30-40 sec) connection. Might just be that I have everything set up correctly and it just takes that much time to get the configuration.
But what this means is that if you run RSpecs from RubyMine, they are slow to start, because RubyMine executes
vagrant ssh-config every time (RUBY-16186).
Direct SSH to the rescue
Fortunately, direct SSH with keypair authentication is blazing fast:
time ssh email@example.com -i ~/.ssh/parallels_key whoami vagrant 0,01s user 0,01s system 21% cpu 0,114 total
So, to take advantage of that you need to:
- set up SSH configuration
- configure RubyMine remote ruby over SSH, not Vagrant
- Add RubyMine helpers to
RUBYLIBto be able to start persistent
Set up SSH configuration
Vagrant might be using their
vagrant_insecure_private_key for the SSH or, in my case, Parallels custom keypair, as I don’t use VirtualBox. So run this command to find out which key is in use:
% vagrant ssh-config Host default HostName 10.211.55.45 User vagrant Port 22 UserKnownHostsFile /dev/null StrictHostKeyChecking no PasswordAuthentication no IdentityFile /Users/laas/project/.vagrant/machines/default/parallels/private_key IdentitiesOnly yes LogLevel FATAL
Now we know the IP address of the box and what keyfile is used. For easier access, I symlinked the key file to my
ln -s IdentityFile /Users/laas/project/.vagrant/machines/default/parallels/private_key ~/.ssh/parallels_key
You can try out SSH connection:
ssh firstname.lastname@example.org -i ~/.ssh/parallels_key whoami vagrant
Configure RubyMine to use remote ruby over SSH
Next step is to configure new Ruby SDK for the project. Open Preferences and navigate Language & Frameworks > Ruby SDK and Gems, click + button and pick New remote…. Then fill in the data as shown in the screenshot and when closing dialog, ensure that the newly added ruby is selected as active.
Now specs should still run (but take several seconds every time to boot up Rails, because
spring is shut down after every connection).
Note: I actually use landrush to manage development boxes names and so I can configure remote ruby with a domain name and not worry about IP address changes when recreating the devbox.
Add RubyMine helpers to RUBYLIB
The problem above is that
spring closes itself down every time SSH connection is closed. One could start a long-running
spring from terminal SSH, but that would result in RubyMine complaining that it can not load teamcity formatter:
cannot load such file -- teamcity/spec/runner/formatter/teamcity/formatter (LoadError)
This is because RubyMine injects a special formatter into rspec so that it can parse the output better. Thanks to Oleg at Jetbrains (RUBY-16324) I discovered that the required formatters are present in the vagrant box and all I need is to add them to ruby load path, before starting
So, I added following lines to my
# RubyMine-RUBYLIB if [[ -d "$HOME/.rubymine_helpers" ]] then export RUBYLIB=$HOME/.rubymine_helpers/rb/testing/patch/common/:$HOME/.rubymine_helpers/rb/testing/patch/bdd/:$RUBYLIB fi
This sets up
RUBYLIB variable with RubyMine helpers. I skipped over
testunit folder, as I do not use that, but feel free to add that also if you need it.
Let the specs fly
Now, just SSH into your Vagrant box, start Spring, e.g. by running:
And then RubyMine can re-use the already running Spring server to speed itself up.