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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Request do
before do
# Prevent tests modifying the `default_params` value from causing cross-test
# pollution
described_class.default_params.delete(:sudo)
@request = described_class.new
end
it { is_expected.to respond_to :get }
it { is_expected.to respond_to :post }
it { is_expected.to respond_to :put }
it { is_expected.to respond_to :delete }
describe '.default_options' do
it 'has default values' do
default_options = described_class.default_options
expect(default_options).to be_a Hash
expect(default_options[:parser]).to be_a Proc
expect(default_options[:format]).to eq(:json)
expect(default_options[:headers]).to eq('Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded')
expect(default_options[:default_params]).to be_empty
end
end
describe '.parse' do
it 'returns ObjectifiedHash' do
body = JSON.unparse(a: 1, b: 2)
expect(described_class.parse(body)).to be_an Gitlab::ObjectifiedHash
expect(described_class.parse('true')).to be true
expect(described_class.parse('false')).to be false
expect { described_class.parse('string') }.to raise_error(Gitlab::Error::Parsing)
end
end
describe '#request_defaults' do
context 'when endpoint is not set' do
it 'raises Error::MissingCredentials' do
@request.endpoint = nil
expect do
@request.request_defaults
end.to raise_error(Gitlab::Error::MissingCredentials, 'Please set an endpoint to API')
end
end
context 'when endpoint is set' do
before do
@request.endpoint = 'http://rabbit-hole.example.com'
end
it 'sets default_params' do
@request.request_defaults('sudoer')
expect(described_class.default_params).to eq(sudo: 'sudoer')
end
end
end
describe 'HTTP request methods' do
it 'does not overwrite headers set via HTTParty configuration' do
@request.private_token = 'token'
@request.endpoint = 'https://example.com/api/v4'
path = "#{@request.endpoint}/version"
# Stub Gitlab::Configuration
allow(@request).to receive(:httparty).and_return(
headers: { 'Cookie' => 'gitlab_canary=true' }
)
stub_request(:get, path)
@request.get('/version')
expect(a_request(:get, path).with(headers: {
'PRIVATE_TOKEN' => 'token',
'Cookie' => 'gitlab_canary=true'
}.merge(described_class.headers))).to have_been_made
end
it 'does not modify options in-place' do
options = { per_page: 10 }
original_options = options.dup
@request.private_token = 'token'
@request.endpoint = 'https://example.com/api/v4'
# Stub Gitlab::Configuration
allow(@request).to receive(:httparty).and_return(nil)
stub_request(:get, "#{@request.endpoint}/projects")
@request.get('/projects', options)
expect(options).to eq(original_options)
end
end
describe '#authorization_header' do
it 'raises MissingCredentials when auth_token and private_token are not set' do
expect do
@request.send(:authorization_header)
end.to raise_error(Gitlab::Error::MissingCredentials)
end
it 'sets the correct header when given a private_token' do
@request.private_token = 'ys9BtunN3rDKbaJCYXaN'
expect(@request.send(:authorization_header)).to eq('PRIVATE-TOKEN' => 'ys9BtunN3rDKbaJCYXaN')
end
it 'sets the correct header when setting an auth_token via the private_token config option' do
@request.private_token = '3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603'
expect(@request.send(:authorization_header)).to eq('Authorization' => 'Bearer 3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603')
end
end
describe 'errors' do
before do
@request.private_token = 'token'
@request.endpoint = 'https://example.com/api/v4'
@rpath = "#{@request.endpoint}/version"
allow(@request).to receive(:httparty)
end
it 'raises error for 5xx status code without special error class' do
stub_request(:get, @rpath).to_return(status: 599)
expect { @request.get('/version') }.to raise_error(Gitlab::Error::ResponseError)
expect(a_request(:get, @rpath)).to have_been_made
end
it 'raises error for 4xx status code without special error class' do
stub_request(:get, @rpath).to_return(status: 499)
expect { @request.get('/version') }.to raise_error(Gitlab::Error::ResponseError)
expect(a_request(:get, @rpath)).to have_been_made
end
end
describe 'ratelimiting' do
before do
@request.private_token = 'token'
@request.endpoint = 'https://example.com/api/v4'
@rpath = "#{@request.endpoint}/version"
allow(@request).to receive(:httparty)
end
it 'tries 3 times when ratelimited by default' do
stub_request(:get, @rpath)
.to_return(
status: 429,
headers: { 'Retry-After' => 1 }
)
expect do
@request.get('/version')
end.to raise_error(Gitlab::Error::TooManyRequests)
expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(3)
end
it 'tries 4 times when ratelimited with option' do
stub_request(:get, @rpath)
.to_return(
status: 429,
headers: { 'Retry-After' => 1 }
)
expect do
@request.get('/version', { ratelimit_retries: 4 })
end.to raise_error(Gitlab::Error::TooManyRequests)
expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(4)
end
it 'handles one retry then success' do
stub_request(:get, @rpath)
.to_return(
status: 429,
headers: { 'Retry-After' => 1 }
).times(1).then
.to_return(
status: 200
).times(1)
@request.get('/version')
expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(2)
end
it 'survives a 429 with no Retry-After header' do
stub_request(:get, @rpath)
.to_return(
status: 429
)
expect do
@request.get('/version')
end.to raise_error(Gitlab::Error::TooManyRequests)
expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(3)
end
end
describe 'redirection' do
it 'redirect GET' do
http_endpoint = 'http://example.com/api/v4'
https_endpoint = 'https://example.com:443/api/v4'
http_path = "#{http_endpoint}/version"
https_path = "#{https_endpoint}/version"
token = 'token'
@request.private_token = token
@request.endpoint = http_endpoint
allow(@request).to receive(:httparty)
stub_request(:get, http_path)
.to_return(
status: [301, 'Moved Permanently'],
headers: { location: https_path }
)
stub_request(:get, https_path)
.to_return(status: 200)
@request.get('/version')
expect(a_request(:get, http_path).with(headers: {
'PRIVATE_TOKEN' => token
}.merge(described_class.headers))).to have_been_made
expect(a_request(:get, https_path).with(headers: {
'PRIVATE_TOKEN' => token
}.merge(described_class.headers))).to have_been_made
end
it 'redirect PUT' do
http_endpoint = 'http://example.com/api/v4'
https_endpoint = 'https://example.com:443/api/v4'
http_path = "#{http_endpoint}/application/settings"
https_path = "#{https_endpoint}/application/settings"
token = 'token'
body = 'signup_enabled=true'
@request.private_token = token
@request.endpoint = http_endpoint
allow(@request).to receive(:httparty)
stub_request(:put, http_path)
.with(body: body)
.to_return(
status: [301, 'Moved Permanently'],
headers: { location: https_path }
)
stub_request(:put, https_path)
.with(body: body)
.to_return(
status: 200,
body: '{}'
)
# simulate Gitlab.edit_application_settings(signup_enabled: true)
@request.put('/application/settings', body: body)
expect(
a_request(:put, http_path).with(
body: body,
headers: {
'PRIVATE_TOKEN' => token
}.merge(described_class.headers)
)
).to have_been_made
expect(
a_request(:put, https_path).with(
body: body,
headers: {
'PRIVATE_TOKEN' => token
}.merge(described_class.headers)
)
).to have_been_made
end
end
end
|
