Cleaner failure messages?

rogerdpack · June 19, 2010, 11:12pm

Hi all.
Sorry if this is an old request…

Currently when a failure is reported it looks like this:

C:\dev\ruby\faster_rubygems\spec>spec
spec.faster_rubygems_cacheing.rb
F

RuntimeError in ‘FasterRubyGems cacheing Gem.bin_path should cache and
reload Gem.bin_path where possible’
assertion failed
C:/dev/ruby/faster_rubygems/spec/spec.faster_rubygems_cacheing.rb:
14:in `block (3 levels) in <top (required)>’

This is good because it tells me what line failed, but that’s about
it.

The skinny of this request is that I’d find it more useful to actually
have the code displayed that failed on line 14, in this case, the word
“fail”

so like this:
C:/dev/ruby/faster_rubygems/spec/spec.faster_rubygems_cacheing.rb:14:
“fail”
Instead of the current
C:/dev/ruby/faster_rubygems/spec/spec.faster_rubygems_cacheing.rb:
14:in `block (3 levels) in <top (required)>’

So the failure report is good, but could be improved.
Another option would be to display the line below what is currently
output, like

C:/dev/ruby/faster_rubygems/spec/spec.faster_rubygems_cacheing.rb:
14:in `block (3 levels) in <top (required)>’
fail

Or something like that.
Any thoughts there?
Thanks.
-rp

rogerdpack · June 19, 2010, 11:18pm

On Jun 19, 2010, at 3:54 PM, rogerdpack wrote:

RuntimeError in 'FasterRubyGems cacheing Gem.bin_path should cache and
“fail”
output, like

C:/dev/ruby/faster_rubygems/spec/spec.faster_rubygems_cacheing.rb:
14:in `block (3 levels) in <top (required)>’
fail

Or something like that.
Any thoughts there?
Thanks.

Already done in rspec-2. Likely won’t backport it to rspec-1 for some
time (if ever).

Cheers,
David

rogerdpack · June 22, 2010, 9:25am

The skinny of this request is that I’d find it more useful to actually
have the code displayed that failed on line 14, in this case, the word
“fail”
…
Already done in rspec-2. Likely won’t backport it to rspec-1 for some time (if ever).

Nice. Looks like rspec-2 will fit the bill for me for now, then.

Gem speeding Gem.bin_path the fake sick way should fake guess the
right path instead of loading full rubygems for now
Failure/Error: Unable to find matching line from backtrace
spec.faster_rubygems.rb:29

spec.faster_rubygems.rb:13

Perhaps it isn’t quite windows friendly?
Thanks.
-rp

rogerdpack · June 22, 2010, 3:25pm

On Jun 22, 2010, at 2:09 AM, rogerdpack wrote:

Failure/Error: Unable to find matching line from backtrace

spec.faster_rubygems.rb:29

spec.faster_rubygems.rb:13

Perhaps it isn’t quite windows friendly?

That happens now and then when the error is in code generated with
eval(string) with no file and ref numbers. Has nothing to do with
Windows as far as I know, and is the same problem we have with
ruby-debug.

HTH,
David

rogerdpack · June 22, 2010, 5:32pm

Failure/Error: Unable to find matching line from backtrace

Perhaps it isn’t quite windows friendly?

That happens now and then when the error is in code generated with eval(string) with no file and ref numbers. Has nothing to do with Windows as far as I know, and is the same problem we have with ruby-debug.

Interesting.
I get the same thing with Linux.
If I add the word “fail” to an rspec, it says the same (not an eval
string…)…

Here’s the output if I run it -b

Gem speeding Gem.bin_path the fake sick way should fake guess the
right path instead of loading full rubygems for now
Failure/Error: Unable to find matching line from backtrace
spec.faster_rubygems.rb:29:in `block (3 levels) in ’

/home/rdp/installs/ruby-1.9.1-p376_installed/lib/ruby/gems/1.9.1/

gems/rspec-core-2.0.0.beta.12/lib/rspec/core/example.rb:47:in
`instance_eval’

Hmm.
-r

rogerdpack · June 22, 2010, 6:38pm

On Jun 22, 2010, at 10:27 AM, rogerdpack wrote:

Here’s the output if I run it -b

Gem speeding Gem.bin_path the fake sick way should fake guess the
right path instead of loading full rubygems for now
Failure/Error: Unable to find matching line from backtrace
spec.faster_rubygems.rb:29:in `block (3 levels) in ’

/home/rdp/installs/ruby-1.9.1-p376_installed/lib/ruby/gems/1.9.1/

gems/rspec-core-2.0.0.beta.12/lib/rspec/core/example.rb:47:in
`instance_eval’

Please file an issue at Issues · rspec/rspec-core · GitHub

Feel free to reference the method that handles this:

github.com

rspec/rspec-core/blob/master/lib/rspec/core/formatters/base_formatter.rb#L118


      
          RSpec::Support.require_rspec_core "formatters/helpers"
          require 'stringio'
          
          
module RSpec
            module Core
              module Formatters
                # RSpec's built-in formatters are all subclasses of
                # RSpec::Core::Formatters::BaseFormatter.
                #
                # @see RSpec::Core::Formatters::BaseTextFormatter
                # @see RSpec::Core::Reporter
                # @see RSpec::Core::Formatters::Protocol
                class BaseFormatter
                  # All formatters inheriting from this formatter will receive these
                  # notifications.
                  Formatters.register self, :start, :example_group_started, :close
                  attr_accessor :example_group
                  attr_reader :output
          
          
        # @api public
                  # @param output [IO] the formatter output
                  # @see RSpec::Core::Formatters::Protocol#initialize
                  def initialize(output)
                    @output = output || StringIO.new
                    @example_group = nil
                  end
          
          
        # @api public
                  #
                  # @param notification [StartNotification]
                  # @see RSpec::Core::Formatters::Protocol#start
                  def start(notification)
                    start_sync_output
                    @example_count = notification.count
                  end
          
          
        # @api public
                  #
                  # @param notification [GroupNotification] containing example_group
                  #   subclass of `RSpec::Core::ExampleGroup`
                  # @see RSpec::Core::Formatters::Protocol#example_group_started
                  def example_group_started(notification)
                    @example_group = notification.group
                  end
          
          
        # @api public
                  #
                  # @param _notification [NullNotification] (Ignored)
                  # @see RSpec::Core::Formatters::Protocol#close
                  def close(_notification)
                    restore_sync_output
                  end
          
          
      private
          
          
        def start_sync_output
                    @old_sync, output.sync = output.sync, true if output_supports_sync
                  end
          
          
        def restore_sync_output
                    output.sync = @old_sync if output_supports_sync && !output.closed?
                  end
          
          
        def output_supports_sync
                    output.respond_to?(:sync=)
                  end
                end
              end
            end
          end

Thanks