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
|
from __future__ import annotations
import time
from pprint import pprint # pylint: disable=unused-import
from threading import Thread
from typing import Any
from urllib.parse import quote, unquote
import pytest
from urllib3 import PoolManager
from urllib3.response import BaseHTTPResponse
from urllib3.util.retry import Retry
import test_server
from test_server import (
Request,
RequestNotProcessedError,
Response,
TestServer,
TestServerError,
WaitTimeoutError,
)
from test_server.server import INTERNAL_ERROR_RESPONSE_STATUS
# file is missing from tarball
#from .util import fixture_global_server, fixture_server # pylint: disable=unused-import
from collections.abc import Generator
from threading import Lock
import pytest
from typing import TypedDict
from test_server import TestServer
class CacheDict(TypedDict, total=False):
server: TestServer
CACHE: CacheDict = {}
CACHE_LOCK = Lock()
@pytest.fixture(scope="session", name="global_server")
def fixture_global_server() -> Generator[TestServer, None, None]:
with CACHE_LOCK:
if "server" not in CACHE:
srv = TestServer()
srv.start()
CACHE["server"] = srv
yield CACHE["server"]
with CACHE_LOCK:
if CACHE["server"]:
CACHE["server"].stop()
del CACHE["server"]
@pytest.fixture(name="server")
def fixture_server(global_server: TestServer) -> TestServer:
global_server.reset()
return global_server
NETWORK_TIMEOUT = 1
SPECIFIC_TEST_PORT = 10100
HTTP_STATUS_OK = 200
pool = PoolManager()
def request(
url: str,
data: None | bytes = None,
method: None | str = None,
headers: None | dict[str, Any] = None,
fields: None | dict[str, Any] = None,
retries_redirect: int = 10,
) -> BaseHTTPResponse:
params: dict[str, Any] = {
"headers": headers,
"timeout": NETWORK_TIMEOUT,
"retries": Retry(
total=None,
connect=0,
read=0,
redirect=retries_redirect,
other=0,
),
"fields": fields,
}
if data:
assert isinstance(data, bytes)
params["body"] = data
if not method:
method = "POST" if (data or fields) else "GET"
return pool.request(method, url, **params)
# WTF: urllib3 makes TWO requests :-/
# def test_non_ascii_header(server: TestServer) -> None:
# server.add_response(Response(headers=[("z", server.get_url() + "фыва")]))
# res = request(server.get_url(), retries_redirect=False)
# print(res.headers)
def test_non_ascii_header(server: TestServer) -> None:
server.add_response(
Response(status=301, headers=[("Location", server.get_url(quote("фыва")))])
)
server.add_response(Response())
request(server.get_url())
assert quote("фыва") in server.get_request().path
def test_get(server: TestServer) -> None:
valid_data = b"zorro"
server.add_response(Response(data=valid_data))
res = request(server.get_url())
assert res.data == valid_data
def test_non_utf_request_data(server: TestServer) -> None:
server.add_response(Response(data=b"abc"))
res = request(url=server.get_url(), data="конь".encode("cp1251"))
assert res.data == b"abc"
assert server.get_request().data == "конь".encode("cp1251")
def test_request_client_ip(server: TestServer) -> None:
server.add_response(Response())
request(server.get_url())
assert server.address == server.get_request().client_ip
def test_path(server: TestServer) -> None:
server.add_response(Response())
request(server.get_url("/foo?bar=1"))
assert server.get_request().path == "/foo"
assert server.get_request().args["bar"] == "1"
def test_post(server: TestServer) -> None:
server.add_response(Response(data=b"abc"), method="post")
res = request(server.get_url(), b"req-data")
assert res.data == b"abc"
assert server.get_request().data == b"req-data"
def test_response_once_specific_method(server: TestServer) -> None:
server.add_response(Response(data=b"bar"), method="get")
server.add_response(Response(data=b"foo"))
assert request(server.get_url()).data == b"bar"
def test_request_headers(server: TestServer) -> None:
server.add_response(Response())
request(server.get_url(), headers={"Foo": "Bar"})
assert server.get_request().headers.get("foo") == "Bar"
def test_response_once_reset_headers(server: TestServer) -> None:
server.add_response(Response(headers=[("foo", "bar")]))
server.reset()
res = request(server.get_url())
assert res.status == INTERNAL_ERROR_RESPONSE_STATUS
assert b"No response" in res.data
def test_method_sleep(server: TestServer) -> None:
server.add_response(Response())
delay = 0.3
start = time.time()
request(server.get_url())
elapsed = time.time() - start
assert elapsed <= delay
server.add_response(Response(sleep=delay))
start = time.time()
request(server.get_url())
elapsed = time.time() - start
assert elapsed > delay
def test_request_done_after_start(server: TestServer) -> None:
server = TestServer()
try:
server.start()
assert not server.request_is_done()
finally:
server.stop()
def test_request_done(server: TestServer) -> None:
assert not server.request_is_done()
server.add_response(Response())
request(server.get_url())
assert server.request_is_done()
def test_wait_request(server: TestServer) -> None:
server.add_response(Response(data=b"foo"))
def worker() -> None:
time.sleep(1)
request(server.get_url("?method=test-wait-request"))
th = Thread(target=worker)
th.start()
with pytest.raises(WaitTimeoutError):
server.wait_request(0.5)
server.wait_request(2)
th.join()
def test_request_cookies(server: TestServer) -> None:
server.add_response(Response())
request(url=server.get_url(), headers={"Cookie": "foo=bar"})
assert server.get_request().cookies["foo"].value == "bar"
def test_default_header_content_type(server: TestServer) -> None:
server.add_response(Response())
info = request(server.get_url())
assert info.headers["content-type"] == "text/html; charset=utf-8"
def test_custom_header_content_type(server: TestServer) -> None:
server.add_response(
Response(headers=[("Content-Type", "text/html; charset=koi8-r")])
)
info = request(server.get_url())
assert info.headers["content-type"] == "text/html; charset=koi8-r"
def test_default_header_server(server: TestServer) -> None:
server.add_response(Response())
info = request(server.get_url())
assert info.headers["server"] == ("TestServer/%s" % test_server.__version__)
def test_custom_header_server(server: TestServer) -> None:
server.add_response(Response(headers=[("Server", "Google")]))
info = request(server.get_url())
assert info.headers["server"] == "Google"
def test_options_method(server: TestServer) -> None:
server.add_response(Response(data=b"abc"))
res = request(url=server.get_url(), method="OPTIONS")
assert server.get_request().method == "OPTIONS"
assert res.data == b"abc"
def test_multiple_start_stop_cycles() -> None:
for _ in range(30):
server = TestServer()
server.start()
try:
server.add_response(Response(data=b"zorro"), count=10)
for _ in range(10):
res = request(server.get_url())
assert res.data == b"zorro"
finally:
server.stop()
def test_specific_port() -> None:
server = TestServer(address="localhost", port=SPECIFIC_TEST_PORT)
try:
server.start()
server.add_response(Response(data=b"abc"))
data = request(server.get_url()).data
assert data == b"abc"
finally:
server.stop()
def test_null_bytes(server: TestServer) -> None:
server.add_response(
Response(
status=302,
headers=[
("Location", server.get_url().rstrip("/") + "/\x00/"),
],
)
)
server.add_response(Response(data=b"zzz"))
res = request(server.get_url())
assert res.data == b"zzz"
assert unquote(server.get_request().path) == "/\x00/"
def test_callback(server: TestServer) -> None:
def get_callback() -> dict[str, Any]:
return {
"type": "response",
"data": b"Hello",
"headers": [
("method", "get"),
],
}
def post_callback() -> dict[str, Any]:
return {
"type": "response",
"status": 201,
"data": b"hey",
"headers": [
("method", "post"),
("set-cookie", "foo=bar"),
],
}
server.add_response(Response(callback=get_callback))
server.add_response(Response(callback=post_callback), method="post")
info = request(server.get_url())
assert info.headers.get("method") == "get"
assert info.data == b"Hello"
info = request(server.get_url(), b"key=val")
assert info.headers["method"] == "post"
assert info.headers["set-cookie"] == "foo=bar"
assert info.data == b"hey"
assert info.status == 201 # noqa: PLR2004
def test_response_data_invalid_type(server: TestServer) -> None:
server.add_response(Response(data=1)) # type: ignore[arg-type]
res = request(server.get_url())
assert res.status == INTERNAL_ERROR_RESPONSE_STATUS
assert b"must be bytes" in res.data
def test_stop_not_started_server() -> None:
server = TestServer()
server.stop()
def test_start_request_stop_same_port() -> None:
server = TestServer()
for _ in range(10):
try:
server.start()
server.add_response(Response())
request(server.get_url())
finally:
server.stop()
def test_file_uploading(server: TestServer) -> None:
server.add_response(Response())
request(
server.get_url(),
fields={
"image": ("emoji.png", b"zzz"),
},
)
img_file = server.get_request().files["image"][0]
assert img_file["name"] == "image"
def test_callback_response_not_dict(server: TestServer) -> None:
def callback() -> list[str]:
return ["foo", "bar"]
server.add_response(Response(callback=callback)) # type: ignore[arg-type]
res = request(server.get_url())
assert res.status == INTERNAL_ERROR_RESPONSE_STATUS
assert b"is not a dict" in res.data
def test_callback_response_invalid_type(server: TestServer) -> None:
def callback() -> dict[str, Any]:
return {
"foo": "bar",
}
server.add_response(Response(callback=callback))
res = request(server.get_url())
assert res.status == INTERNAL_ERROR_RESPONSE_STATUS
assert b"invalid type key" in res.data
def test_callback_response_invalid_key(server: TestServer) -> None:
def callback() -> dict[str, Any]:
return {
"type": "response",
"foo": "bar",
}
server.add_response(Response(callback=callback))
res = request(server.get_url())
assert res.status == INTERNAL_ERROR_RESPONSE_STATUS
assert b"contains invalid key" in res.data
def test_callback_data_non_bytes(server: TestServer) -> None:
def callback() -> dict[str, Any]:
return {
"type": "response",
"data": "bar",
}
server.add_response(Response(callback=callback))
res = request(server.get_url())
assert res.status == INTERNAL_ERROR_RESPONSE_STATUS
assert b"must be bytes" in res.data
def test_invalid_response_key() -> None:
with pytest.raises(TypeError) as ex:
# pylint: disable=unexpected-keyword-arg
Response(foo="bar") # type: ignore[call-arg]
assert "unexpected keyword argument" in str(ex.value)
def test_get_request_no_request(server: TestServer) -> None:
with pytest.raises(RequestNotProcessedError):
server.get_request()
def test_add_response_invalid_method(server: TestServer) -> None:
with pytest.raises(TestServerError) as ex:
server.add_response(Response(), method="foo")
assert "Invalid method" in str(ex.value)
def test_add_response_count_minus_one(server: TestServer) -> None:
server.add_response(Response(), count=-1)
for _ in range(3):
assert request(server.get_url()).status == HTTP_STATUS_OK
def test_add_response_count_one_default(server: TestServer) -> None:
server.add_response(Response())
assert request(server.get_url()).status == HTTP_STATUS_OK
assert b"No response" in request(server.get_url()).data
server.add_response(Response(), count=1)
assert request(server.get_url()).status == HTTP_STATUS_OK
assert b"No response" in request(server.get_url()).data
def test_add_response_count_two(server: TestServer) -> None:
server.add_response(Response(), count=2)
assert request(server.get_url()).status == HTTP_STATUS_OK
assert request(server.get_url()).status == HTTP_STATUS_OK
assert b"No response" in request(server.get_url()).data
def test_raw_callback(server: TestServer) -> None:
def callback() -> bytes:
return b"HTTP/1.0 200 OK\nFoo: Bar\nGaz: Baz\nContent-Length: 5\n\nhello"
server.add_response(Response(raw_callback=callback))
res = request(server.get_url())
assert "foo" in res.headers
assert res.data == b"hello"
def test_raw_callback_invalid_type(server: TestServer) -> None:
def callback() -> str:
return "hey"
server.add_response(Response(raw_callback=callback)) # type: ignore[arg-type]
res = request(server.get_url())
assert b"must return bytes" in res.data
def test_request_property(server: TestServer) -> None:
server.add_response(Response())
request(server.get_url())
assert isinstance(server.request, Request)
def test_put_request(server: TestServer) -> None:
server.add_response(Response())
request(server.get_url(), data=b"foo", method="put")
assert server.request.method == "PUT"
|