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
762 lines (615 loc) · 21 KB
/
test_gitlab_http_methods.py
File metadata and controls
762 lines (615 loc) · 21 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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
import copy
import warnings
import pytest
import requests
import responses
from gitlab import GitlabHttpError, GitlabList, GitlabParsingError, RedirectError
from gitlab.client import RETRYABLE_TRANSIENT_ERROR_CODES
from tests.unit import helpers
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"
@responses.activate
def test_http_request(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.GET,
url=url,
json=[{"name": "project1"}],
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
http_r = gl.http_request("get", "/projects")
http_r.json()
assert http_r.status_code == 200
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_http_request_with_url_encoded_kwargs_does_not_duplicate_params(gl):
url = "http://localhost/api/v4/projects?topics%5B%5D=python"
responses.add(
method=responses.GET,
url=url,
json=[{"name": "project1"}],
status=200,
match=[responses.matchers.query_param_matcher({"topics[]": "python"})],
)
kwargs = {"topics[]": "python"}
http_r = gl.http_request("get", "/projects?topics%5B%5D=python", **kwargs)
http_r.json()
assert http_r.status_code == 200
assert responses.assert_call_count(url, 1)
@responses.activate
def test_http_request_404(gl):
url = "http://localhost/api/v4/not_there"
responses.add(
method=responses.GET,
url=url,
json={},
status=400,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabHttpError):
gl.http_request("get", "/not_there")
assert responses.assert_call_count(url, 1) is True
@responses.activate
@pytest.mark.parametrize("status_code", RETRYABLE_TRANSIENT_ERROR_CODES)
def test_http_request_with_only_failures(gl, status_code):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.GET,
url=url,
json={},
status=status_code,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabHttpError):
gl.http_request("get", "/projects")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_http_request_with_retry_on_method_for_transient_failures(gl):
call_count = 0
calls_before_success = 3
url = "http://localhost/api/v4/projects"
def request_callback(request):
nonlocal call_count
call_count += 1
status_code = 200 if call_count >= calls_before_success else 500
headers = {}
body = "[]"
return (status_code, headers, body)
responses.add_callback(
method=responses.GET,
url=url,
callback=request_callback,
content_type="application/json",
)
http_r = gl.http_request("get", "/projects", retry_transient_errors=True)
assert http_r.status_code == 200
assert len(responses.calls) == calls_before_success
@responses.activate
@pytest.mark.parametrize(
"exception",
[
requests.ConnectionError("Connection aborted."),
requests.exceptions.ChunkedEncodingError("Connection broken."),
],
)
def test_http_request_with_retry_on_method_for_transient_network_failures(
gl, exception
):
call_count = 0
calls_before_success = 3
url = "http://localhost/api/v4/projects"
def request_callback(request):
nonlocal call_count
call_count += 1
status_code = 200
headers = {}
body = "[]"
if call_count >= calls_before_success:
return (status_code, headers, body)
raise exception
responses.add_callback(
method=responses.GET,
url=url,
callback=request_callback,
content_type="application/json",
)
http_r = gl.http_request("get", "/projects", retry_transient_errors=True)
assert http_r.status_code == 200
assert len(responses.calls) == calls_before_success
@responses.activate
def test_http_request_with_retry_on_class_for_transient_failures(gl_retry):
call_count = 0
calls_before_success = 3
url = "http://localhost/api/v4/projects"
def request_callback(request: requests.models.PreparedRequest):
nonlocal call_count
call_count += 1
status_code = 200 if call_count >= calls_before_success else 500
headers = {}
body = "[]"
return (status_code, headers, body)
responses.add_callback(
method=responses.GET,
url=url,
callback=request_callback,
content_type="application/json",
)
http_r = gl_retry.http_request("get", "/projects", retry_transient_errors=True)
assert http_r.status_code == 200
assert len(responses.calls) == calls_before_success
@responses.activate
def test_http_request_with_retry_on_class_for_transient_network_failures(gl_retry):
call_count = 0
calls_before_success = 3
url = "http://localhost/api/v4/projects"
def request_callback(request: requests.models.PreparedRequest):
nonlocal call_count
call_count += 1
status_code = 200
headers = {}
body = "[]"
if call_count >= calls_before_success:
return (status_code, headers, body)
raise requests.ConnectionError("Connection aborted.")
responses.add_callback(
method=responses.GET,
url=url,
callback=request_callback,
content_type="application/json",
)
http_r = gl_retry.http_request("get", "/projects", retry_transient_errors=True)
assert http_r.status_code == 200
assert len(responses.calls) == calls_before_success
@responses.activate
def test_http_request_with_retry_on_class_and_method_for_transient_failures(gl_retry):
call_count = 0
calls_before_success = 3
url = "http://localhost/api/v4/projects"
def request_callback(request):
nonlocal call_count
call_count += 1
status_code = 200 if call_count >= calls_before_success else 500
headers = {}
body = "[]"
return (status_code, headers, body)
responses.add_callback(
method=responses.GET,
url=url,
callback=request_callback,
content_type="application/json",
)
with pytest.raises(GitlabHttpError):
gl_retry.http_request("get", "/projects", retry_transient_errors=False)
assert len(responses.calls) == 1
@responses.activate
def test_http_request_with_retry_on_class_and_method_for_transient_network_failures(
gl_retry,
):
call_count = 0
calls_before_success = 3
url = "http://localhost/api/v4/projects"
def request_callback(request):
nonlocal call_count
call_count += 1
status_code = 200
headers = {}
body = "[]"
if call_count >= calls_before_success:
return (status_code, headers, body)
raise requests.ConnectionError("Connection aborted.")
responses.add_callback(
method=responses.GET,
url=url,
callback=request_callback,
content_type="application/json",
)
with pytest.raises(requests.ConnectionError):
gl_retry.http_request("get", "/projects", retry_transient_errors=False)
assert len(responses.calls) == 1
def create_redirect_response(
*, response: requests.models.Response, 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 = [
helpers.httmock_response(
status_code=302,
content="",
headers={"Location": f"http://example.com/api/v4{api_path}"},
reason="Moved Temporarily",
request=response.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 = helpers.httmock_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"
url = f"http://localhost/api/v4{api_path}"
def response_callback(
response: requests.models.Response,
) -> requests.models.Response:
return create_redirect_response(
response=response, http_method=method, api_path=api_path
)
with responses.RequestsMock(response_callback=response_callback) as req_mock:
req_mock.add(
method=responses.GET,
url=url,
status=302,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
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"
url = f"http://localhost/api/v4{api_path}"
def response_callback(
response: requests.models.Response,
) -> requests.models.Response:
return create_redirect_response(
response=response, http_method=method, api_path=api_path
)
with responses.RequestsMock(response_callback=response_callback) as req_mock:
req_mock.add(
method=responses.PUT,
url=url,
status=302,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
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
@responses.activate
def test_get_request(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.GET,
url=url,
json={"name": "project1"},
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
result = gl.http_get("/projects")
assert isinstance(result, dict)
assert result["name"] == "project1"
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_get_request_raw(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.GET,
url=url,
content_type="application/octet-stream",
body="content",
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
result = gl.http_get("/projects")
assert result.content.decode("utf-8") == "content"
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_get_request_404(gl):
url = "http://localhost/api/v4/not_there"
responses.add(
method=responses.GET,
url=url,
json=[],
status=404,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabHttpError):
gl.http_get("/not_there")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_get_request_invalid_data(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.GET,
url=url,
body='["name": "project1"]',
content_type="application/json",
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabParsingError):
result = gl.http_get("/projects")
print(type(result))
print(result.content)
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_head_request(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.HEAD,
url=url,
headers={"X-Total": "1"},
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
result = gl.http_head("/projects")
assert isinstance(result, requests.structures.CaseInsensitiveDict)
assert result["X-Total"] == "1"
@responses.activate
def test_list_request(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.GET,
url=url,
json=[{"name": "project1"}],
headers={"X-Total": "1"},
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with warnings.catch_warnings(record=True) as caught_warnings:
result = gl.http_list("/projects", iterator=False)
assert len(caught_warnings) == 0
assert isinstance(result, list)
assert len(result) == 1
result = gl.http_list("/projects", iterator=True)
assert isinstance(result, GitlabList)
assert len(list(result)) == 1
result = gl.http_list("/projects", get_all=True)
assert isinstance(result, list)
assert len(result) == 1
assert responses.assert_call_count(url, 3) is True
large_list_response = {
"method": responses.GET,
"url": "http://localhost/api/v4/projects",
"json": [
{"name": "project01"},
{"name": "project02"},
{"name": "project03"},
{"name": "project04"},
{"name": "project05"},
{"name": "project06"},
{"name": "project07"},
{"name": "project08"},
{"name": "project09"},
{"name": "project10"},
{"name": "project11"},
{"name": "project12"},
{"name": "project13"},
{"name": "project14"},
{"name": "project15"},
{"name": "project16"},
{"name": "project17"},
{"name": "project18"},
{"name": "project19"},
{"name": "project20"},
],
"headers": {"X-Total": "30", "x-per-page": "20"},
"status": 200,
"match": helpers.MATCH_EMPTY_QUERY_PARAMS,
}
@responses.activate
def test_as_list_deprecation_warning(gl):
responses.add(**large_list_response)
with warnings.catch_warnings(record=True) as caught_warnings:
result = gl.http_list("/projects", as_list=False)
assert len(caught_warnings) == 1
warning = caught_warnings[0]
assert isinstance(warning.message, DeprecationWarning)
message = str(warning.message)
assert "`as_list=False` is deprecated" in message
assert "Use `iterator=True` instead" in message
assert __file__ == warning.filename
assert not isinstance(result, list)
assert len(list(result)) == 20
assert len(responses.calls) == 1
@responses.activate
def test_list_request_pagination_warning(gl):
responses.add(**large_list_response)
with warnings.catch_warnings(record=True) as caught_warnings:
result = gl.http_list("/projects", iterator=False)
assert len(caught_warnings) == 1
warning = caught_warnings[0]
assert isinstance(warning.message, UserWarning)
message = str(warning.message)
assert "Calling a `list()` method" in message
assert "python-gitlab.readthedocs.io" in message
assert __file__ == warning.filename
assert isinstance(result, list)
assert len(result) == 20
assert len(responses.calls) == 1
@responses.activate
def test_list_request_iterator_true_nowarning(gl):
responses.add(**large_list_response)
with warnings.catch_warnings(record=True) as caught_warnings:
result = gl.http_list("/projects", iterator=True)
assert len(caught_warnings) == 0
assert isinstance(result, GitlabList)
assert len(list(result)) == 20
assert len(responses.calls) == 1
@responses.activate
def test_list_request_all_true_nowarning(gl):
responses.add(**large_list_response)
with warnings.catch_warnings(record=True) as caught_warnings:
result = gl.http_list("/projects", get_all=True)
assert len(caught_warnings) == 0
assert isinstance(result, list)
assert len(result) == 20
assert len(responses.calls) == 1
@responses.activate
def test_list_request_all_false_nowarning(gl):
responses.add(**large_list_response)
with warnings.catch_warnings(record=True) as caught_warnings:
result = gl.http_list("/projects", all=False)
assert len(caught_warnings) == 0
assert isinstance(result, list)
assert len(result) == 20
assert len(responses.calls) == 1
@responses.activate
def test_list_request_page_nowarning(gl):
response_dict = copy.deepcopy(large_list_response)
response_dict["match"] = [responses.matchers.query_param_matcher({"page": "1"})]
responses.add(**response_dict)
with warnings.catch_warnings(record=True) as caught_warnings:
gl.http_list("/projects", page=1)
assert len(caught_warnings) == 0
assert len(responses.calls) == 1
@responses.activate
def test_list_request_404(gl):
url = "http://localhost/api/v4/not_there"
responses.add(
method=responses.GET,
url=url,
json=[],
status=404,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabHttpError):
gl.http_list("/not_there")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_list_request_invalid_data(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.GET,
url=url,
body='["name": "project1"]',
content_type="application/json",
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabParsingError):
gl.http_list("/projects")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_post_request(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.POST,
url=url,
json={"name": "project1"},
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
result = gl.http_post("/projects")
assert isinstance(result, dict)
assert result["name"] == "project1"
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_post_request_404(gl):
url = "http://localhost/api/v4/not_there"
responses.add(
method=responses.POST,
url=url,
json=[],
status=404,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabHttpError):
gl.http_post("/not_there")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_post_request_invalid_data(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.POST,
url=url,
content_type="application/json",
body='["name": "project1"]',
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabParsingError):
gl.http_post("/projects")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_put_request(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.PUT,
url=url,
json={"name": "project1"},
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
result = gl.http_put("/projects")
assert isinstance(result, dict)
assert result["name"] == "project1"
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_put_request_404(gl):
url = "http://localhost/api/v4/not_there"
responses.add(
method=responses.PUT,
url=url,
json=[],
status=404,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabHttpError):
gl.http_put("/not_there")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_put_request_invalid_data(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.PUT,
url=url,
body='["name": "project1"]',
content_type="application/json",
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabParsingError):
gl.http_put("/projects")
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_delete_request(gl):
url = "http://localhost/api/v4/projects"
responses.add(
method=responses.DELETE,
url=url,
json=True,
status=200,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
result = gl.http_delete("/projects")
assert isinstance(result, requests.Response)
assert result.json() is True
assert responses.assert_call_count(url, 1) is True
@responses.activate
def test_delete_request_404(gl):
url = "http://localhost/api/v4/not_there"
responses.add(
method=responses.DELETE,
url=url,
json=[],
status=404,
match=helpers.MATCH_EMPTY_QUERY_PARAMS,
)
with pytest.raises(GitlabHttpError):
gl.http_delete("/not_there")
assert responses.assert_call_count(url, 1) is True