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
|
import inspect
from typing import (
Any,
Dict,
Iterator,
List,
NamedTuple,
Optional,
Sequence,
Tuple,
Type,
Union,
)
from unittest import mock
from warnings import warn
import httpx
from respx.utils import SetCookie
from .patterns import M, Pattern
from .types import (
CallableSideEffect,
Content,
CookieTypes,
HeaderTypes,
ResolvedResponseTypes,
RouteResultTypes,
SideEffectListTypes,
SideEffectTypes,
)
def clone_response(response: httpx.Response, request: httpx.Request) -> httpx.Response:
"""
Clones a httpx Response for given request.
"""
response = httpx.Response(
response.status_code,
headers=response.headers,
stream=response.stream,
request=request,
extensions=dict(response.extensions),
)
return response
class Call(NamedTuple):
request: httpx.Request
optional_response: Optional[httpx.Response]
@property
def response(self) -> httpx.Response:
if self.optional_response is None:
raise ValueError(f"{self!r} has no response")
return self.optional_response
@property
def has_response(self) -> bool:
return self.optional_response is not None
class CallList(list, mock.NonCallableMock):
def __init__(self, *args: Sequence[Call], name: Any = "respx") -> None:
super().__init__(*args)
mock.NonCallableMock.__init__(self, name=name)
@property
def called(self) -> bool: # type: ignore[override]
return bool(self)
@property
def call_count(self) -> int: # type: ignore[override]
return len(self)
@property
def last(self) -> Call:
return self[-1]
def record(
self, request: httpx.Request, response: Optional[httpx.Response]
) -> Call:
call = Call(request=request, optional_response=response)
self.append(call)
return call
class MockResponse(httpx.Response):
def __init__(
self,
status_code: Optional[int] = None,
*,
content: Optional[Content] = None,
content_type: Optional[str] = None,
http_version: Optional[str] = None,
cookies: Optional[Union[CookieTypes, Sequence[SetCookie]]] = None,
**kwargs: Any,
) -> None:
if not isinstance(content, (str, bytes)) and (
callable(content) or isinstance(content, (dict, Exception))
):
raise TypeError(
f"MockResponse content can only be str, bytes or byte stream"
f"got {content!r}. Please use json=... or side effects."
)
if content is not None:
kwargs["content"] = content
if http_version:
kwargs["extensions"] = kwargs.get("extensions", {})
kwargs["extensions"]["http_version"] = http_version.encode("ascii")
super().__init__(status_code or 200, **kwargs)
if content_type:
self.headers["Content-Type"] = content_type
if cookies:
if isinstance(cookies, dict):
cookies = tuple(cookies.items())
self.headers = httpx.Headers(
(
*self.headers.multi_items(),
*(
cookie if isinstance(cookie, SetCookie) else SetCookie(*cookie)
for cookie in cookies
),
)
)
class Route:
def __init__(
self,
*patterns: Pattern,
**lookups: Any,
) -> None:
self._pattern = M(*patterns, **lookups)
self._return_value: Optional[httpx.Response] = None
self._side_effect: Optional[SideEffectTypes] = None
self._pass_through: bool = False
self._name: Optional[str] = None
self._snapshots: List[Tuple] = []
self.calls = CallList(name=self)
self.snapshot()
def __eq__(self, other: object) -> bool:
if not isinstance(other, Route):
return False # pragma: nocover
return self.pattern == other.pattern
def __repr__(self): # pragma: nocover
name = f"name={self._name!r} " if self._name else ""
return f"<Route {name}{self.pattern!r}>"
def __call__(self, side_effect: CallableSideEffect) -> CallableSideEffect:
self.side_effect = side_effect
return side_effect
def __mod__(self, response: Union[int, Dict[str, Any], httpx.Response]) -> "Route":
if isinstance(response, int):
self.return_value = httpx.Response(status_code=response)
elif isinstance(response, dict):
response.setdefault("status_code", 200)
self.return_value = httpx.Response(**response)
elif isinstance(response, httpx.Response):
self.return_value = response
else:
raise TypeError(
f"Route can only % with int, dict or Response, got {response!r}"
)
return self
@property
def name(self) -> Optional[str]:
return self._name
@name.setter
def name(self, name: str) -> None:
raise NotImplementedError("Can't set name on route.")
@property
def pattern(self) -> Pattern:
return self._pattern
@pattern.setter
def pattern(self, pattern: Pattern) -> None:
raise NotImplementedError("Can't change route pattern.")
@property
def return_value(self) -> Optional[httpx.Response]:
return self._return_value
@return_value.setter
def return_value(self, return_value: Optional[httpx.Response]) -> None:
if return_value is not None and not isinstance(return_value, httpx.Response):
raise TypeError(f"{return_value!r} is not an instance of httpx.Response")
self.pass_through(False)
self._return_value = return_value
@property
def side_effect(
self,
) -> Optional[Union[SideEffectTypes, Sequence[SideEffectListTypes]]]:
return self._side_effect
@side_effect.setter
def side_effect(
self,
side_effect: Optional[Union[SideEffectTypes, Sequence[SideEffectListTypes]]],
) -> None:
self.pass_through(False)
if not side_effect:
self._side_effect = None
elif isinstance(side_effect, (Iterator, Sequence)):
self._side_effect = iter(side_effect)
else:
self._side_effect = side_effect
def snapshot(self) -> None:
# Clone iterator-type side effect to not get pre-exhausted when rolled back
side_effect = self._side_effect
if isinstance(side_effect, Iterator):
side_effects = tuple(side_effect)
self._side_effect = iter(side_effects)
side_effect = iter(side_effects)
self._snapshots.append(
(
self._pattern,
self._name,
self._return_value,
side_effect,
self._pass_through,
CallList(self.calls, name=self),
),
)
def rollback(self) -> None:
if not self._snapshots:
return
snapshot = self._snapshots.pop()
pattern, name, return_value, side_effect, pass_through, calls = snapshot
self._pattern = pattern
self._name = name
self._return_value = return_value
self._side_effect = side_effect
self.pass_through(pass_through)
self.calls[:] = calls
def reset(self) -> None:
self.calls.clear()
def mock(
self,
return_value: Optional[httpx.Response] = None,
*,
side_effect: Optional[
Union[SideEffectTypes, Sequence[SideEffectListTypes]]
] = None,
) -> "Route":
self.return_value = return_value
self.side_effect = side_effect
return self
def respond(
self,
status_code: int = 200,
*,
headers: Optional[HeaderTypes] = None,
cookies: Optional[Union[CookieTypes, Sequence[SetCookie]]] = None,
content: Optional[Content] = None,
text: Optional[str] = None,
html: Optional[str] = None,
json: Optional[Union[str, List, Dict]] = None,
stream: Optional[Union[httpx.SyncByteStream, httpx.AsyncByteStream]] = None,
content_type: Optional[str] = None,
http_version: Optional[str] = None,
**kwargs: Any,
) -> "Route":
response = MockResponse(
status_code,
headers=headers,
cookies=cookies,
content=content,
text=text,
html=html,
json=json,
stream=stream,
content_type=content_type,
http_version=http_version,
**kwargs,
)
return self.mock(return_value=response)
def pass_through(self, value: bool = True) -> "Route":
self._pass_through = value
return self
@property
def is_pass_through(self) -> bool:
return self._pass_through
@property
def called(self) -> bool:
return self.calls.called
@property
def call_count(self) -> int:
return self.calls.call_count
def _next_side_effect(
self,
) -> Union[CallableSideEffect, Exception, Type[Exception], httpx.Response]:
assert self._side_effect is not None
effect: Union[CallableSideEffect, Exception, Type[Exception], httpx.Response]
if isinstance(self._side_effect, Iterator):
effect = next(self._side_effect)
else:
effect = self._side_effect
return effect
def _call_side_effect(
self, effect: CallableSideEffect, request: httpx.Request, **kwargs: Any
) -> RouteResultTypes:
# Add route kwarg if the side effect wants it
argspec = inspect.getfullargspec(effect)
if "route" in kwargs:
warn(f"Matched context contains reserved word `route`: {self.pattern!r}")
if "route" in argspec.args:
kwargs["route"] = self
try:
# Call side effect
result: RouteResultTypes = effect(request, **kwargs)
except Exception as error:
raise SideEffectError(self, origin=error) from error
# Validate result
if (
result
and not inspect.isawaitable(result)
and not isinstance(result, (httpx.Response, httpx.Request))
):
raise TypeError(
f"Side effects must return; either a `httpx.Response`,"
f"a `httpx.Request` for pass-through, "
f"or `None` for a non-match. Got {result!r}"
)
return result
def _resolve_side_effect(
self, request: httpx.Request, **kwargs: Any
) -> RouteResultTypes:
effect = self._next_side_effect()
# Handle Exception `instance` side effect
if isinstance(effect, Exception):
raise SideEffectError(self, origin=effect)
# Handle Exception `type` side effect
elif isinstance(effect, type):
assert issubclass(effect, Exception)
raise SideEffectError(
self,
origin=(
effect("Mock Error", request=request)
if issubclass(effect, httpx.RequestError)
else effect()
),
)
# Handle `Callable` side effect
elif callable(effect):
result = self._call_side_effect(effect, request, **kwargs)
return result
# Resolved effect is a mocked response
return effect
def resolve(self, request: httpx.Request, **kwargs: Any) -> RouteResultTypes:
result: RouteResultTypes = None
if self._side_effect:
result = self._resolve_side_effect(request, **kwargs)
if result is None:
return None # Side effect resolved as a non-matching route
elif self._return_value:
result = self._return_value
else:
# Auto mock a new response
result = httpx.Response(200, request=request)
if isinstance(result, httpx.Response) and not result._request:
# Clone reused Response for immutability
result = clone_response(result, request)
return result
def match(self, request: httpx.Request) -> RouteResultTypes:
"""
Matches and resolves request with given patterns and optional side effect.
Returns None for a non-matching route, mocked response for a match,
or input request for pass-through.
"""
context: Dict[str, Any] = {}
if self._pattern:
match = self._pattern.match(request)
if not match:
return None
context = match.context
if self._pass_through:
return request
result = self.resolve(request, **context)
return result
class RouteList:
_routes: List[Route]
_names: Dict[str, Route]
def __init__(self, routes: Optional["RouteList"] = None) -> None:
if routes is None:
self._routes = []
self._names = {}
else:
self._routes = list(routes._routes)
self._names = dict(routes._names)
def __repr__(self) -> str:
return repr(self._routes) # pragma: nocover
def __iter__(self) -> Iterator[Route]:
return iter(self._routes)
def __bool__(self) -> bool:
return bool(self._routes)
def __len__(self) -> int:
return len(self._routes)
def __contains__(self, name: str) -> bool:
return name in self._names
def __getitem__(self, key: Union[int, str]) -> Route:
if isinstance(key, int):
return self._routes[key]
else:
return self._names[key]
def __setitem__(self, i: slice, routes: "RouteList") -> None:
"""
Re-set all routes to given routes.
"""
if (i.start, i.stop, i.step) != (None, None, None):
raise TypeError("Can't slice assign routes")
self._routes = list(routes._routes)
self._names = dict(routes._names)
def clear(self) -> None:
self._routes.clear()
self._names.clear()
def add(self, route: Route, name: Optional[str] = None) -> Route:
# Find route with same name
existing_route = self._names.pop(name or "", None)
if route in self._routes:
if existing_route and existing_route != route:
# Re-use existing route with same name, and drop any with same pattern
index = self._routes.index(route)
same_pattern_route = self._routes.pop(index)
if same_pattern_route.name:
del self._names[same_pattern_route.name]
same_pattern_route._name = None
elif not existing_route:
# Re-use existing route with same pattern
index = self._routes.index(route)
existing_route = self._routes[index]
if existing_route.name:
del self._names[existing_route.name]
existing_route._name = None
if existing_route:
# Update existing route's pattern and mock
existing_route._pattern = route._pattern
existing_route.return_value = route.return_value
existing_route.side_effect = route.side_effect
existing_route.pass_through(route.is_pass_through)
route = existing_route
else:
# Add new route
self._routes.append(route)
if name:
route._name = name
self._names[name] = route
return route
def pop(self, name, default=...):
"""
Removes a route by name and returns it.
Raises KeyError when `default` not provided and name is not found.
"""
try:
route = self._names.pop(name)
self._routes.remove(route)
return route
except KeyError as ex:
if default is ...:
raise ex
return default
class AllMockedAssertionError(AssertionError):
pass
class SideEffectError(Exception):
def __init__(self, route: Route, origin: Exception) -> None:
self.route = route
self.origin = origin
class PassThrough(Exception):
def __init__(self, message: str, *, request: httpx.Request, origin: Route) -> None:
super().__init__(message)
self.request = request
self.origin = origin
class ResolvedRoute:
def __init__(self):
self.route: Optional[Route] = None
self.response: Optional[ResolvedResponseTypes] = None
|