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.



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

def exception
  @exception
end

- (Time) finished_at

Returns When the example finished.

Returns:

  • (Time)

    When the example finished.



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

def finished_at
  @finished_at
end

- (Exception?) pending_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.



565
566
567
# File 'lib/rspec/core/example.rb', line 565

def pending_exception
  @pending_exception
end

- (Boolean) pending_fixed 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.



569
570
571
# File 'lib/rspec/core/example.rb', line 569

def pending_fixed
  @pending_fixed
end

- (String?) pending_message

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.



559
560
561
# File 'lib/rspec/core/example.rb', line 559

def pending_message
  @pending_message
end

- (Float) run_time

Returns How long the example took in seconds.

Returns:

  • (Float)

    How long the example took in seconds.



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

def run_time
  @run_time
end

- (Time) started_at

Returns When the example started.

Returns:

  • (Time)

    When the example started.



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

def started_at
  @started_at
end

- (Symbol) status

Returns :passed, :failed or :pending.

Returns:

  • (Symbol)

    :passed, :failed or :pending.



543
544
545
# File 'lib/rspec/core/example.rb', line 543

def status
  @status
end

Instance Method Details

- (void) ensure_timing_set(clock)

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



591
592
593
# File 'lib/rspec/core/example.rb', line 591

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

- (Boolean) example_skipped?

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.



578
579
580
# File 'lib/rspec/core/example.rb', line 578

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

- (void) record_finished(status, finished_at)

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.



584
585
586
587
# File 'lib/rspec/core/example.rb', line 584

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