This repository has been archived by the owner on Nov 11, 2017. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 98
/
notice_test.rb
363 lines (297 loc) · 12.8 KB
/
notice_test.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
require File.dirname(__FILE__) + '/helper'
class NoticeTest < Test::Unit::TestCase
include DefinesConstants
def configure
returning HoptoadNotifier::Configuration.new do |config|
config.api_key = 'abc123def456'
end
end
def build_notice(args = {})
configuration = args.delete(:configuration) || configure
HoptoadNotifier::Notice.new(configuration.merge(args))
end
def stub_request(attrs = {})
stub('request', { :parameters => { 'one' => 'two' },
:protocol => 'http',
:host => 'some.host',
:request_uri => '/some/uri',
:session => { :to_hash => { 'a' => 'b' } },
:env => { 'three' => 'four' } }.update(attrs))
end
should "set the api key" do
api_key = 'key'
notice = build_notice(:api_key => api_key)
assert_equal api_key, notice.api_key
end
should "accept a project root" do
project_root = '/path/to/project'
notice = build_notice(:project_root => project_root)
assert_equal project_root, notice.project_root
end
should "accept a component" do
assert_equal 'users_controller', build_notice(:component => 'users_controller').controller
end
should "alias the component as controller" do
assert_equal 'users_controller', build_notice(:controller => 'users_controller').component
assert_equal 'users_controller', build_notice(:component => 'users_controller').controller
end
should "accept a action" do
assert_equal 'index', build_notice(:action => 'index').action
end
should "accept a url" do
url = 'http://some.host/uri'
notice = build_notice(:url => url)
assert_equal url, notice.url
end
should "accept a backtrace from an exception or hash" do
array = ["user.rb:34:in `crazy'"]
exception = build_exception
exception.set_backtrace array
backtrace = HoptoadNotifier::Backtrace.parse(array)
notice_from_exception = build_notice(:exception => exception)
assert_equal notice_from_exception.backtrace,
backtrace,
"backtrace was not correctly set from an exception"
notice_from_hash = build_notice(:backtrace => array)
assert_equal notice_from_hash.backtrace,
backtrace,
"backtrace was not correctly set from a hash"
end
should "set the error class from an exception or hash" do
assert_accepts_exception_attribute :error_class do |exception|
exception.class.name
end
end
should "set the error message from an exception or hash" do
assert_accepts_exception_attribute :error_message do |exception|
"#{exception.class.name}: #{exception.message}"
end
end
should "accept parameters from a request or hash" do
parameters = { 'one' => 'two' }
notice_from_hash = build_notice(:parameters => parameters)
assert_equal notice_from_hash.parameters, parameters
end
should "accept session data from a session[:data] hash" do
data = { 'one' => 'two' }
notice = build_notice(:session => { :data => data })
assert_equal data, notice.session_data
end
should "accept session data from a session_data hash" do
data = { 'one' => 'two' }
notice = build_notice(:session_data => data)
assert_equal data, notice.session_data
end
should "accept an environment name" do
assert_equal 'development', build_notice(:environment_name => 'development').environment_name
end
should "accept CGI data from a hash" do
data = { 'string' => 'value' }
notice = build_notice(:cgi_data => data)
assert_equal data, notice.cgi_data, "should take CGI data from a hash"
end
should "accept notifier information" do
params = { :notifier_name => 'a name for a notifier',
:notifier_version => '1.0.5',
:notifier_url => 'http://notifiers.r.us/download' }
notice = build_notice(params)
assert_equal params[:notifier_name], notice.notifier_name
assert_equal params[:notifier_version], notice.notifier_version
assert_equal params[:notifier_url], notice.notifier_url
end
should "set sensible defaults without an exception" do
backtrace = HoptoadNotifier::Backtrace.parse(caller)
notice = build_notice
assert_equal 'Notification', notice.error_message
assert_array_starts_with backtrace.lines, notice.backtrace.lines
assert_equal({}, notice.parameters)
assert_equal({}, notice.session_data)
end
should "use the caller as the backtrace for an exception without a backtrace" do
backtrace = HoptoadNotifier::Backtrace.parse(caller)
notice = build_notice(:exception => StandardError.new('error'), :backtrace => nil)
assert_array_starts_with backtrace.lines, notice.backtrace.lines
end
should "convert unserializable objects to strings" do
assert_serializes_hash(:parameters)
assert_serializes_hash(:cgi_data)
assert_serializes_hash(:session_data)
end
should "filter parameters" do
assert_filters_hash(:parameters)
end
should "filter cgi data" do
assert_filters_hash(:cgi_data)
end
context "a Notice turned into XML" do
setup do
HoptoadNotifier.configure do |config|
config.api_key = "1234567890"
end
@exception = build_exception
@notice = build_notice({
:notifier_name => 'a name',
:notifier_version => '1.2.3',
:notifier_url => 'http://some.url/path',
:exception => @exception,
:controller => "controller",
:action => "action",
:url => "http://url.com",
:parameters => { "paramskey" => "paramsvalue",
"nestparentkey" => { "nestkey" => "nestvalue" } },
:session_data => { "sessionkey" => "sessionvalue" },
:cgi_data => { "cgikey" => "cgivalue" },
:project_root => "RAILS_ROOT",
:environment_name => "RAILS_ENV"
})
@xml = @notice.to_xml
@document = Nokogiri::XML::Document.parse(@xml)
end
should "validate against the XML schema" do
assert_valid_notice_document @document
end
should "serialize a Notice to XML when sent #to_xml" do
assert_valid_node(@document, "//api-key", @notice.api_key)
assert_valid_node(@document, "//notifier/name", @notice.notifier_name)
assert_valid_node(@document, "//notifier/version", @notice.notifier_version)
assert_valid_node(@document, "//notifier/url", @notice.notifier_url)
assert_valid_node(@document, "//error/class", @notice.error_class)
assert_valid_node(@document, "//error/message", @notice.error_message)
assert_valid_node(@document, "//error/backtrace/line/@number", @notice.backtrace.lines.first.number)
assert_valid_node(@document, "//error/backtrace/line/@file", @notice.backtrace.lines.first.file)
assert_valid_node(@document, "//error/backtrace/line/@method", @notice.backtrace.lines.first.method)
assert_valid_node(@document, "//request/url", @notice.url)
assert_valid_node(@document, "//request/component", @notice.controller)
assert_valid_node(@document, "//request/action", @notice.action)
assert_valid_node(@document, "//request/params/var/@key", "paramskey")
assert_valid_node(@document, "//request/params/var", "paramsvalue")
assert_valid_node(@document, "//request/params/var/@key", "nestparentkey")
assert_valid_node(@document, "//request/params/var/var/@key", "nestkey")
assert_valid_node(@document, "//request/params/var/var", "nestvalue")
assert_valid_node(@document, "//request/session/var/@key", "sessionkey")
assert_valid_node(@document, "//request/session/var", "sessionvalue")
assert_valid_node(@document, "//request/cgi-data/var/@key", "cgikey")
assert_valid_node(@document, "//request/cgi-data/var", "cgivalue")
assert_valid_node(@document, "//server-environment/project-root", "RAILS_ROOT")
assert_valid_node(@document, "//server-environment/environment-name", "RAILS_ENV")
end
end
should "not send empty request data" do
notice = build_notice
assert_nil notice.url
assert_nil notice.controller
assert_nil notice.action
xml = notice.to_xml
document = Nokogiri::XML.parse(xml)
assert_nil document.at('//request/url')
assert_nil document.at('//request/component')
assert_nil document.at('//request/action')
assert_valid_notice_document document
end
%w(url controller action).each do |var|
should "send a request if #{var} is present" do
notice = build_notice(var.to_sym => 'value')
xml = notice.to_xml
document = Nokogiri::XML.parse(xml)
assert_not_nil document.at('//request')
end
end
%w(parameters cgi_data session_data).each do |var|
should "send a request if #{var} is present" do
notice = build_notice(var.to_sym => { 'key' => 'value' })
xml = notice.to_xml
document = Nokogiri::XML.parse(xml)
assert_not_nil document.at('//request')
end
end
should "not ignore an exception not matching ignore filters" do
notice = build_notice(:error_class => 'ArgumentError',
:ignore => ['Argument'],
:ignore_by_filters => [lambda { |notice| false }])
assert !notice.ignore?
end
should "ignore an exception with a matching error class" do
notice = build_notice(:error_class => 'ArgumentError',
:ignore => [ArgumentError])
assert notice.ignore?
end
should "ignore an exception with a matching error class name" do
notice = build_notice(:error_class => 'ArgumentError',
:ignore => ['ArgumentError'])
assert notice.ignore?
end
should "ignore an exception with a matching filter" do
filter = lambda {|notice| notice.error_class == 'ArgumentError' }
notice = build_notice(:error_class => 'ArgumentError',
:ignore_by_filters => [filter])
assert notice.ignore?
end
should "not raise without an ignore list" do
notice = build_notice(:ignore => nil, :ignore_by_filters => nil)
assert_nothing_raised do
notice.ignore?
end
end
should "act like a hash" do
notice = build_notice(:error_message => 'some message')
assert_equal notice.error_message, notice[:error_message]
end
should "return params on notice[:request][:params]" do
params = { 'one' => 'two' }
notice = build_notice(:parameters => params)
assert_equal params, notice[:request][:params]
end
should "ensure #to_hash is called on objects that support it" do
assert_nothing_raised do
build_notice(:session => { :object => stub(:to_hash => {}) })
end
end
def assert_accepts_exception_attribute(attribute, args = {}, &block)
exception = build_exception
block ||= lambda { exception.send(attribute) }
value = block.call(exception)
notice_from_exception = build_notice(args.merge(:exception => exception))
assert_equal notice_from_exception.send(attribute),
value,
"#{attribute} was not correctly set from an exception"
notice_from_hash = build_notice(args.merge(attribute => value))
assert_equal notice_from_hash.send(attribute),
value,
"#{attribute} was not correctly set from a hash"
end
def assert_serializes_hash(attribute)
[File.open(__FILE__), Proc.new { puts "boo!" }, Module.new].each do |object|
hash = {
:strange_object => object,
:sub_hash => {
:sub_object => object
},
:array => [object]
}
notice = build_notice(attribute => hash)
hash = notice.send(attribute)
assert_equal object.to_s, hash[:strange_object], "objects should be serialized"
assert_kind_of Hash, hash[:sub_hash], "subhashes should be kept"
assert_equal object.to_s, hash[:sub_hash][:sub_object], "subhash members should be serialized"
assert_kind_of Array, hash[:array], "arrays should be kept"
assert_equal object.to_s, hash[:array].first, "array members should be serialized"
end
end
def assert_valid_notice_document(document)
xsd_path = File.join(File.dirname(__FILE__), "hoptoad_2_0.xsd")
schema = Nokogiri::XML::Schema.new(IO.read(xsd_path))
errors = schema.validate(document)
assert errors.empty?, errors.collect{|e| e.message }.join
end
def assert_filters_hash(attribute)
filters = %w(abc def)
original = { 'abc' => "123", 'def' => "456", 'ghi' => "789", 'nested' => { 'abc' => '100' } }
filtered = { 'abc' => "[FILTERED]",
'def' => "[FILTERED]",
'ghi' => "789",
'nested' => { 'abc' => '[FILTERED]' } }
notice = build_notice(:params_filters => filters, attribute => original)
assert_equal(filtered,
notice.send(attribute))
end
end