forked from python-gitlab/python-gitlab
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_gitlab_http_methods.py
More file actions
406 lines (314 loc) · 13.2 KB
/
test_gitlab_http_methods.py
File metadata and controls
406 lines (314 loc) · 13.2 KB
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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
import pytest
import requests
from httmock import HTTMock, response, urlmatch
from gitlab import GitlabHttpError, GitlabList, GitlabParsingError, RedirectError
def test_build_url(gl):
r = gl._build_url("http://localhost/api/v4")
assert r == "http://localhost/api/v4"
r = gl._build_url("https://localhost/api/v4")
assert r == "https://localhost/api/v4"
r = gl._build_url("/projects")
assert r == "http://localhost/api/v4/projects"
def test_http_request(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = '[{"name": "project1"}]'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
http_r = gl.http_request("get", "/projects")
http_r.json()
assert http_r.status_code == 200
def test_http_request_404(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/not_there", method="get")
def resp_cont(url, request):
content = {"Here is why it failed"}
return response(404, content, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl.http_request("get", "/not_there")
@pytest.mark.parametrize("status_code", [500, 502, 503, 504])
def test_http_request_with_only_failures(gl, status_code):
call_count = 0
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
nonlocal call_count
call_count += 1
return response(status_code, {"Here is why it failed"}, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl.http_request("get", "/projects")
assert call_count == 1
def test_http_request_with_retry_on_method_for_transient_failures(gl):
call_count = 0
calls_before_success = 3
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
nonlocal call_count
call_count += 1
status_code = 200 if call_count == calls_before_success else 500
return response(
status_code,
{"Failure is the stepping stone to success"},
{},
None,
5,
request,
)
with HTTMock(resp_cont):
http_r = gl.http_request("get", "/projects", retry_transient_errors=True)
assert http_r.status_code == 200
assert call_count == calls_before_success
def test_http_request_with_retry_on_class_for_transient_failures(gl_retry):
call_count = 0
calls_before_success = 3
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
nonlocal call_count
call_count += 1
status_code = 200 if call_count == calls_before_success else 500
return response(
status_code,
{"Failure is the stepping stone to success"},
{},
None,
5,
request,
)
with HTTMock(resp_cont):
http_r = gl_retry.http_request("get", "/projects")
assert http_r.status_code == 200
assert call_count == calls_before_success
def test_http_request_with_retry_on_class_and_method_for_transient_failures(gl_retry):
call_count = 0
calls_before_success = 3
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
nonlocal call_count
call_count += 1
status_code = 200 if call_count == calls_before_success else 500
return response(status_code, {"Here is why it failed"}, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl_retry.http_request("get", "/projects", retry_transient_errors=False)
assert call_count == 1
def create_redirect_response(
*, request: requests.models.PreparedRequest, http_method: str, api_path: str
) -> requests.models.Response:
"""Create a Requests response object that has a redirect in it"""
assert api_path.startswith("/")
http_method = http_method.upper()
# Create a history which contains our original request which is redirected
history = [
response(
status_code=302,
content="",
headers={"Location": f"http://example.com/api/v4{api_path}"},
reason="Moved Temporarily",
request=request,
)
]
# Create a "prepped" Request object to be the final redirect. The redirect
# will be a "GET" method as Requests changes the method to "GET" when there
# is a 301/302 redirect code.
req = requests.Request(
method="GET",
url=f"http://example.com/api/v4{api_path}",
)
prepped = req.prepare()
resp_obj = response(
status_code=200,
content="",
headers={},
reason="OK",
elapsed=5,
request=prepped,
)
resp_obj.history = history
return resp_obj
def test_http_request_302_get_does_not_raise(gl):
"""Test to show that a redirect of a GET will not cause an error"""
method = "get"
api_path = "/user/status"
@urlmatch(
scheme="http", netloc="localhost", path=f"/api/v4{api_path}", method=method
)
def resp_cont(
url: str, request: requests.models.PreparedRequest
) -> requests.models.Response:
resp_obj = create_redirect_response(
request=request, http_method=method, api_path=api_path
)
return resp_obj
with HTTMock(resp_cont):
gl.http_request(verb=method, path=api_path)
def test_http_request_302_put_raises_redirect_error(gl):
"""Test to show that a redirect of a PUT will cause an error"""
method = "put"
api_path = "/user/status"
@urlmatch(
scheme="http", netloc="localhost", path=f"/api/v4{api_path}", method=method
)
def resp_cont(
url: str, request: requests.models.PreparedRequest
) -> requests.models.Response:
resp_obj = create_redirect_response(
request=request, http_method=method, api_path=api_path
)
return resp_obj
with HTTMock(resp_cont):
with pytest.raises(RedirectError) as exc:
gl.http_request(verb=method, path=api_path)
error_message = exc.value.error_message
assert "Moved Temporarily" in error_message
assert "http://localhost/api/v4/user/status" in error_message
assert "http://example.com/api/v4/user/status" in error_message
def test_get_request(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url: str, request: requests.models.PreparedRequest):
headers = {"content-type": "application/json"}
content = '{"name": "project1"}'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
result = gl.http_get("/projects")
assert isinstance(result, dict)
assert result["name"] == "project1"
def test_get_request_raw(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
headers = {"content-type": "application/octet-stream"}
content = "content"
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
result = gl.http_get("/projects")
assert result.content.decode("utf-8") == "content"
def test_get_request_404(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/not_there", method="get")
def resp_cont(url, request):
content = {"Here is why it failed"}
return response(404, content, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl.http_get("/not_there")
def test_get_request_invalid_data(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = '["name": "project1"]'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabParsingError):
gl.http_get("/projects")
def test_list_request(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
headers = {"content-type": "application/json", "X-Total": 1}
content = '[{"name": "project1"}]'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
result = gl.http_list("/projects", as_list=True)
assert isinstance(result, list)
assert len(result) == 1
with HTTMock(resp_cont):
result = gl.http_list("/projects", as_list=False)
assert isinstance(result, GitlabList)
assert len(result) == 1
with HTTMock(resp_cont):
result = gl.http_list("/projects", all=True)
assert isinstance(result, list)
assert len(result) == 1
def test_list_request_404(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/not_there", method="get")
def resp_cont(url, request):
content = {"Here is why it failed"}
return response(404, content, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl.http_list("/not_there")
def test_list_request_invalid_data(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="get")
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = '["name": "project1"]'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabParsingError):
gl.http_list("/projects")
def test_post_request(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="post")
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = '{"name": "project1"}'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
result = gl.http_post("/projects")
assert isinstance(result, dict)
assert result["name"] == "project1"
def test_post_request_404(gl):
@urlmatch(
scheme="http", netloc="localhost", path="/api/v4/not_there", method="post"
)
def resp_cont(url, request):
content = {"Here is why it failed"}
return response(404, content, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl.http_post("/not_there")
def test_post_request_invalid_data(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="post")
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = '["name": "project1"]'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabParsingError):
gl.http_post("/projects")
def test_put_request(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="put")
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = '{"name": "project1"}'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
result = gl.http_put("/projects")
assert isinstance(result, dict)
assert result["name"] == "project1"
def test_put_request_404(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/not_there", method="put")
def resp_cont(url, request):
content = {"Here is why it failed"}
return response(404, content, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl.http_put("/not_there")
def test_put_request_invalid_data(gl):
@urlmatch(scheme="http", netloc="localhost", path="/api/v4/projects", method="put")
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = '["name": "project1"]'
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabParsingError):
gl.http_put("/projects")
def test_delete_request(gl):
@urlmatch(
scheme="http", netloc="localhost", path="/api/v4/projects", method="delete"
)
def resp_cont(url, request):
headers = {"content-type": "application/json"}
content = "true"
return response(200, content, headers, None, 5, request)
with HTTMock(resp_cont):
result = gl.http_delete("/projects")
assert isinstance(result, requests.Response)
assert result.json() is True
def test_delete_request_404(gl):
@urlmatch(
scheme="http", netloc="localhost", path="/api/v4/not_there", method="delete"
)
def resp_cont(url, request):
content = {"Here is why it failed"}
return response(404, content, {}, None, 5, request)
with HTTMock(resp_cont):
with pytest.raises(GitlabHttpError):
gl.http_delete("/not_there")