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

#exceptionException?

Returns The failure, if there was one.

Returns:

  • (Exception, nil)

    The failure, if there was one.



446
447
448
# File 'lib/rspec/core/example.rb', line 446

def exception
  @exception
end

#finished_atTime

Returns When the example finished.

Returns:

  • (Time)

    When the example finished.



452
453
454
# File 'lib/rspec/core/example.rb', line 452

def finished_at
  @finished_at
end

#pending_exceptionException?

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.



465
466
467
# File 'lib/rspec/core/example.rb', line 465

def pending_exception
  @pending_exception
end

#pending_fixedBoolean 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.



469
470
471
# File 'lib/rspec/core/example.rb', line 469

def pending_fixed
  @pending_fixed
end

#pending_messageString?

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.



459
460
461
# File 'lib/rspec/core/example.rb', line 459

def pending_message
  @pending_message
end

#run_timeFloat

Returns How long the example took in seconds.

Returns:

  • (Float)

    How long the example took in seconds.



455
456
457
# File 'lib/rspec/core/example.rb', line 455

def run_time
  @run_time
end

#started_atTime

Returns When the example started.

Returns:

  • (Time)

    When the example started.



449
450
451
# File 'lib/rspec/core/example.rb', line 449

def started_at
  @started_at
end

#statusSymbol

Returns :passed, :failed or :pending.

Returns:

  • (Symbol)

    :passed, :failed or :pending.



443
444
445
# File 'lib/rspec/core/example.rb', line 443

def status
  @status
end

Instance Method Details

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



475
476
477
478
479
# File 'lib/rspec/core/example.rb', line 475

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