Class: Test::Unit::Error

Inherits:
Object
  • Object
show all
Includes:
Util::BacktraceFilter
Defined in:
lib/test/unit/error.rb

Overview

Encapsulates an error in a test. Created by Test::Unit::TestCase when it rescues an exception thrown during the processing of a test.

Constant Summary collapse

SINGLE_CHARACTER = 
'E'
LABEL = 
"Error"

Constants included from Util::BacktraceFilter

Util::BacktraceFilter::TESTUNIT_FILE_SEPARATORS, Util::BacktraceFilter::TESTUNIT_PREFIX, Util::BacktraceFilter::TESTUNIT_RB_FILE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util::BacktraceFilter

filter_backtrace

Constructor Details

#initialize(test_name, exception, options = {}) ⇒ Error

Creates a new Error with the given test_name and exception.



26
27
28
29
30
 
# File 'lib/test/unit/error.rb', line 26

def initialize(test_name, exception, options={})
  @test_name = test_name
  @exception = exception
  @method_name = options[:method_name]
end

Instance Attribute Details

#exception ⇒ Object (readonly)

Returns the value of attribute exception.



18
19
20
 
# File 'lib/test/unit/error.rb', line 18

def exception
  @exception
end

#method_name ⇒ Object (readonly)

Returns the value of attribute method_name.



19
20
21
 
# File 'lib/test/unit/error.rb', line 19

def method_name
  @method_name
end

#test_name ⇒ Object (readonly)

Returns the value of attribute test_name.



18
19
20
 
# File 'lib/test/unit/error.rb', line 18

def test_name
  @test_name
end

Instance Method Details

#critical? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/test/unit/error.rb', line 67

def critical?
  true
end

#label ⇒ Object 



37
38
39
 
# File 'lib/test/unit/error.rb', line 37

def label
  LABEL
end

#location ⇒ Object Also known as: backtrace 



57
58
59
 
# File 'lib/test/unit/error.rb', line 57

def location
  @location ||= filter_backtrace(@exception.backtrace)
end

#long_display ⇒ Object

Returns a verbose version of the error description.



52
53
54
55
 
# File 'lib/test/unit/error.rb', line 52

def long_display
  backtrace_display = location.join("\n    ")
  "#{label}:\n#@test_name:\n#{message}\n    #{backtrace_display}"
end

#message ⇒ Object

Returns the message associated with the error.



42
43
44
 
# File 'lib/test/unit/error.rb', line 42

def message
  "#{@exception.class.name}: #{@exception.message}"
end

#short_display ⇒ Object

Returns a brief version of the error description.



47
48
49
 
# File 'lib/test/unit/error.rb', line 47

def short_display
  "#@test_name: #{message.split("\n")[0]}"
end

#single_character_display ⇒ Object

Returns a single character representation of an error.



33
34
35
 
# File 'lib/test/unit/error.rb', line 33

def single_character_display
  SINGLE_CHARACTER
end

#to_s ⇒ Object

Overridden to return long_display.



63
64
65
 
# File 'lib/test/unit/error.rb', line 63

def to_s
  long_display
end