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.



482
483
484
# File 'lib/rspec/core/example.rb', line 482

def exception
  @exception
end

- (Time) finished_at

Returns When the example finished.

Returns:

  • (Time)

    When the example finished.



488
489
490
# File 'lib/rspec/core/example.rb', line 488

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.



501
502
503
# File 'lib/rspec/core/example.rb', line 501

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.



505
506
507
# File 'lib/rspec/core/example.rb', line 505

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.



495
496
497
# File 'lib/rspec/core/example.rb', line 495

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.



491
492
493
# File 'lib/rspec/core/example.rb', line 491

def run_time
  @run_time
end

- (Time) started_at

Returns When the example started.

Returns:

  • (Time)

    When the example started.



485
486
487
# File 'lib/rspec/core/example.rb', line 485

def started_at
  @started_at
end

- (Symbol) status

Returns :passed, :failed or :pending.

Returns:

  • (Symbol)

    :passed, :failed or :pending.



479
480
481
# File 'lib/rspec/core/example.rb', line 479

def status
  @status
end

Instance Method Details

- (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.



514
515
516
# File 'lib/rspec/core/example.rb', line 514

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.



520
521
522
523
524
# File 'lib/rspec/core/example.rb', line 520

def record_finished(status, finished_at)
  self.status      = status
  self.finished_at = finished_at
  self.run_time    = (finished_at - started_at).to_f
end