forked from stripe/stripe-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_http_client.py
986 lines (777 loc) · 33.4 KB
/
test_http_client.py
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
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
from __future__ import absolute_import, division, print_function
import pytest
import json
import stripe
import urllib3
from stripe import six, util
VALID_API_METHODS = ("get", "post", "delete")
class StripeClientTestCase(object):
REQUEST_LIBRARIES = ["urlfetch", "requests", "pycurl", "urllib.request"]
@pytest.fixture
def request_mocks(self, mocker):
request_mocks = {}
for lib in self.REQUEST_LIBRARIES:
request_mocks[lib] = mocker.patch("stripe.http_client.%s" % (lib,))
return request_mocks
class TestNewDefaultHttpClient(StripeClientTestCase):
@pytest.fixture(autouse=True)
def setup_warnings(self, request_mocks):
original_filters = stripe.http_client.warnings.filters[:]
stripe.http_client.warnings.simplefilter("ignore")
yield
stripe.http_client.warnings.filters = original_filters
def check_default(self, none_libs, expected):
for lib in none_libs:
setattr(stripe.http_client, lib, None)
inst = stripe.http_client.new_default_http_client()
assert isinstance(inst, expected)
def test_new_default_http_client_urlfetch(self):
self.check_default((), stripe.http_client.UrlFetchClient)
def test_new_default_http_client_requests(self):
self.check_default(("urlfetch",), stripe.http_client.RequestsClient)
def test_new_default_http_client_pycurl(self):
self.check_default(
("urlfetch", "requests"), stripe.http_client.PycurlClient
)
def test_new_default_http_client_urllib2(self):
self.check_default(
("urlfetch", "requests", "pycurl"),
stripe.http_client.Urllib2Client,
)
class TestRetrySleepTimeDefaultHttpClient(StripeClientTestCase):
from contextlib import contextmanager
def assert_sleep_times(self, client, expected):
until = len(expected)
actual = list(
map(lambda i: client._sleep_time_seconds(i + 1), range(until))
)
assert expected == actual
@contextmanager
def mock_max_delay(self, new_value):
original_value = stripe.http_client.HTTPClient.MAX_DELAY
stripe.http_client.HTTPClient.MAX_DELAY = new_value
try:
yield self
finally:
stripe.http_client.HTTPClient.MAX_DELAY = original_value
def test_sleep_time_exponential_back_off(self):
client = stripe.http_client.new_default_http_client()
client._add_jitter_time = lambda t: t
with self.mock_max_delay(10):
self.assert_sleep_times(client, [0.5, 1.0, 2.0, 4.0, 8.0])
def test_initial_delay_as_minimum(self):
client = stripe.http_client.new_default_http_client()
client._add_jitter_time = lambda t: t * 0.001
initial_delay = stripe.http_client.HTTPClient.INITIAL_DELAY
self.assert_sleep_times(client, [initial_delay] * 5)
def test_maximum_delay(self):
client = stripe.http_client.new_default_http_client()
client._add_jitter_time = lambda t: t
max_delay = stripe.http_client.HTTPClient.MAX_DELAY
expected = [0.5, 1.0, max_delay, max_delay, max_delay]
self.assert_sleep_times(client, expected)
def test_retry_after_header(self):
client = stripe.http_client.new_default_http_client()
client._add_jitter_time = lambda t: t
# Prefer retry-after if it's bigger
assert 30 == client._sleep_time_seconds(
2, (None, 409, {"retry-after": "30"})
)
# Prefer default if it's bigger
assert 2 == client._sleep_time_seconds(
3, (None, 409, {"retry-after": "1"})
)
# Ignore crazy-big values
assert 1 == client._sleep_time_seconds(
2, (None, 409, {"retry-after": "300"})
)
def test_randomness_added(self):
client = stripe.http_client.new_default_http_client()
random_value = 0.8
client._add_jitter_time = lambda t: t * random_value
base_value = stripe.http_client.HTTPClient.INITIAL_DELAY * random_value
with self.mock_max_delay(10):
expected = [
stripe.http_client.HTTPClient.INITIAL_DELAY,
base_value * 2,
base_value * 4,
base_value * 8,
base_value * 16,
]
self.assert_sleep_times(client, expected)
def test_jitter_has_randomness_but_within_range(self):
client = stripe.http_client.new_default_http_client()
jittered_ones = set(
map(lambda _: client._add_jitter_time(1), list(range(100)))
)
assert len(jittered_ones) > 1
assert all(0.5 <= val <= 1 for val in jittered_ones)
class TestRetryConditionsDefaultHttpClient(StripeClientTestCase):
def test_should_retry_on_codes(self):
one_xx = list(range(100, 104))
two_xx = list(range(200, 209))
three_xx = list(range(300, 308))
four_xx = list(range(400, 431))
client = stripe.http_client.new_default_http_client()
client._max_network_retries = lambda: 1
codes = one_xx + two_xx + three_xx + four_xx
codes.remove(409)
# These status codes should not be retried by default.
for code in codes:
assert client._should_retry((None, code, None), None, 0) is False
# These status codes should be retried by default.
assert client._should_retry((None, 409, None), None, 0) is True
assert client._should_retry((None, 500, None), None, 0) is True
assert client._should_retry((None, 503, None), None, 0) is True
def test_should_retry_on_error(self, mocker):
client = stripe.http_client.new_default_http_client()
client._max_network_retries = lambda: 1
api_connection_error = mocker.Mock()
api_connection_error.should_retry = True
assert client._should_retry(None, api_connection_error, 0) is True
api_connection_error.should_retry = False
assert client._should_retry(None, api_connection_error, 0) is False
def test_should_retry_on_stripe_should_retry_true(self, mocker):
client = stripe.http_client.new_default_http_client()
client._max_network_retries = lambda: 1
headers = {"stripe-should-retry": "true"}
# Ordinarily, we would not retry a 400, but with the header as true, we would.
assert client._should_retry((None, 400, {}), None, 0) is False
assert client._should_retry((None, 400, headers), None, 0) is True
def test_should_retry_on_stripe_should_retry_false(self, mocker):
client = stripe.http_client.new_default_http_client()
client._max_network_retries = lambda: 1
headers = {"stripe-should-retry": "false"}
# Ordinarily, we would retry a 500, but with the header as false, we would not.
assert client._should_retry((None, 500, {}), None, 0) is True
assert client._should_retry((None, 500, headers), None, 0) is False
def test_should_retry_on_num_retries(self, mocker):
client = stripe.http_client.new_default_http_client()
max_test_retries = 10
client._max_network_retries = lambda: max_test_retries
api_connection_error = mocker.Mock()
api_connection_error.should_retry = True
assert (
client._should_retry(
None, api_connection_error, max_test_retries + 1
)
is False
)
assert (
client._should_retry((None, 409, None), None, max_test_retries + 1)
is False
)
class TestHTTPClient(object):
@pytest.fixture(autouse=True)
def setup_stripe(self):
orig_attrs = {"enable_telemetry": stripe.enable_telemetry}
stripe.enable_telemetry = False
yield
stripe.enable_telemetry = orig_attrs["enable_telemetry"]
def test_sends_telemetry_on_second_request(self, mocker):
class TestClient(stripe.http_client.HTTPClient):
pass
stripe.enable_telemetry = True
url = "http://fake.url"
client = TestClient()
client.request = mocker.MagicMock(
return_value=["", 200, {"Request-Id": "req_123"}]
)
_, code, _ = client.request_with_retries("get", url, {}, None)
assert code == 200
client.request.assert_called_with("get", url, {}, None)
client.request = mocker.MagicMock(
return_value=["", 200, {"Request-Id": "req_234"}]
)
_, code, _ = client.request_with_retries("get", url, {}, None)
assert code == 200
args, _ = client.request.call_args
assert "X-Stripe-Client-Telemetry" in args[2]
telemetry = json.loads(args[2]["X-Stripe-Client-Telemetry"])
assert telemetry["last_request_metrics"]["request_id"] == "req_123"
class ClientTestBase(object):
@pytest.fixture
def request_mock(self, request_mocks):
return request_mocks[self.REQUEST_CLIENT.name]
@property
def valid_url(self, path="/foo"):
return "https://api.stripe.com%s" % (path,)
def make_request(self, method, url, headers, post_data):
client = self.REQUEST_CLIENT(verify_ssl_certs=True)
return client.request_with_retries(method, url, headers, post_data)
def make_request_stream(self, method, url, headers, post_data):
client = self.REQUEST_CLIENT(verify_ssl_certs=True)
return client.request_stream_with_retries(
method, url, headers, post_data
)
@pytest.fixture
def mock_response(self):
def mock_response(mock, body, code):
raise NotImplementedError(
"You must implement this in your test subclass"
)
return mock_response
@pytest.fixture
def mock_error(self):
def mock_error(mock, error):
raise NotImplementedError(
"You must implement this in your test subclass"
)
return mock_error
@pytest.fixture
def check_call(self):
def check_call(
mock, method, abs_url, headers, params, is_streaming=False
):
raise NotImplementedError(
"You must implement this in your test subclass"
)
return check_call
def test_request(self, request_mock, mock_response, check_call):
mock_response(request_mock, '{"foo": "baz"}', 200)
for method in VALID_API_METHODS:
abs_url = self.valid_url
data = ""
if method != "post":
abs_url = "%s?%s" % (abs_url, data)
data = None
headers = {"my-header": "header val"}
body, code, _ = self.make_request(method, abs_url, headers, data)
assert code == 200
assert body == '{"foo": "baz"}'
check_call(request_mock, method, abs_url, data, headers)
def test_request_stream(
self, mocker, request_mock, mock_response, check_call
):
for method in VALID_API_METHODS:
mock_response(request_mock, "some streamed content", 200)
abs_url = self.valid_url
data = ""
if method != "post":
abs_url = "%s?%s" % (abs_url, data)
data = None
headers = {"my-header": "header val"}
print(dir(self))
print("make_request_stream" in dir(self))
stream, code, _ = self.make_request_stream(
method, abs_url, headers, data
)
assert code == 200
# Here we need to convert and align all content on one type (string)
# as some clients return a string stream others a byte stream.
body_content = stream.read()
if hasattr(body_content, "decode"):
body_content = body_content.decode("utf-8")
assert body_content == "some streamed content"
mocker.resetall()
def test_exception(self, request_mock, mock_error):
mock_error(request_mock)
with pytest.raises(stripe.error.APIConnectionError):
self.make_request("get", self.valid_url, {}, None)
class RequestsVerify(object):
def __eq__(self, other):
return other and other.endswith("stripe/data/ca-certificates.crt")
class TestRequestsClient(StripeClientTestCase, ClientTestBase):
REQUEST_CLIENT = stripe.http_client.RequestsClient
@pytest.fixture
def session(self, mocker, request_mocks):
return mocker.MagicMock()
@pytest.fixture
def mock_response(self, mocker, session):
def mock_response(mock, body, code):
result = mocker.Mock()
result.content = body
result.status_code = code
result.headers = {}
result.raw = urllib3.response.HTTPResponse(
body=util.io.BytesIO(str.encode(body)),
preload_content=False,
status=code,
)
session.request = mocker.MagicMock(return_value=result)
mock.Session = mocker.MagicMock(return_value=session)
return mock_response
@pytest.fixture
def mock_error(self, mocker, session):
def mock_error(mock):
# The first kind of request exceptions we catch
mock.exceptions.SSLError = Exception
session.request.side_effect = mock.exceptions.SSLError()
mock.Session = mocker.MagicMock(return_value=session)
return mock_error
# Note that unlike other modules, we don't use the "mock" argument here
# because we need to run the request call against the internal mock
# session.
@pytest.fixture
def check_call(self, session):
def check_call(
mock,
method,
url,
post_data,
headers,
is_streaming=False,
timeout=80,
times=None,
):
times = times or 1
args = (method, url)
kwargs = {
"headers": headers,
"data": post_data,
"verify": RequestsVerify(),
"proxies": {"http": "http://slap/", "https": "http://slap/"},
"timeout": timeout,
}
if is_streaming:
kwargs["stream"] = True
calls = [(args, kwargs) for _ in range(times)]
session.request.assert_has_calls(calls)
return check_call
def make_request(self, method, url, headers, post_data, timeout=80):
client = self.REQUEST_CLIENT(
verify_ssl_certs=True, timeout=timeout, proxy="http://slap/"
)
return client.request_with_retries(method, url, headers, post_data)
def make_request_stream(self, method, url, headers, post_data, timeout=80):
client = self.REQUEST_CLIENT(
verify_ssl_certs=True, timeout=timeout, proxy="http://slap/"
)
return client.request_stream_with_retries(
method, url, headers, post_data
)
def test_timeout(self, request_mock, mock_response, check_call):
headers = {"my-header": "header val"}
data = ""
mock_response(request_mock, '{"foo": "baz"}', 200)
self.make_request("POST", self.valid_url, headers, data, timeout=5)
check_call(None, "POST", self.valid_url, data, headers, timeout=5)
def test_request_stream_forwards_stream_param(
self, mocker, request_mock, mock_response, check_call
):
mock_response(request_mock, "some streamed content", 200)
self.make_request_stream("GET", self.valid_url, {}, None)
check_call(
None,
"GET",
self.valid_url,
None,
{},
is_streaming=True,
)
class TestRequestClientRetryBehavior(TestRequestsClient):
@pytest.fixture
def response(self, mocker):
def response(code=200, headers={}):
result = mocker.Mock()
result.content = "{}"
result.status_code = code
result.headers = headers
result.raw = urllib3.response.HTTPResponse(
body=util.io.BytesIO(str.encode(result.content)),
preload_content=False,
status=code,
)
return result
return response
@pytest.fixture
def mock_retry(self, mocker, session, request_mock):
def mock_retry(retry_error_num=0, no_retry_error_num=0, responses=[]):
# Mocking classes of exception we catch. Any group of exceptions
# with the same inheritance pattern will work
request_root_error_class = Exception
request_mock.exceptions.RequestException = request_root_error_class
no_retry_parent_class = LookupError
no_retry_child_class = KeyError
request_mock.exceptions.SSLError = no_retry_parent_class
no_retry_errors = [no_retry_child_class()] * no_retry_error_num
retry_parent_class = EnvironmentError
retry_child_class = IOError
request_mock.exceptions.Timeout = retry_parent_class
request_mock.exceptions.ConnectionError = retry_parent_class
retry_errors = [retry_child_class()] * retry_error_num
# Include mock responses as possible side-effects
# to simulate returning proper results after some exceptions
session.request.side_effect = (
retry_errors + no_retry_errors + responses
)
request_mock.Session = mocker.MagicMock(return_value=session)
return request_mock
return mock_retry
@pytest.fixture
def check_call_numbers(self, check_call):
valid_url = self.valid_url
def check_call_numbers(times, is_streaming=False):
check_call(
None,
"GET",
valid_url,
None,
{},
times=times,
is_streaming=is_streaming,
)
return check_call_numbers
def max_retries(self):
return 3
def make_client(self):
client = self.REQUEST_CLIENT(
verify_ssl_certs=True, timeout=80, proxy="http://slap/"
)
# Override sleep time to speed up tests
client._sleep_time = lambda _: 0.0001
# Override configured max retries
client._max_network_retries = lambda: self.max_retries()
return client
def make_request(self, *args, **kwargs):
client = self.make_client()
return client.request_with_retries("GET", self.valid_url, {}, None)
def make_request_stream(self, *args, **kwargs):
client = self.make_client()
return client.request_stream_with_retries(
"GET", self.valid_url, {}, None
)
def test_retry_error_until_response(
self, mock_retry, response, check_call_numbers
):
mock_retry(retry_error_num=1, responses=[response(code=202)])
_, code, _ = self.make_request()
assert code == 202
check_call_numbers(2)
def test_retry_error_until_exceeded(
self, mock_retry, response, check_call_numbers
):
mock_retry(retry_error_num=self.max_retries())
with pytest.raises(stripe.error.APIConnectionError):
self.make_request()
check_call_numbers(self.max_retries())
def test_no_retry_error(self, mock_retry, response, check_call_numbers):
mock_retry(no_retry_error_num=self.max_retries())
with pytest.raises(stripe.error.APIConnectionError):
self.make_request()
check_call_numbers(1)
def test_retry_codes(self, mock_retry, response, check_call_numbers):
mock_retry(responses=[response(code=409), response(code=202)])
_, code, _ = self.make_request()
assert code == 202
check_call_numbers(2)
def test_retry_codes_until_exceeded(
self, mock_retry, response, check_call_numbers
):
mock_retry(responses=[response(code=409)] * (self.max_retries() + 1))
_, code, _ = self.make_request()
assert code == 409
check_call_numbers(self.max_retries() + 1)
def test_retry_request_stream_error_until_response(
self, mock_retry, response, check_call_numbers
):
mock_retry(retry_error_num=1, responses=[response(code=202)])
_, code, _ = self.make_request_stream()
assert code == 202
check_call_numbers(2, is_streaming=True)
def test_retry_request_stream_error_until_exceeded(
self, mock_retry, response, check_call_numbers
):
mock_retry(retry_error_num=self.max_retries())
with pytest.raises(stripe.error.APIConnectionError):
self.make_request_stream()
check_call_numbers(self.max_retries(), is_streaming=True)
def test_no_retry_request_stream_error(
self, mock_retry, response, check_call_numbers
):
mock_retry(no_retry_error_num=self.max_retries())
with pytest.raises(stripe.error.APIConnectionError):
self.make_request_stream()
check_call_numbers(1, is_streaming=True)
def test_retry_request_stream_codes(
self, mock_retry, response, check_call_numbers
):
mock_retry(responses=[response(code=409), response(code=202)])
_, code, _ = self.make_request_stream()
assert code == 202
check_call_numbers(2, is_streaming=True)
def test_retry_request_stream_codes_until_exceeded(
self, mock_retry, response, check_call_numbers
):
mock_retry(responses=[response(code=409)] * (self.max_retries() + 1))
_, code, _ = self.make_request_stream()
assert code == 409
check_call_numbers(self.max_retries() + 1, is_streaming=True)
@pytest.fixture
def connection_error(self, session):
client = self.REQUEST_CLIENT()
def connection_error(given_exception):
with pytest.raises(stripe.error.APIConnectionError) as error:
client._handle_request_error(given_exception)
return error.value
return connection_error
def test_handle_request_error_should_retry(
self, connection_error, mock_retry
):
request_mock = mock_retry()
error = connection_error(request_mock.exceptions.Timeout())
assert error.should_retry
error = connection_error(request_mock.exceptions.ConnectionError())
assert error.should_retry
def test_handle_request_error_should_not_retry(
self, connection_error, mock_retry
):
request_mock = mock_retry()
error = connection_error(request_mock.exceptions.SSLError())
assert error.should_retry is False
assert "not verify Stripe's SSL certificate" in error.user_message
error = connection_error(request_mock.exceptions.RequestException())
assert error.should_retry is False
# Mimic non-requests exception as not being children of Exception,
# See mock_retry for the exceptions setup
error = connection_error(BaseException(""))
assert error.should_retry is False
assert "configuration issue locally" in error.user_message
# Skip inherited basic requests client tests
def test_request(self, request_mock, mock_response, check_call):
pass
def test_exception(self, request_mock, mock_error):
pass
def test_timeout(self, request_mock, mock_response, check_call):
pass
class TestUrlFetchClient(StripeClientTestCase, ClientTestBase):
REQUEST_CLIENT = stripe.http_client.UrlFetchClient
@pytest.fixture
def mock_response(self, mocker):
def mock_response(mock, body, code):
result = mocker.Mock()
result.content = body
result.status_code = code
result.headers = {}
mock.fetch = mocker.Mock(return_value=result)
return mock_response
@pytest.fixture
def mock_error(self):
def mock_error(mock):
mock.Error = mock.InvalidURLError = Exception
mock.fetch.side_effect = mock.InvalidURLError()
return mock_error
@pytest.fixture
def check_call(self):
def check_call(
mock, method, url, post_data, headers, is_streaming=False
):
mock.fetch.assert_called_with(
url=url,
method=method,
headers=headers,
validate_certificate=True,
deadline=55,
payload=post_data,
)
return check_call
class TestUrllib2Client(StripeClientTestCase, ClientTestBase):
REQUEST_CLIENT = stripe.http_client.Urllib2Client
def make_client(self, proxy):
self.client = self.REQUEST_CLIENT(verify_ssl_certs=True, proxy=proxy)
self.proxy = proxy
def make_request(self, method, url, headers, post_data, proxy=None):
self.make_client(proxy)
return self.client.request_with_retries(
method, url, headers, post_data
)
def make_request_stream(self, method, url, headers, post_data, proxy=None):
self.make_client(proxy)
return self.client.request_stream_with_retries(
method, url, headers, post_data
)
@pytest.fixture
def mock_response(self, mocker):
def mock_response(mock, body, code):
response = mocker.Mock()
response.read = mocker.MagicMock(return_value=body)
response.code = code
response.info = mocker.Mock(return_value={})
self.request_object = mocker.Mock()
mock.Request = mocker.Mock(return_value=self.request_object)
mock.urlopen = mocker.Mock(return_value=response)
opener = mocker.Mock()
opener.open = mocker.Mock(return_value=response)
mock.build_opener = mocker.Mock(return_value=opener)
mock.build_opener.open = opener.open
mock.ProxyHandler = mocker.Mock(return_value=opener)
mock.urlopen = mocker.Mock(return_value=response)
return mock_response
@pytest.fixture
def mock_error(self):
def mock_error(mock):
mock.urlopen.side_effect = ValueError
mock.build_opener().open.side_effect = ValueError
mock.build_opener.reset_mock()
return mock_error
@pytest.fixture
def check_call(self):
def check_call(
mock, method, url, post_data, headers, is_streaming=False
):
if six.PY3 and isinstance(post_data, six.string_types):
post_data = post_data.encode("utf-8")
mock.Request.assert_called_with(url, post_data, headers)
if self.client._proxy:
assert isinstance(self.client._proxy, dict)
mock.ProxyHandler.assert_called_with(self.client._proxy)
mock.build_opener.open.assert_called_with(self.request_object)
assert not mock.urlopen.called
if not self.client._proxy:
mock.urlopen.assert_called_with(self.request_object)
assert not mock.build_opener.called
assert not mock.build_opener.open.called
return check_call
class TestUrllib2ClientHttpsProxy(TestUrllib2Client):
def make_request(self, method, url, headers, post_data, proxy=None):
return super(TestUrllib2ClientHttpsProxy, self).make_request(
method,
url,
headers,
post_data,
{"http": "http://slap/", "https": "http://slap/"},
)
def make_request_stream(self, method, url, headers, post_data, proxy=None):
return super(TestUrllib2ClientHttpsProxy, self).make_request_stream(
method,
url,
headers,
post_data,
{"http": "http://slap/", "https": "http://slap/"},
)
class TestUrllib2ClientHttpProxy(TestUrllib2Client):
def make_request(self, method, url, headers, post_data, proxy=None):
return super(TestUrllib2ClientHttpProxy, self).make_request(
method, url, headers, post_data, "http://slap/"
)
def make_request_stream(self, method, url, headers, post_data, proxy=None):
return super(TestUrllib2ClientHttpProxy, self).make_request_stream(
method, url, headers, post_data, "http://slap/"
)
class TestPycurlClient(StripeClientTestCase, ClientTestBase):
REQUEST_CLIENT = stripe.http_client.PycurlClient
def make_client(self, proxy):
self.client = self.REQUEST_CLIENT(verify_ssl_certs=True, proxy=proxy)
self.proxy = proxy
def make_request(self, method, url, headers, post_data, proxy=None):
self.make_client(proxy)
return self.client.request_with_retries(
method, url, headers, post_data
)
def make_request_stream(self, method, url, headers, post_data, proxy=None):
self.make_client(proxy)
return self.client.request_stream_with_retries(
method, url, headers, post_data
)
@pytest.fixture
def curl_mock(self, mocker):
return mocker.Mock()
@pytest.fixture
def request_mock(self, mocker, request_mocks, curl_mock):
lib_mock = request_mocks[self.REQUEST_CLIENT.name]
lib_mock.Curl = mocker.Mock(return_value=curl_mock)
return curl_mock
@pytest.fixture
def bio_mock(self, mocker):
bio_patcher = mocker.patch("stripe.util.io.BytesIO")
bio_mock = mocker.Mock()
bio_patcher.return_value = bio_mock
return bio_mock
@pytest.fixture
def mock_response(self, mocker, bio_mock):
def mock_response(mock, body, code):
bio_mock.getvalue = mocker.MagicMock(
return_value=body.encode("utf-8")
)
bio_mock.read = mocker.MagicMock(return_value=body.encode("utf-8"))
mock.getinfo.return_value = code
return mock_response
@pytest.fixture
def mock_error(self):
def mock_error(mock):
class FakeException(BaseException):
@property
def args(self):
return ("foo", "bar")
stripe.http_client.pycurl.error = FakeException
mock.perform.side_effect = stripe.http_client.pycurl.error
return mock_error
@pytest.fixture
def check_call(self, request_mocks):
def check_call(
mock, method, url, post_data, headers, is_streaming=False
):
lib_mock = request_mocks[self.REQUEST_CLIENT.name]
if self.client._proxy:
proxy = self.client._get_proxy(url)
assert proxy is not None
if proxy.hostname:
mock.setopt.assert_any_call(lib_mock.PROXY, proxy.hostname)
if proxy.port:
mock.setopt.assert_any_call(lib_mock.PROXYPORT, proxy.port)
if proxy.username or proxy.password:
mock.setopt.assert_any_call(
lib_mock.PROXYUSERPWD,
"%s:%s" % (proxy.username, proxy.password),
)
# A note on methodology here: we don't necessarily need to verify
# _every_ call to setopt, but check a few of them to make sure the
# right thing is happening. Keep an eye specifically on conditional
# statements where things are more likely to go wrong.
mock.setopt.assert_any_call(lib_mock.NOSIGNAL, 1)
mock.setopt.assert_any_call(lib_mock.URL, stripe.util.utf8(url))
if method == "get":
mock.setopt.assert_any_call(lib_mock.HTTPGET, 1)
elif method == "post":
mock.setopt.assert_any_call(lib_mock.POST, 1)
else:
mock.setopt.assert_any_call(
lib_mock.CUSTOMREQUEST, method.upper()
)
mock.perform.assert_any_call()
return check_call
class TestPycurlClientHttpProxy(TestPycurlClient):
def make_request(self, method, url, headers, post_data, proxy=None):
return super(TestPycurlClientHttpProxy, self).make_request(
method,
url,
headers,
post_data,
"http://user:withPwd@slap:8888/",
)
def make_request_stream(self, method, url, headers, post_data, proxy=None):
return super(TestPycurlClientHttpProxy, self).make_request_stream(
method,
url,
headers,
post_data,
"http://user:withPwd@slap:8888/",
)
class TestPycurlClientHttpsProxy(TestPycurlClient):
def make_request(self, method, url, headers, post_data, proxy=None):
return super(TestPycurlClientHttpsProxy, self).make_request(
method,
url,
headers,
post_data,
{"http": "http://slap:8888/", "https": "http://slap2:444/"},
)
def make_request_stream(self, method, url, headers, post_data, proxy=None):
return super(TestPycurlClientHttpsProxy, self).make_request_stream(
method,
url,
headers,
post_data,
{"http": "http://slap:8888/", "https": "http://slap2:444/"},
)
class TestAPIEncode(StripeClientTestCase):
def test_encode_dict(self):
body = {"foo": {"dob": {"month": 1}, "name": "bat"}}
values = [t for t in stripe.api_requestor._api_encode(body)]
assert ("foo[dob][month]", 1) in values
assert ("foo[name]", "bat") in values
def test_encode_array(self):
body = {"foo": [{"dob": {"month": 1}, "name": "bat"}]}
values = [t for t in stripe.api_requestor._api_encode(body)]
assert ("foo[0][dob][month]", 1) in values
assert ("foo[0][name]", "bat") in values