Issue: RubyMine 3.1, Webmock-1.6.2 and “Spec.configure” curse

05.26.2011 00:01 by kbeckman | Comments

I ran into a nasty issue today – an issue that I have no problem saying would have been way past my abilities to resolve given my current status as a Ruby Noobie. Thank goodness for team members who are way more knowledgeable than I am! I’ll try to do my best here to set up the environment context that produced the issue and follow the steps we (“we” is used loosely here because I didn’t help much) used to resolve the issue…

 

Overview

I kept getting a error while trying to use RubyMine’s integrated debugger to test some of the changes I made to a Rails controller class. Here’s the full console output from the RubyMine debugger…

 

/Users/kbeckman/.rvm/rubies/ruby-1.9.2-p180/bin/ruby -e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift) /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/bin/rspec /Users/kbeckman/<ApplicationDir>/spec/controllers/profile_controller_spec.rb --require teamcity/spec/runner/formatter/teamcity/formatter --format Spec::Runner::Formatter::TeamcityFormatter
Testing started at 9:28 PM ...
/Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/webmock-1.6.2/lib/webmock/rspec.rb:23:in `<top (required)>': undefined method `configure' for Spec::Runner:Module (NoMethodError)
    from /Users/kbeckman/<ApplicationDir>/spec/spec_helper.rb:4:in `require'
    from /Users/kbeckman/<ApplicationDir>/spec/spec_helper.rb:4:in `<top (required)>'
    from /Users/kbeckman/<ApplicationDir>/spec/controllers/profile_controller_spec.rb:1:in `require'
    from /Users/kbeckman/<ApplicationDir>/spec/controllers/profile_controller_spec.rb:1:in `<top (required)>'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/configuration.rb:388:in `load'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/configuration.rb:388:in `block in load_spec_files'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/configuration.rb:388:in `map'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/configuration.rb:388:in `load_spec_files'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/command_line.rb:18:in `run'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/runner.rb:55:in `run_in_process'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/runner.rb:46:in `run'
    from /Users/kbeckman/.rvm/gems/ruby-1.9.2-p180/gems/rspec-core-2.3.1/lib/rspec/core/runner.rb:10:in `block in autorun'
Empty test suite.

Process finished with exit code 1

 

Investigation

Below is the /webmock-1.6.2/lib/webmock/rspec.rb where the actual exception was being thrown… And here’s why:

a) On line 4, “RSpec” was defined but “RSpec:Expectations” was undefined and the code ran to line 6.

b) On line 6, “Spec” was defined so the contents of the elsif block were executed where some global RSpec variables are set to whatever webmock thinks they should be. This a technique that dynamic languages use to swap out existing functionality for some entirely different implementation. No need for IoC Containers here!

c) The code continues to execute running over the else block (what we really wanted to have execute) and runs to line 23.

d) On line 23, the code blows up because of “undefined method ‘configure’ for Spec::Runner:Module (NoMethodError)”

 

require 'webmock'

# RSpec 1.x and 2.x compatibility
if defined?(RSpec) && defined?(RSpec::Expectations)
  RSPEC_NAMESPACE = RSPEC_CONFIGURER = RSpec
elsif defined?(Spec)
  RSPEC_NAMESPACE = Spec
  RSPEC_CONFIGURER = Spec::Runner
else  
  begin
    require 'rspec/core'
    require 'rspec/expectations'
    RSPEC_NAMESPACE = RSPEC_CONFIGURER = RSpec
  rescue LoadError
    require 'spec'
    RSPEC_NAMESPACE = Spec
    RSPEC_CONFIGURER = Spec::Runner
  end
end

require 'webmock/rspec/matchers'
  
RSPEC_CONFIGURER.configure { |config|

  config.include WebMock::API
  config.include WebMock::Matchers

  config.after(:each) do
    WebMock.reset!
  end
}

WebMock::AssertionFailure.error_class = RSPEC_NAMESPACE::Expectations::ExpectationNotMetError

 

So why did this happen? It turns out that somewhere in RubyMine, a “Spec::Runner” is defined and it doesn’t have the configure() method that we need. If you look at some of the very first heinous highlight above from the stack trace, you’ll notice that RubyMine is using a --require” and “--formatter” command line arguments. The “--require" argument tells Ruby to load whatever is in that directory. I’m not going to go into all of the details, but it has something to do with output formatting for use with JetBrains’ CI server, TeamCity. Whatever is in that directory is causing our problem by defining a “Spec::Runner” before webmock can load a replacement.

 

Resolution

Fixing the issue required a slight modification to the /webmock-1.6.2/lib/webmock/rspec.rb listed above. Here’s our fully modified file. Please note the heinous highlight… We added a check to determine whether or not the “Spec.configure” method was defined since this was the one that was previously throwing the exception. Now the code evaluates “Spec.configure” as undefined and falls through to execute the else block where webmock successfully sets up its requirements using the “Spec” definition from RSpec instead of whatever was in the teamcity/spec/runner/formatter/teamcity/formatter directory. If you’re curious as to what that was in RubyMine’s internals causing the issue, help yourself with the following command. Please note your RubyMine location might differ from mine…

 

cd ~/applications/RubyMine\ 3.1.1.app/rb
grep -R Spec **

 

require 'webmock'

# RSpec 1.x and 2.x compatibility
if defined?(RSpec) && defined?(RSpec::Expectations)
  RSPEC_NAMESPACE = RSPEC_CONFIGURER = RSpec
elsif defined?(Spec) && defined?(Spec.configure)
  RSPEC_NAMESPACE = Spec
  RSPEC_CONFIGURER = Spec::Runner
else  
  begin
    require 'rspec/core'
    require 'rspec/expectations'
    RSPEC_NAMESPACE = RSPEC_CONFIGURER = RSpec
  rescue LoadError
    require 'spec'
    RSPEC_NAMESPACE = Spec
    RSPEC_CONFIGURER = Spec::Runner
  end
end

require 'webmock/rspec/matchers'
  
RSPEC_CONFIGURER.configure { |config|

  config.include WebMock::API
  config.include WebMock::Matchers

  config.after(:each) do
    WebMock.reset!
  end
}

WebMock::AssertionFailure.error_class = RSPEC_NAMESPACE::Expectations::ExpectationNotMetError

 

So, we’re not quite done yet… We’ve fixed the issue by forcing the setup block in the webmock rspec.rb file to execute, but as soon as we run “bundle install” or “gem update webmock” or any of the other countless ways you could probably update webmock’s code we’ll more than likely get the same issue. To make sure that doesn’t happen, we did the following:

a) Copy the entire /webmock-1.6.2 directory our project was originally sourcing the code from into a customization folder we keep per-project. Our new location for webmock is ../<ApplicationDirectory>/vendor/gems/webmock-1.6.2.

b) Edit the project’s gemfile so webmock is sourced from the edited copy rather than a directory that can be easily overwritten/updated. Our gemfile changes for webmock are below… I’ve commented out the old reference for our new location.

c) Make sure you “$ git commit -a” your webmock source directory…

 

...

group :test do
  #gem 'webmock'
  gem 'webmock', :path => "#{File.expand_path(__FILE__)}/../vendor/gems/webmock-1.6.2"
end

...

 

I hope this helps!!!

Choosing [Cross-Platform] Development Tools…

05.25.2011 06:30 by kbeckman | Comments

If you had asked me a few months ago where my allegiances fell in software development, I would have quickly told you (without giving much thought) on the Microsoft stack of technologies. Fast forward a few months and I’m in week 3 of my first consulting gig and the only Microsoft applications I use on a daily basis are Office 2011 for Mac and a instance of Windows Server 2008 R2 running in VMware Fusion to host SQL Server 2008 R2 . Instead of Windows 7, TFS and Visual Studio 2010, my daily development experience includes OSX Snow Leopard, JetBrains RubyMine, Git and a shit-ton of command line utilities.

 

A lot can change in a few months…

 

Working as a consultant, you have to get up and running quickly no matter what you’re working on or what technology stack you are working with. That’s probably one of the primary reasons you were hired in the first place. If you’re slow out of the gate, it could cost your client some serious dollars and cost you some of your hard-earned Street Cred. One thing you absolutely do not want to waste time on is learning new tools - chances are you’ll have enough other things to worry about. So the first lesson I’ve learned while expanding my technology stack for a while is that I need to be more diligent and evaluate cross-platform capabilities while I’m evaluating new software tools.

 

Here’s a short list of the tools I recently said goodbye to in favor of a cross-platform replacement… Thankfully I was familiar with all but one of them from prior projects. They just weren’t my tools of choice until now. I also threw in a couple that were already my primary tools that should be mentioned anyway because of their cross-platform support.

 

DiffMerge over WinMerge

This one hurt the most… I used WinMerge each day and actually made it my diff tool of choice in Visual Studio overriding the crappy default offering. WinMerge and I go way back to all-weekend release branch code merges where Visual Source Safe was the source control provider (and didn’t help you much with the process). I had almost every shortcut key combo memorized and had enhanced the experience considerably through custom configurations over many years of use. I’m really going to miss this one, but DiffMerge is here to stay for a while… DiffMerge runs on everything and I currently have it installed on Windows 7, Windows Server 2008 R2, Ubuntu Desktop and Mac OS X Snow Leopard. Installing on Ubuntu is a little tricky, but it can be done.

 

Someday WinMerge might rise again… There is a team of developers working on WinMerge 3 – a cross platform port of WinMerge using Qt.

 

Git Bash & gitk over GitExtensions

I give GitExtensions full credit as the tool that helped me conquer the Git workflow allowing me to begin using it in my personal projects. GitExtensions is by far the best Windows Git GUI tool that I’ve used… It integrates nicely with Visual Studio and adheres to the Git workflow and repository structure. GitExtensions is exactly what you need if you aren’t quite ready for command line Git. Supposedly there are a few folks out there that can get GitExtensions running on Ubuntu with some additional Mono packages, but I’m not one of them. I gave ‘er hell, but decided it was just better to move to the command line. Heck, half of my development is done from the command line now anyway. What’s one more tool…?

 

Firefox & Chrome over IE

It’s been a long time since IE has been my default browser and most of the time I’ve just kept it around for SharePoint sites and the Outlook Web Access. This one though is a no-brainer… IE9 is nice, fast and the developer tools are good, but there’s no sense spending a lot of time with it if you might find yourself on another development stack. You’ll probably need to keep IE around in a VM if you don’t develop on Windows just to make sure all of your styling and JavaScript functions properly, but I don’t think it’s worth the trouble for anything else.

 

Soon I’m soon going to be saying the same kind of things about Firefox too if they don’t get the JavaScript debugger working in 4.0.x.

I’ll leave Safari support up to the QA team.

 

VirtualBox over Any Other Client Virtualization Software

Virtual Box is easily one of the best free tools out there… On my Windows machines, I still Boot2VHD (and probably always will), but VirtualBox has been my client virtualization utility for quite some time now and I love it… In addition to it’s own VDI virtual disk format, it will run VHD virtual disks so there’s no reason to use Virtual PC (ever again). I’ll use VMware if someone else is paying for it and require me to use it.