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
|
# frozen_string_literal: true
require 'spec_helper'
describe Grape::Middleware::Error do
let(:exception_app) do
Class.new do
class << self
def call(_env)
raise 'rain!'
end
end
end
end
let(:other_exception_app) do
Class.new do
class << self
def call(_env)
raise NotImplementedError, 'snow!'
end
end
end
end
let(:custom_error_app) do
Class.new do
class << self
class CustomError < Grape::Exceptions::Base; end
def call(_env)
raise CustomError.new(status: 400, message: 'failed validation')
end
end
end
end
let(:error_hash_app) do
Class.new do
class << self
def error!(message, status)
throw :error, message: { error: message, detail: 'missing widget' }, status: status
end
def call(_env)
error!('rain!', 401)
end
end
end
end
let(:access_denied_app) do
Class.new do
class << self
def error!(message, status)
throw :error, message: message, status: status
end
def call(_env)
error!('Access Denied', 401)
end
end
end
end
let(:app) do
builder = Rack::Builder.new
builder.use Spec::Support::EndpointFaker
if options.any?
builder.use described_class, options
else
builder.use described_class
end
builder.run running_app
builder.to_app
end
context 'with defaults' do
let(:running_app) { exception_app }
let(:options) { {} }
it 'does not trap errors by default' do
expect { get '/' }.to raise_error(RuntimeError, 'rain!')
end
end
context 'with rescue_all' do
context 'StandardError exception' do
let(:running_app) { exception_app }
let(:options) { { rescue_all: true } }
it 'sets the message appropriately' do
get '/'
expect(last_response.body).to eq('rain!')
end
it 'defaults to a 500 status' do
get '/'
expect(last_response.status).to eq(500)
end
end
context 'Non-StandardError exception' do
let(:running_app) { other_exception_app }
let(:options) { { rescue_all: true } }
it 'does not trap errors other than StandardError' do
expect { get '/' }.to raise_error(NotImplementedError, 'snow!')
end
end
end
context 'Non-StandardError exception with a provided rescue handler' do
context 'default error response' do
let(:running_app) { other_exception_app }
let(:options) { { rescue_handlers: { NotImplementedError => nil } } }
it 'rescues the exception using the default handler' do
get '/'
expect(last_response.body).to eq('snow!')
end
end
context 'custom error response' do
let(:running_app) { other_exception_app }
let(:options) { { rescue_handlers: { NotImplementedError => -> { Rack::Response.new('rescued', 200, {}) } } } }
it 'rescues the exception using the provided handler' do
get '/'
expect(last_response.body).to eq('rescued')
end
end
end
context do
let(:running_app) { exception_app }
let(:options) { { rescue_all: true, default_status: 500 } }
it 'is possible to specify a different default status code' do
get '/'
expect(last_response.status).to eq(500)
end
end
context do
let(:running_app) { exception_app }
let(:options) { { rescue_all: true, format: :json } }
it 'is possible to return errors in json format' do
get '/'
expect(last_response.body).to eq('{"error":"rain!"}')
end
end
context do
let(:running_app) { error_hash_app }
let(:options) { { rescue_all: true, format: :json } }
it 'is possible to return hash errors in json format' do
get '/'
expect(['{"error":"rain!","detail":"missing widget"}',
'{"detail":"missing widget","error":"rain!"}']).to include(last_response.body)
end
end
context do
let(:running_app) { exception_app }
let(:options) { { rescue_all: true, format: :jsonapi } }
it 'is possible to return errors in jsonapi format' do
get '/'
expect(last_response.body).to eq('{"error":"rain!"}')
end
end
context do
let(:running_app) { error_hash_app }
let(:options) { { rescue_all: true, format: :jsonapi } }
it 'is possible to return hash errors in jsonapi format' do
get '/'
expect(['{"error":"rain!","detail":"missing widget"}',
'{"detail":"missing widget","error":"rain!"}']).to include(last_response.body)
end
end
context do
let(:running_app) { exception_app }
let(:options) { { rescue_all: true, format: :xml } }
it 'is possible to return errors in xml format' do
get '/'
expect(last_response.body).to eq("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n <message>rain!</message>\n</error>\n")
end
end
context do
let(:running_app) { error_hash_app }
let(:options) { { rescue_all: true, format: :xml } }
it 'is possible to return hash errors in xml format' do
get '/'
expect(["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n <detail>missing widget</detail>\n <error>rain!</error>\n</error>\n",
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n <error>rain!</error>\n <detail>missing widget</detail>\n</error>\n"]).to include(last_response.body)
end
end
context do
let(:running_app) { exception_app }
let(:options) do
{
rescue_all: true,
format: :custom,
error_formatters: {
custom: lambda do |message, _backtrace, _options, _env, _original_exception|
{ custom_formatter: message }.inspect
end
}
}
end
it 'is possible to specify a custom formatter' do
get '/'
expect(last_response.body).to eq('{:custom_formatter=>"rain!"}')
end
end
context do
let(:running_app) { access_denied_app }
let(:options) { {} }
it 'does not trap regular error! codes' do
get '/'
expect(last_response.status).to eq(401)
end
end
context do
let(:running_app) { custom_error_app }
let(:options) { { rescue_all: false } }
it 'responds to custom Grape exceptions appropriately' do
get '/'
expect(last_response.status).to eq(400)
expect(last_response.body).to eq('failed validation')
end
end
context 'with rescue_options :backtrace and :exception set to true' do
let(:running_app) { exception_app }
let(:options) do
{
rescue_all: true,
format: :json,
rescue_options: { backtrace: true, original_exception: true }
}
end
it 'is possible to return the backtrace and the original exception in json format' do
get '/'
expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original_exception', 'RuntimeError')
end
end
context do
let(:running_app) { exception_app }
let(:options) do
{
rescue_all: true,
format: :xml,
rescue_options: { backtrace: true, original_exception: true }
}
end
it 'is possible to return the backtrace and the original exception in xml format' do
get '/'
expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original-exception', 'RuntimeError')
end
end
context do
let(:running_app) { exception_app }
let(:options) do
{
rescue_all: true,
format: :txt,
rescue_options: { backtrace: true, original_exception: true }
}
end
it 'is possible to return the backtrace and the original exception in txt format' do
get '/'
expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original exception', 'RuntimeError')
end
end
end
|
