Class: RSpec::Core::Example::ExecutionResult
- Inherits:
-
Object
- Object
- RSpec::Core::Example::ExecutionResult
- 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)
-
- (Exception?) exception
The failure, if there was one.
-
- (Time) finished_at
When the example finished.
-
- (Exception?) pending_exception
The exception triggered while executing the pending example.
-
- (Boolean) pending_fixed
(also: #pending_fixed?)
For examples tagged with
:pending
, this indicates whether or not it now passes. -
- (String?) pending_message
The reason the example was pending, or nil if the example was not pending.
-
- (Float) run_time
How long the example took in seconds.
-
- (Time) started_at
When the example started.
-
- (Symbol) status
:passed
,:failed
or:pending
.
Instance Method Summary (collapse)
-
- (void) record_finished(status, finished_at)
private
Records the finished status of the example.
Instance Attribute Details
- (Exception?) exception
Returns The failure, if there was one.
424 425 426 |
# File 'lib/rspec/core/example.rb', line 424 def exception @exception end |
- (Time) finished_at
Returns When the example finished.
430 431 432 |
# File 'lib/rspec/core/example.rb', line 430 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
.
443 444 445 |
# File 'lib/rspec/core/example.rb', line 443 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.
447 448 449 |
# File 'lib/rspec/core/example.rb', line 447 def pending_fixed @pending_fixed end |
- (String?) pending_message
Returns The reason the example was pending, or nil if the example was not pending.
437 438 439 |
# File 'lib/rspec/core/example.rb', line 437 def @pending_message end |
- (Float) run_time
Returns How long the example took in seconds.
433 434 435 |
# File 'lib/rspec/core/example.rb', line 433 def run_time @run_time end |
- (Time) started_at
Returns When the example started.
427 428 429 |
# File 'lib/rspec/core/example.rb', line 427 def started_at @started_at end |
- (Symbol) status
Returns :passed
, :failed
or :pending
.
421 422 423 |
# File 'lib/rspec/core/example.rb', line 421 def status @status end |
Instance Method Details
- (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.
453 454 455 456 457 |
# File 'lib/rspec/core/example.rb', line 453 def record_finished(status, finished_at) self.status = status self.finished_at = finished_at self.run_time = (finished_at - started_at).to_f end |