/
notification.rb
136 lines (115 loc) · 3.34 KB
/
notification.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
require 'test/unit/util/backtracefilter'
module Test
module Unit
class Notification
include Util::BacktraceFilter
attr_reader :test_name, :location, :message
attr_reader :method_name
SINGLE_CHARACTER = 'N'
LABEL = "Notification"
# Creates a new Notification with the given location and
# message.
def initialize(test_name, location, message, options={})
@test_name = test_name
@location = location
@message = message
@method_name = options[:method_name]
end
# Returns a single character representation of a notification.
def single_character_display
SINGLE_CHARACTER
end
def label
LABEL
end
# Returns a brief version of the error description.
def short_display
"#{@test_name}: #{@message.split("\n")[0]}"
end
# Returns a verbose version of the error description.
def long_display
backtrace = filter_backtrace(location).join("\n")
"#{label}: #{@message}\n#{@test_name}\n#{backtrace}"
end
# Overridden to return long_display.
def to_s
long_display
end
def critical?
false
end
end
class NotifiedError < StandardError
end
module TestCaseNotificationSupport
class << self
def included(base)
base.class_eval do
include NotificationHandler
end
end
end
# Notify some information.
#
# Example:
# def test_notification
# notify("I'm here!")
# # Reached here
# notify("Special!") if special_case?
# # Reached here too
# end
#
# options:
# :backtrace override backtrace.
def notify(message, options={}, &block)
backtrace = filter_backtrace(options[:backtrace] || caller)
notification = Notification.new(name, backtrace, message,
:method_name => @method_name)
add_notification(notification)
end
private
def add_notification(notification)
current_result.add_notification(notification)
end
end
module NotificationHandler
class << self
def included(base)
base.exception_handler(:handle_notified_error)
end
end
private
def handle_notified_error(exception)
return false unless exception.is_a?(NotifiedError)
notification = Notification.new(name,
filter_backtrace(exception.backtrace),
exception.message)
add_notification(notification)
true
end
end
module TestResultNotificationSupport
attr_reader :notifications
# Records a Test::Unit::Notification.
def add_notification(notification)
@notifications << notification
notify_fault(notification)
notify_changed
end
# Returns the number of notifications this TestResult has
# recorded.
def notification_count
@notifications.size
end
private
def initialize_containers
super
@notifications = []
@summary_generators << :notification_summary
end
def notification_summary
"#{notification_count} notifications"
end
end
end
end