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
|
import platform
from threading import Thread, Lock
import json
import warnings
import time
import httpx
import aiohttp
import stripe
import pytest
from queue import Queue
from collections import defaultdict
from typing import List, Dict, Tuple, Optional
from stripe._stripe_client import StripeClient
if platform.python_implementation() == "PyPy":
pytest.skip("skip integration tests with PyPy", allow_module_level=True)
from http.server import BaseHTTPRequestHandler, HTTPServer
class MyTestHandler(BaseHTTPRequestHandler):
num_requests = 0
requests = defaultdict(Queue)
@classmethod
def _add_request(cls, req):
q = cls.requests[id(cls)]
q.put(req)
@classmethod
def get_requests(cls, n) -> List[BaseHTTPRequestHandler]:
reqs = []
for _ in range(n):
reqs.append(cls.requests[id(cls)].get(False))
assert cls.requests[id(cls)].empty()
return reqs
def do_GET(self):
return self._do_request()
def do_POST(self):
return self._do_request()
def _do_request(self):
n = self.__class__.num_requests
self.__class__.num_requests += 1
self._add_request(self)
provided_status, provided_headers, provided_body = self.do_request(n)
status = provided_status or self.default_status
headers = provided_headers or self.default_headers
body = provided_body or self.default_body
content_length = len(body)
self.send_response(status)
for header_name, header_value in headers.items():
self.send_header(header_name, header_value)
self.send_header("Content-Length", str(content_length))
self.end_headers()
self.wfile.write(body)
return
default_status = 200
default_headers = {"Content-Type": "application/json; charset=utf-8"}
default_body = json.dumps({}).encode("utf-8")
def do_request(
self, n: int
) -> Tuple[Optional[int], Optional[Dict[str, str]], Optional[bytes]]:
return (self.default_status, self.default_headers, self.default_body)
class TestIntegration(object):
mock_server = None
@pytest.fixture(autouse=True)
def close_mock_server(self):
yield
if self.mock_server:
self.mock_server.shutdown()
self.mock_server.server_close()
self.mock_server_thread.join()
@pytest.fixture(autouse=True)
def setup_stripe(self):
orig_attrs = {
"api_base": stripe.api_base,
"upload_api_base": stripe.upload_api_base,
"api_key": stripe.api_key,
"default_http_client": stripe.default_http_client,
"enable_telemetry": stripe.enable_telemetry,
"max_network_retries": stripe.max_network_retries,
"proxy": stripe.proxy,
}
stripe.api_base = "http://localhost:12111" # stripe-mock
stripe.upload_api_base = "http://localhost:12111" # stripe-mock
stripe.api_key = "sk_test_123"
stripe.default_http_client = None
stripe._default_proxy = None
stripe.enable_telemetry = False
stripe.max_network_retries = 3
yield
stripe.api_base = orig_attrs["api_base"]
stripe.upload_api_base = orig_attrs["api_base"]
stripe.api_key = orig_attrs["api_key"]
stripe.default_http_client = orig_attrs["default_http_client"]
stripe.enable_telemetry = orig_attrs["enable_telemetry"]
stripe.max_network_retries = orig_attrs["max_network_retries"]
stripe.proxy = orig_attrs["proxy"]
def setup_mock_server(self, handler):
# Configure mock server.
# Passing 0 as the port will cause a random free port to be chosen.
self.mock_server = HTTPServer(("localhost", 0), handler)
_, self.mock_server_port = self.mock_server.server_address
# Start running mock server in a separate thread.
# Daemon threads automatically shut down when the main process exits.
self.mock_server_thread = Thread(target=self.mock_server.serve_forever)
self.mock_server_thread.daemon = True
self.mock_server_thread.start()
def test_hits_api_base(self):
class MockServerRequestHandler(MyTestHandler):
pass
self.setup_mock_server(MockServerRequestHandler)
stripe.api_base = "http://localhost:%s" % self.mock_server_port
stripe.Balance.retrieve()
reqs = MockServerRequestHandler.get_requests(1)
assert reqs[0].path == "/v1/balance"
def test_hits_proxy_through_default_http_client(self):
class MockServerRequestHandler(MyTestHandler):
pass
self.setup_mock_server(MockServerRequestHandler)
stripe.proxy = "http://localhost:%s" % self.mock_server_port
stripe.Balance.retrieve()
assert MockServerRequestHandler.num_requests == 1
stripe.proxy = "http://bad-url"
with warnings.catch_warnings(record=True) as w:
stripe.Balance.retrieve()
assert len(w) == 1
assert "stripe.proxy was updated after sending a request" in str(
w[0].message
)
assert MockServerRequestHandler.num_requests == 2
def test_hits_proxy_through_custom_client(self):
class MockServerRequestHandler(MyTestHandler):
pass
self.setup_mock_server(MockServerRequestHandler)
stripe.default_http_client = stripe.new_default_http_client(
proxy="http://localhost:%s" % self.mock_server_port
)
stripe.Balance.retrieve()
assert MockServerRequestHandler.num_requests == 1
def test_hits_proxy_through_stripe_client_proxy(self):
class MockServerRequestHandler(MyTestHandler):
pass
self.setup_mock_server(MockServerRequestHandler)
client = stripe.StripeClient(
"sk_test_123",
proxy="http://localhost:%s" % self.mock_server_port,
base_addresses={"api": "http://localhost:12111"},
)
client.balance.retrieve()
assert MockServerRequestHandler.num_requests == 1
def test_hits_proxy_through_stripe_client_http_client(self):
class MockServerRequestHandler(MyTestHandler):
pass
self.setup_mock_server(MockServerRequestHandler)
client = stripe.StripeClient(
"sk_test_123",
http_client=stripe.http_client.new_default_http_client(
proxy="http://localhost:%s" % self.mock_server_port
),
base_addresses={"api": "http://localhost:12111"},
)
client.balance.retrieve()
assert MockServerRequestHandler.num_requests == 1
def test_passes_client_telemetry_when_enabled(self):
class MockServerRequestHandler(MyTestHandler):
def do_request(self, req_num):
if req_num == 0:
time.sleep(31 / 1000) # 31 ms
return [
200,
{
"Content-Type": "application/json; charset=utf-8",
"Request-Id": "req_%s" % (req_num + 1),
},
None,
]
self.setup_mock_server(MockServerRequestHandler)
stripe.api_base = "http://localhost:%s" % self.mock_server_port
stripe.enable_telemetry = True
cus = stripe.Customer("cus_xyz")
cus.description = "hello"
cus.save()
stripe.Customer.retrieve("cus_xyz")
stripe.Customer.retrieve("cus_xyz")
reqs = MockServerRequestHandler.get_requests(3)
# req 1
assert not reqs[0].headers.get("x-stripe-client-telemetry")
# req 2
telemetry_raw = reqs[1].headers.get("x-stripe-client-telemetry")
assert telemetry_raw is not None
telemetry = json.loads(telemetry_raw)
assert "last_request_metrics" in telemetry
duration_ms = telemetry["last_request_metrics"]["request_duration_ms"]
# The first request took 31 ms, so the client perceived
# latency shouldn't be outside this range.
assert 30 < duration_ms < 300
usage = telemetry["last_request_metrics"]["usage"]
assert usage == ["save"]
# req 3
telemetry_raw = reqs[2].headers.get("x-stripe-client-telemetry")
assert telemetry_raw is not None
metrics = json.loads(telemetry_raw)["last_request_metrics"]
assert metrics["request_id"] == "req_2"
assert "usage" not in metrics
def test_uses_thread_local_client_telemetry(self):
class MockServerRequestHandler(MyTestHandler):
local_num_requests = 0
seen_metrics = set()
stats_lock = Lock()
def do_request(self, _n):
with self.__class__.stats_lock:
self.__class__.local_num_requests += 1
req_num = self.__class__.local_num_requests
raw_telemetry = self.headers.get("X-Stripe-Client-Telemetry")
if raw_telemetry:
telemetry = json.loads(raw_telemetry)
req_id = telemetry["last_request_metrics"]["request_id"]
with self.__class__.stats_lock:
self.__class__.seen_metrics.add(req_id)
return [
200,
{
"Content-Type": "application/json; charset=utf-8",
"Request-Id": "req_%s" % (req_num),
},
None,
]
self.setup_mock_server(MockServerRequestHandler)
stripe.api_base = "http://localhost:%s" % self.mock_server_port
stripe.enable_telemetry = True
stripe.default_http_client = stripe.RequestsClient()
def work():
stripe.Balance.retrieve()
stripe.Balance.retrieve()
threads = [Thread(target=work) for _ in range(10)]
for t in threads:
t.start()
for t in threads:
t.join()
assert MockServerRequestHandler.num_requests == 20
assert len(MockServerRequestHandler.seen_metrics) == 10
@pytest.mark.anyio
async def test_measures_stripe_client_telemetry(self):
class MockServerRequestHandler(MyTestHandler):
def do_request(self, req_num):
return [
200,
{
"Content-Type": "application/json; charset=utf-8",
"Request-Id": "req_%s" % (req_num + 1),
},
None,
]
self.setup_mock_server(MockServerRequestHandler)
stripe.enable_telemetry = True
client = stripe.StripeClient(
"sk_test_123",
base_addresses={
"api": "http://localhost:%s" % self.mock_server_port
},
)
await client.customers.create_async()
await client.customers.create_async()
reqs = MockServerRequestHandler.get_requests(2)
telemetry_raw = reqs[1].headers.get("x-stripe-client-telemetry")
assert telemetry_raw is not None
telemetry = json.loads(telemetry_raw)
assert "last_request_metrics" in telemetry
usage = telemetry["last_request_metrics"]["usage"]
assert usage == ["stripe_client", "async"]
@pytest.mark.anyio
@pytest.fixture(params=["aiohttp", "httpx"])
async def async_http_client(self, request, anyio_backend):
if request.param == "httpx":
return stripe.HTTPXClient()
elif request.param == "aiohttp":
if anyio_backend != "asyncio":
return pytest.skip("aiohttp only works with asyncio")
return stripe.AIOHTTPClient()
else:
raise ValueError(f"Unknown http client name: {request.param}")
@pytest.fixture
async def set_global_async_http_client(self, async_http_client):
stripe.default_http_client = async_http_client
async def test_async_raw_request_success(
self, set_global_async_http_client
):
class MockServerRequestHandler(MyTestHandler):
default_body = '{"id": "cus_123", "object": "customer"}'.encode(
"utf-8"
)
pass
self.setup_mock_server(MockServerRequestHandler)
client = StripeClient(
"sk_test_123",
base_addresses={
"api": "http://localhost:%s" % self.mock_server_port
},
)
resp = await client.raw_request_async(
"post", "/v1/customers", description="My test customer"
)
cus = client.deserialize(resp.data, api_mode="V1")
reqs = MockServerRequestHandler.get_requests(1)
req = reqs[0]
assert req.path == "/v1/customers"
assert req.command == "POST"
assert isinstance(cus, stripe.Customer)
async def test_async_raw_request_timeout(
self, set_global_async_http_client
):
class MockServerRequestHandler(MyTestHandler):
def do_request(self, n):
time.sleep(0.02)
return super().do_request(n)
self.setup_mock_server(MockServerRequestHandler)
# If we set HTTPX's generic timeout the test is flaky (sometimes it's a ReadTimeout, sometimes its a ConnectTimeout)
# so we set only the read timeout specifically.
hc = stripe.default_http_client
expected_message = ""
if isinstance(hc, stripe.HTTPXClient):
hc._timeout = httpx.Timeout(None, read=0.01)
expected_message = "A ReadTimeout was raised"
elif isinstance(hc, stripe.AIOHTTPClient):
hc._timeout = aiohttp.ClientTimeout(sock_read=0.01)
expected_message = "A ServerTimeoutError was raised"
else:
raise ValueError(f"Unknown http client: {hc.name}")
exception = None
try:
client = StripeClient(
"sk_test_123",
http_client=hc,
base_addresses={
"api": "http://localhost:%s" % self.mock_server_port
},
max_network_retries=0,
)
await client.raw_request_async(
"post", "/v1/customers", description="My test customer"
)
except stripe.APIConnectionError as e:
exception = e
assert exception is not None
assert expected_message in str(exception.user_message)
async def test_async_raw_request_retries(
self, set_global_async_http_client
):
class MockServerRequestHandler(MyTestHandler):
def do_request(self, n):
if n == 0:
return (
500,
{"Request-Id": "req_1"},
b'{"error": {"message": "Internal server error"}}',
)
return (200, None, None)
pass
self.setup_mock_server(MockServerRequestHandler)
client = StripeClient(
"sk_test_123",
base_addresses={
"api": "http://localhost:%s" % self.mock_server_port
},
max_network_retries=stripe.max_network_retries,
)
await client.raw_request_async(
"post", "/v1/customers", description="My test customer"
)
reqs = MockServerRequestHandler.get_requests(2)
req = reqs[0]
assert req.path == "/v1/customers"
async def test_async_raw_request_unretryable(
self, set_global_async_http_client
):
class MockServerRequestHandler(MyTestHandler):
def do_request(self, n):
return (
401,
{"Request-Id": "req_1"},
b'{"error": {"message": "Unauthorized"}}',
)
pass
self.setup_mock_server(MockServerRequestHandler)
exception = None
try:
client = StripeClient(
"sk_test_123",
base_addresses={
"api": "http://localhost:%s" % self.mock_server_port
},
)
await client.raw_request_async(
"post", "/v1/customers", description="My test customer"
)
except stripe.AuthenticationError as e:
exception = e
MockServerRequestHandler.get_requests(1)
assert exception is not None
assert "Unauthorized" in str(exception.user_message)
async def test_async_httpx_stream(self, set_global_async_http_client):
class MockServerRequestHandler(MyTestHandler):
def do_request(self, n):
return (200, None, b"hello")
self.setup_mock_server(MockServerRequestHandler)
stripe.upload_api_base = "http://localhost:%s" % self.mock_server_port
result = await stripe.Quote.pdf_async("qt_123")
assert str(await result.read_async(), "utf-8") == "hello"
async def test_async_httpx_stream_error(
self, set_global_async_http_client
):
class MockServerRequestHandler(MyTestHandler):
def do_request(self, n):
return (400, None, b'{"error": {"message": "bad request"}}')
self.setup_mock_server(MockServerRequestHandler)
stripe.upload_api_base = "http://localhost:%s" % self.mock_server_port
try:
await stripe.Quote.pdf_async("qt_123")
except stripe.InvalidRequestError as e:
assert "bad request" in str(e.user_message)
|