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
|
# frozen_string_literal: true
require 'fast_spec_helper'
require 're2'
require_relative '../../app/services/service_response'
require_relative '../../lib/gitlab/error_tracking'
RSpec.describe ServiceResponse, feature_category: :shared do
describe '.success' do
it 'creates a successful response without a message' do
expect(described_class.success).to be_success
end
it 'creates a successful response with a message' do
response = described_class.success(message: 'Good orange')
expect(response).to be_success
expect(response.message).to eq('Good orange')
end
it 'creates a successful response with payload' do
response = described_class.success(payload: { good: 'orange' })
expect(response).to be_success
expect(response.payload).to eq(good: 'orange')
end
it 'creates a successful response with default HTTP status' do
response = described_class.success
expect(response).to be_success
expect(response.http_status).to eq(:ok)
end
it 'creates a successful response with custom HTTP status' do
response = described_class.success(http_status: 204)
expect(response).to be_success
expect(response.http_status).to eq(204)
end
end
describe '.error' do
it 'creates an error response without HTTP status' do
response = described_class.error(message: 'Bad apple')
expect(response).to be_error
expect(response.message).to eq('Bad apple')
end
it 'creates an error response with HTTP status' do
response = described_class.error(message: 'Bad apple', http_status: 400)
expect(response).to be_error
expect(response.message).to eq('Bad apple')
expect(response.http_status).to eq(400)
end
it 'creates an error response with payload' do
response = described_class.error(message: 'Bad apple', payload: { bad: 'apple' })
expect(response).to be_error
expect(response.message).to eq('Bad apple')
expect(response.payload).to eq(bad: 'apple')
end
it 'creates an error response with a reason' do
response = described_class.error(message: 'Bad apple', reason: :permission_denied)
expect(response).to be_error
expect(response.message).to eq('Bad apple')
expect(response.reason).to eq(:permission_denied)
end
end
describe '#success?' do
it 'returns true for a successful response' do
expect(described_class.success.success?).to eq(true)
end
it 'returns false for a failed response' do
expect(described_class.error(message: 'Bad apple').success?).to eq(false)
end
end
describe '#error?' do
it 'returns false for a successful response' do
expect(described_class.success.error?).to eq(false)
end
it 'returns true for a failed response' do
expect(described_class.error(message: 'Bad apple').error?).to eq(true)
end
end
describe '#errors' do
it 'returns an empty array for a successful response' do
expect(described_class.success.errors).to be_empty
end
it 'returns an array with a correct message for an error response' do
expect(described_class.error(message: 'error message').errors).to eq(['error message'])
end
end
describe '#track_and_raise_exception' do
context 'when successful' do
let(:response) { described_class.success }
it 'returns self' do
expect(response.track_and_raise_exception).to be response
end
end
context 'when an error' do
let(:response) { described_class.error(message: 'bang') }
it 'tracks and raises' do
expect(::Gitlab::ErrorTracking).to receive(:track_and_raise_exception)
.with(StandardError.new('bang'), {})
response.track_and_raise_exception
end
it 'allows specification of error class' do
error = Class.new(StandardError)
expect(::Gitlab::ErrorTracking).to receive(:track_and_raise_exception)
.with(error.new('bang'), {})
response.track_and_raise_exception(as: error)
end
it 'allows extra data for tracking' do
expect(::Gitlab::ErrorTracking).to receive(:track_and_raise_exception)
.with(StandardError.new('bang'), { foo: 1, bar: 2 })
response.track_and_raise_exception(foo: 1, bar: 2)
end
end
end
describe '#track_exception' do
context 'when successful' do
let(:response) { described_class.success }
it 'returns self' do
expect(response.track_exception).to be response
end
end
context 'when an error' do
let(:response) { described_class.error(message: 'bang') }
it 'tracks' do
expect(::Gitlab::ErrorTracking).to receive(:track_exception)
.with(StandardError.new('bang'), {})
expect(response.track_exception).to be response
end
it 'allows specification of error class' do
error = Class.new(StandardError)
expect(::Gitlab::ErrorTracking).to receive(:track_exception)
.with(error.new('bang'), {})
expect(response.track_exception(as: error)).to be response
end
it 'allows extra data for tracking' do
expect(::Gitlab::ErrorTracking).to receive(:track_exception)
.with(StandardError.new('bang'), { foo: 1, bar: 2 })
expect(response.track_exception(foo: 1, bar: 2)).to be response
end
end
end
describe '#log_and_raise_exception' do
context 'when successful' do
let(:response) { described_class.success }
it 'returns self' do
expect(response.log_and_raise_exception).to be response
end
end
context 'when an error' do
let(:response) { described_class.error(message: 'bang') }
it 'logs' do
expect(::Gitlab::ErrorTracking).to receive(:log_and_raise_exception)
.with(StandardError.new('bang'), {})
response.log_and_raise_exception
end
it 'allows specification of error class' do
error = Class.new(StandardError)
expect(::Gitlab::ErrorTracking).to receive(:log_and_raise_exception)
.with(error.new('bang'), {})
response.log_and_raise_exception(as: error)
end
it 'allows extra data for tracking' do
expect(::Gitlab::ErrorTracking).to receive(:log_and_raise_exception)
.with(StandardError.new('bang'), { foo: 1, bar: 2 })
response.log_and_raise_exception(foo: 1, bar: 2)
end
end
end
describe '#deconstruct_keys' do
it 'supports pattern matching' do
status =
case described_class.error(message: 'Bad apple')
in { status: Symbol => status }
status
else
raise
end
expect(status).to eq(:error)
end
end
describe '#cause' do
it 'returns a string inquirer' do
response = described_class.error(message: 'Bad apple', reason: :invalid_input)
expect(response.cause).to be_invalid_input
end
end
end
|
