Class: RSpec::Core::Example::ExecutionResult

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/core/example.rb

Overview

Represents the result of executing an example. Behaves like a hash for backwards compatibility.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#exception ⇒ Exception?

Returns The failure, if there was one.

Returns:

  • (Exception, nil) —

    The failure, if there was one.



548
549
550
 
# File 'lib/rspec/core/example.rb', line 548

def exception
  @exception
end

#finished_at ⇒ Time

Returns When the example finished.

Returns:

  • (Time) —

    When the example finished.



554
555
556
 
# File 'lib/rspec/core/example.rb', line 554

def finished_at
  @finished_at
end

#pending_exception ⇒ Exception?

Returns The exception triggered while executing the pending example. If no exception was triggered it would no longer get a status of :pending unless it was tagged with :skip.

Returns:

  • (Exception, nil) —

    The exception triggered while executing the pending example. If no exception was triggered it would no longer get a status of :pending unless it was tagged with :skip.



567
568
569
 
# File 'lib/rspec/core/example.rb', line 567

def pending_exception
  @pending_exception
end

#pending_fixed ⇒ Boolean Also known as: pending_fixed?

Returns For examples tagged with :pending, this indicates whether or not it now passes.

Returns:

  • (Boolean) —

    For examples tagged with :pending, this indicates whether or not it now passes.



571
572
573
 
# File 'lib/rspec/core/example.rb', line 571

def pending_fixed
  @pending_fixed
end

#pending_message ⇒ String?

Returns The reason the example was pending, or nil if the example was not pending.

Returns:

  • (String, nil) —

    The reason the example was pending, or nil if the example was not pending.



561
562
563
 
# File 'lib/rspec/core/example.rb', line 561

def pending_message
  @pending_message
end

#run_time ⇒ Float

Returns How long the example took in seconds.

Returns:

  • (Float) —

    How long the example took in seconds.



557
558
559
 
# File 'lib/rspec/core/example.rb', line 557

def run_time
  @run_time
end

#started_at ⇒ Time

Returns When the example started.

Returns:

  • (Time) —

    When the example started.



551
552
553
 
# File 'lib/rspec/core/example.rb', line 551

def started_at
  @started_at
end

#status ⇒ Symbol

Returns :passed, :failed or :pending.

Returns:

  • (Symbol) —

    :passed, :failed or :pending.



545
546
547
 
# File 'lib/rspec/core/example.rb', line 545

def status
  @status
end

Instance Method Details

#ensure_timing_set(clock) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Populates finished_at and run_time if it has not yet been set



593
594
595
 
# File 'lib/rspec/core/example.rb', line 593

def ensure_timing_set(clock)
  calculate_run_time(clock.now) unless finished_at
end

#example_skipped? ⇒ Boolean

Returns Indicates if the example was completely skipped (typically done via :skip metadata or the skip method). Skipped examples will have a :pending result. A :pending result can also come from examples that were marked as :pending, which causes them to be run, and produces a :failed result if the example passes.

Returns:

  • (Boolean) —

    Indicates if the example was completely skipped (typically done via :skip metadata or the skip method). Skipped examples will have a :pending result. A :pending result can also come from examples that were marked as :pending, which causes them to be run, and produces a :failed result if the example passes.



580
581
582
 
# File 'lib/rspec/core/example.rb', line 580

def example_skipped?
  status == :pending && !pending_exception
end

#record_finished(status, finished_at) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Records the finished status of the example.



586
587
588
589
 
# File 'lib/rspec/core/example.rb', line 586

def record_finished(status, finished_at)
  self.status = status
  calculate_run_time(finished_at)
end