{{ message }}
forked from csernazs/pytest-httpserver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhttpserver.py
More file actions
879 lines (683 loc) · 31.9 KB
/
Copy pathhttpserver.py
File metadata and controls
879 lines (683 loc) · 31.9 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
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
import queue
import threading
import json
import time
from collections import defaultdict
from enum import Enum
from contextlib import suppress, contextmanager
from copy import copy
from typing import Callable, Mapping, Optional, Union
from ssl import SSLContext
from werkzeug.http import parse_authorization_header
from werkzeug.serving import make_server
from werkzeug.wrappers import Request, Response
URI_DEFAULT = ""
METHOD_ALL = "__ALL"
class Error(Exception):
"""
Base class for all exception defined in this package.
"""
pass
class NoHandlerError(Error):
"""
Raised when a :py:class:`RequestHandler` has no registered method to serve the request.
"""
pass
class HTTPServerError(Error):
"""
Raised when there's a problem with HTTP server.
"""
pass
class NoMethodFoundForMatchingHeaderValueError(Error):
"""
Raised when a :py:class:`HeaderValueMatcher` has no registered method to match the header value.
"""
pass
class WaitingSettings:
"""Class for providing default settings and storing them in HTTPServer
:param raise_assertions: whether raise assertions on unexpected request or timeout or not
:param stop_on_nohandler: whether stop on unexpected request or not
:param timeout: time (in seconds) until time is out
"""
def __init__(self, raise_assertions: bool = True, stop_on_nohandler: bool = True, timeout: float = 5):
self.raise_assertions = raise_assertions
self.stop_on_nohandler = stop_on_nohandler
self.timeout = timeout
class Waiting:
"""Class for HTTPServer.wait context manager
This class should not be instantiated directly."""
def __init__(self):
self._result = None
self._start = time.monotonic()
self._stop = None
def complete(self, result: bool):
self._result = result
self._stop = time.monotonic()
@property
def result(self) -> bool:
return self._result
@property
def elapsed_time(self) -> float:
"""Elapsed time in seconds"""
return self._stop - self._start
class HeaderValueMatcher:
"""
Matcher object for the header value of incoming request.
:param matchers: mapping from header name to comparator function that accepts actual and expected header values
and return whether they are equal as bool.
"""
DEFAULT_MATCHERS = {}
def __init__(self, matchers: Optional[Mapping[str, Callable[[str, str], bool]]] = None):
self.matchers = self.DEFAULT_MATCHERS if matchers is None else matchers
@staticmethod
def authorization_header_value_matcher(actual: str, expected: str) -> bool:
return parse_authorization_header(actual) == parse_authorization_header(expected)
@staticmethod
def default_header_value_matcher(actual: str, expected: str) -> bool:
return actual == expected
def __call__(self, header_name: str, actual: str, expected: str) -> bool:
try:
matcher = self.matchers[header_name]
except KeyError:
raise NoMethodFoundForMatchingHeaderValueError(
"No method found for matching header value: {}".format(header_name))
return matcher(actual, expected)
HeaderValueMatcher.DEFAULT_MATCHERS = defaultdict(
lambda: HeaderValueMatcher.default_header_value_matcher,
{'Authorization': HeaderValueMatcher.authorization_header_value_matcher}
)
class RequestMatcher:
"""
Matcher object for the incoming request.
It defines various parameters to match the incoming request.
:param uri: URI of the request. This must be an absolute path starting with ``/``.
:param method: HTTP method of the request. If not specified (or `METHOD_ALL`
specified), all HTTP requests will match.
:param data: payload of the HTTP request. This could be a string (utf-8 encoded
by default, see `data_encoding`) or a bytes object.
:param data_encoding: the encoding used for data parameter if data is a string.
:param headers: dictionary of the headers of the request to be matched
:param query_string: the http query string starting with ``?``, such as ``?username=user``
"""
def __init__(
self,
uri: str,
method: str = METHOD_ALL,
data: Union[str, bytes, None] = None,
data_encoding: str = "utf-8",
headers: Optional[Mapping[str, str]] = None,
query_string: Optional[str] = None,
header_value_matcher: Optional[HeaderValueMatcher] = None):
self.uri = uri
self.method = method
self.query_string = query_string
if headers is None:
self.headers = {}
else:
self.headers = headers
if isinstance(data, str):
data = data.encode(data_encoding)
self.data = data
self.header_value_matcher = HeaderValueMatcher() if header_value_matcher is None else header_value_matcher
def __repr__(self):
"""
Returns the string representation of the object, with the known parameters.
"""
class_name = self.__class__.__name__
retval = "<{} ".format(class_name)
retval += "uri={uri!r} method={method!r} query_string={query_string!r} headers={headers!r} data={data!r}>".format_map(self.__dict__)
return retval
def match_data(self, request: Request) -> bool:
"""
Matches the data part of the request
:param request: the HTTP request
:return: `True` when the data is matched or no matching is required. `False` otherwise.
"""
if self.data is None:
return True
return request.data == self.data
def difference(self, request: Request) -> list:
"""
Calculates the difference between the matcher and the request.
Returns a list of fields where there's a difference between the request and the matcher.
The returned list may have zero or more elements, each element is a three-element tuple
containing the field name, the request value, and the matcher value.
If zero-length list is returned, this means that there's no difference, so the request
matches the fields set in the matcher object.
"""
retval = []
if self.uri != URI_DEFAULT and request.path != self.uri:
retval.append(("uri", request.path, self.uri))
if self.method != METHOD_ALL and self.method != request.method:
retval.append(("method", request.method, self.method))
if self.query_string is not None and self.query_string != request.query_string:
retval.append(("query_string", request.query_string, self.query_string))
request_headers = {}
expected_headers = {}
for key, value in self.headers.items():
if not self.header_value_matcher(key, request.headers.get(key), value):
request_headers[key] = request.headers.get(key)
expected_headers[key] = value
if request_headers and expected_headers:
retval.append(("headers", request_headers, expected_headers))
if not self.match_data(request):
retval.append(("data", request.data, self.data))
return retval
def match(self, request: Request) -> bool:
"""
Returns whether the request matches the parameters set in the matcher
object or not. `True` value is returned when it matches, `False` otherwise.
"""
difference = self.difference(request)
return not difference
class RequestHandler:
"""
Represents a response function and a :py:class:`RequestHandler` object.
This class connects the matcher object with the function responsible for the response.
:param matcher: the matcher object
"""
def __init__(self, matcher: RequestMatcher):
self.matcher = matcher
self.request_handler = None
def respond(self, request: Request) -> Response:
"""
Calls the request handler registered for this object.
If no request handler was specified previously, it raises
:py:class:`NoHandlerError` exception.
:param request: the incoming request object
:return: the response object
"""
if self.request_handler is None:
raise NoHandlerError("No handler found for request: {} {}".format(request.method, request.path))
else:
return self.request_handler(request)
def respond_with_json(
self,
response_json,
status: int = 200,
headers: Optional[Mapping[str, str]] = None,
content_type: str = "application/json"):
"""
Registers a respond handler function which responds with a serialized JSON object.
:param response_json: a JSON-serializable python object
:param status: the HTTP status of the response
:param headers: the HTTP headers to be sent (excluding the Content-Type header)
:param content_type: the content type header to be sent
"""
response_data = json.dumps(response_json, indent=4)
self.respond_with_data(response_data, status, headers, content_type=content_type)
def respond_with_data(
self,
response_data: Union[str, bytes] = "",
status: int = 200,
headers: Optional[Mapping[str, str]] = None,
mimetype: Optional[str] = None,
content_type: Optional[str] = None):
"""
Registers a respond handler function which responds raw data.
For detailed description please see the :py:class:`Response` object as the
parameters are analogue.
:param response_data: a string or bytes object representing the body of the response
:param status: the HTTP status of the response
:param headers: the HTTP headers to be sent (excluding the Content-Type header)
:param content_type: the content type header to be sent
:param mimetype: the mime type of the request
"""
def handler(request): # pylint: disable=unused-argument
return Response(response_data, status, headers, mimetype, content_type)
self.request_handler = handler
def respond_with_response(self, response: Response):
"""
Registers a respond handler function which responds the specified response object.
:param response: the response object which will be responded
"""
self.request_handler = lambda request: response
def respond_with_handler(self, func: Callable[[Request], Response]):
"""
Registers the specified function as a responder.
The function will receive the request object and must return with the response object.
"""
self.request_handler = func
class RequestHandlerList(list):
"""
Represents a list of :py:class:`RequestHandler` objects.
"""
def match(self, request: Request) -> RequestHandler:
"""
Returns the first request handler which matches the specified request. Otherwise, it returns `None`.
"""
for requesthandler in self:
if requesthandler.matcher.match(request):
return requesthandler
return None
class HandlerType(Enum):
PERMANENT = 'permanent'
ONESHOT = 'oneshot'
ORDERED = 'ordered'
class HTTPServer: # pylint: disable=too-many-instance-attributes
"""
Server instance which manages handlers to serve pre-defined requests.
:param host: the host or IP where the server will listen
:param port: the TCP port where the server will listen
:param ssl_context: the ssl context object to use for https connections
:param default_waiting_settings: the waiting settings object to use as default settings for :py:meth:`wait` context
manager
.. py:attribute:: log
Attribute containing the list of two-element tuples. Each tuple contains
:py:class:`Request` and :py:class:`Response` object which represents the
incoming request and the outgoing response which happened during the lifetime
of the server.
"""
DEFAULT_LISTEN_HOST = "localhost"
DEFAULT_LISTEN_PORT = 0 # Use ephemeral port
def __init__(self, host=DEFAULT_LISTEN_HOST, port=DEFAULT_LISTEN_PORT, ssl_context: Optional[SSLContext] = None,
default_waiting_settings: Optional[WaitingSettings] = None):
"""
Initializes the instance.
"""
self.host = host
self.port = port
self.server = None
self.server_thread = None
self.assertions = []
self.log = []
self.ordered_handlers = []
self.oneshot_handlers = RequestHandlerList()
self.handlers = RequestHandlerList()
self.permanently_failed = False
self.ssl_context = ssl_context
if default_waiting_settings is not None:
self.default_waiting_settings = default_waiting_settings
else:
self.default_waiting_settings = WaitingSettings()
self._waiting_settings = copy(self.default_waiting_settings)
self._waiting_result = queue.LifoQueue(maxsize=1)
def clear(self):
"""
Clears and resets the state attributes of the object.
This method is useful when the object needs to be re-used but stopping the server is not feasible.
"""
self.clear_assertions()
self.clear_log()
self.clear_all_handlers()
self.permanently_failed = False
def clear_assertions(self):
"""
Clears the list of assertions
"""
self.assertions = []
def clear_log(self):
"""
Clears the list of log entries
"""
self.log = []
def clear_all_handlers(self):
"""
Clears all types of the handlers (ordered, oneshot, permanent)
"""
self.ordered_handlers = []
self.oneshot_handlers = RequestHandlerList()
self.handlers = RequestHandlerList()
def url_for(self, suffix: str):
"""
Return an url for a given suffix.
This basically means that it prepends the string ``http://$HOST:$PORT/`` to the `suffix` parameter
(where $HOST and $PORT are the parameters given to the constructor).
:param suffix: the suffix which will be added to the base url. It can start with ``/`` (slash) or
not, the url will be the same.
:return: the full url which refers to the server
"""
if not suffix.startswith("/"):
suffix = "/" + suffix
if self.ssl_context is None:
protocol = "http"
else:
protocol = "https"
return "{}://{}:{}{}".format(protocol, self.host, self.port, suffix)
def create_matcher(self, *args, **kwargs) -> RequestMatcher:
"""
Creates a :py:class:`RequestMatcher` instance with the specified parameters.
This method can be overridden if you want to use your own matcher.
"""
return RequestMatcher(*args, **kwargs)
def expect_request(
self,
uri: str,
method: str = METHOD_ALL,
data: Union[str, bytes, None] = None,
data_encoding: str = "utf-8",
headers: Optional[Mapping[str, str]] = None,
query_string: Optional[str] = None,
header_value_matcher: Optional[HeaderValueMatcher] = None,
handler_type: HandlerType = HandlerType.PERMANENT) -> RequestHandler:
"""
Create and register a request handler.
If `handler_type` is `HandlerType.PERMANENT` a permanent request handler is created. This handler can be used as
many times as the request matches it, but ordered handlers have higher priority so if there's one or more
ordered handler registered, those must be used first.
If `handler_type` is `HandlerType.ONESHOT` a oneshot request handler is created. This handler can be only used
once. Once the server serves a response for this handler, the handler will be dropped.
If `handler_type` is `HandlerType.ORDERED` an ordered request handler is created. Comparing to oneshot handler,
ordered handler also determines the order of the requests to be served. For example if there are two ordered
handlers registered, the first request must hit the first handler, and the second request must hit the second
one, and not vice versa. If one or more ordered handler defined, those must be exhausted first.
:param uri: URI of the request. This must be an absolute path starting with ``/``.
:param method: HTTP method of the request. If not specified (or `METHOD_ALL`
specified), all HTTP requests will match.
:param data: payload of the HTTP request. This could be a string (utf-8 encoded
by default, see `data_encoding`) or a bytes object.
:param data_encoding: the encoding used for data parameter if data is a string.
:param headers: dictionary of the headers of the request to be matched
:param query_string: the http query string starting with ``?``, such as ``?username=user``
:param header_value_matcher: :py:class:`HeaderValueMatcher` that matches values of headers.
:param handler_type: type of handler
:return: Created and register :py:class:`RequestHandler`.
"""
matcher = self.create_matcher(
uri,
method=method,
data=data,
data_encoding=data_encoding,
headers=headers,
query_string=query_string,
header_value_matcher=header_value_matcher,
)
request_handler = RequestHandler(matcher)
if handler_type == HandlerType.PERMANENT:
self.handlers.append(request_handler)
elif handler_type == HandlerType.ONESHOT:
self.oneshot_handlers.append(request_handler)
elif handler_type == HandlerType.ORDERED:
self.ordered_handlers.append(request_handler)
return request_handler
def expect_oneshot_request(
self,
uri: str,
method: str = METHOD_ALL,
data: Union[str, bytes, None] = None,
data_encoding: str = "utf-8",
headers: Optional[Mapping[str, str]] = None,
query_string: Optional[str] = None,
header_value_matcher: Optional[HeaderValueMatcher] = None) -> RequestHandler:
"""
Create and register a oneshot request handler.
This is a method for convenience. See :py:meth:`expect_request` for documentation.
:param uri: URI of the request. This must be an absolute path starting with ``/``.
:param method: HTTP method of the request. If not specified (or `METHOD_ALL`
specified), all HTTP requests will match.
:param data: payload of the HTTP request. This could be a string (utf-8 encoded
by default, see `data_encoding`) or a bytes object.
:param data_encoding: the encoding used for data parameter if data is a string.
:param headers: dictionary of the headers of the request to be matched
:param query_string: the http query string starting with ``?``, such as ``?username=user``
:param header_value_matcher: :py:class:`HeaderValueMatcher` that matches values of headers.
:return: Created and register :py:class:`RequestHandler`.
"""
return self.expect_request(
uri=uri,
method=method,
data=data,
data_encoding=data_encoding,
headers=headers,
query_string=query_string,
header_value_matcher=header_value_matcher,
handler_type=HandlerType.ONESHOT,
)
def expect_ordered_request(
self,
uri: str,
method: str = METHOD_ALL,
data: Union[str, bytes, None] = None,
data_encoding: str = "utf-8",
headers: Optional[Mapping[str, str]] = None,
query_string: Optional[str] = None,
header_value_matcher: Optional[HeaderValueMatcher] = None) -> RequestHandler:
"""
Create and register a ordered request handler.
This is a method for convenience. See :py:meth:`expect_request` for documentation.
:param uri: URI of the request. This must be an absolute path starting with ``/``.
:param method: HTTP method of the request. If not specified (or `METHOD_ALL`
specified), all HTTP requests will match.
:param data: payload of the HTTP request. This could be a string (utf-8 encoded
by default, see `data_encoding`) or a bytes object.
:param data_encoding: the encoding used for data parameter if data is a string.
:param headers: dictionary of the headers of the request to be matched
:param query_string: the http query string starting with ``?``, such as ``?username=user``
:param header_value_matcher: :py:class:`HeaderValueMatcher` that matches values of headers.
:return: Created and register :py:class:`RequestHandler`.
"""
return self.expect_request(
uri=uri,
method=method,
data=data,
data_encoding=data_encoding,
headers=headers,
query_string=query_string,
header_value_matcher=header_value_matcher,
handler_type=HandlerType.ORDERED,
)
def thread_target(self):
"""
This method serves as a thread target when the server is started.
This should not be called directly, but can be overriden to tailor it to your needs.
"""
self.server.serve_forever()
def is_running(self) -> bool:
"""
Returns `True` when the server is running, otherwise `False`.
"""
return bool(self.server)
def start(self):
"""
Start the server in a thread.
This method returns immediately (e.g. does not block), and it's the caller's
responsibility to stop the server (by calling :py:meth:`stop`) when it is no longer needed).
If the sever is not stopped by the caller and execution reaches the end, the
program needs to be terminated by Ctrl+C or by signal as it will not terminate until
the thred is stopped.
If the sever is already running :py:class:`HTTPServerError` will be raised. If you are
unsure, call :py:meth:`is_running` first.
There's a context interface of this class which stops the server when the context block ends.
"""
if self.is_running():
raise HTTPServerError("Server is already running")
self.server = make_server(self.host, self.port, self.application, ssl_context=self.ssl_context)
self.port = self.server.port # Update port (needed if `port` was set to 0)
self.server_thread = threading.Thread(target=self.thread_target)
self.server_thread.start()
def stop(self):
"""
Stop the running server.
Notifies the server thread about the intention of the stopping, and the thread will
terminate itself. This needs about 0.5 seconds in worst case.
Only a running server can be stopped. If the sever is not runnig, :py:class`HTTPServerError`
will be raised.
"""
if not self.is_running():
raise HTTPServerError("Server is not running")
self.server.shutdown()
self.server_thread.join()
self.server = None
self.server_thread = None
def add_assertion(self, obj):
"""
Add a new assertion
Assertions can be added here, and when :py:meth:`check_assertions` is called,
it will raise AssertionError for pytest with the object specified here.
:param obj: An object which will be passed to AssertionError.
"""
self.assertions.append(obj)
def check_assertions(self):
"""
Raise AssertionError when at least one assertion added
The first assertion added by :py:meth:`add_assertion` will be raised and
it will be removed from the list.
This method can be useful to get some insights into the errors happened in
the sever, and to have a proper error reporting in pytest.
"""
if self.assertions:
raise AssertionError(self.assertions.pop(0))
def format_matchers(self) -> str:
"""
Return a string representation of the matchers
This method returns a human-readable string representation of the matchers
registered. You can observe which requests will be served, etc.
This method is primairly used when reporting errors.
"""
def format_handlers(handlers):
if handlers:
return [" {!r}".format(handler.matcher) for handler in handlers]
else:
return [" none"]
lines = []
lines.append("Ordered matchers:")
lines.extend(format_handlers(self.ordered_handlers))
lines.append("")
lines.append("Oneshot matchers:")
lines.extend(format_handlers(self.oneshot_handlers))
lines.append("")
lines.append("Persistent matchers:")
lines.extend(format_handlers(self.handlers))
return "\n".join(lines)
def respond_nohandler(self, request: Request):
"""
Add a 'no handler' assertion.
This method is called when the server wasn't able to find any handler to serve the request.
As the result, there's an assertion added (which can be raised by :py:meth:`check_assertions`).
"""
if self._waiting_settings.stop_on_nohandler:
self._set_waiting_result(False)
text = "No handler found for request {!r}.\n".format(request)
self.add_assertion(text + self.format_matchers())
return Response("No handler found for this request", 500)
def respond_permanent_failure(self):
"""
Add a 'permanent failure' assertion.
This assertion means that no further requests will be handled. This is the resuld of missing
an ordered matcher.
"""
self.add_assertion("All requests will be permanently failed due failed ordered handler")
return Response("No handler found for this request", 500)
def dispatch(self, request: Request) -> Response:
"""
Dispatch a request to the appropriate request handler.
This method tries to find the request handler whose matcher matches the request, and
then calls it in order to serve the request.
First, the request is checked for the ordered matchers. If there's an ordered matcher,
it must match the request, otherwise the server will be put into a `permanent failure`
mode in which it makes all request failed - this is the intended way of working of ordered
matchers.
Then oneshot handlers, and the permanent handlers are looked up.
:param request: the request object from the werkzeug library
:return: the response object what the handler responded, or a response which contains the error
"""
if self.permanently_failed:
return self.respond_permanent_failure()
handler = None
if self.ordered_handlers:
handler = self.ordered_handlers[0]
if not handler.matcher.match(request):
self.permanently_failed = True
response = self.respond_nohandler(request)
return response
self.ordered_handlers.pop(0)
self._update_waiting_result()
if not handler:
handler = self.oneshot_handlers.match(request)
if handler:
self.oneshot_handlers.remove(handler)
self._update_waiting_result()
else:
handler = self.handlers.match(request)
if not handler:
return self.respond_nohandler(request)
response = handler.respond(request)
if response is None:
response = Response("")
if isinstance(response, str):
response = Response(response)
return response
def _set_waiting_result(self, value: bool) -> None:
"""Set waiting_result
Setting is implemented as putting value to queue without waiting. If queue is full we simply ignore the
exception, because that means that waiting_result was already set, but not read.
"""
with suppress(queue.Full):
self._waiting_result.put_nowait(value)
def _update_waiting_result(self) -> None:
if not self.oneshot_handlers and not self.ordered_handlers:
self._set_waiting_result(True)
@contextmanager
def wait(self, raise_assertions: Optional[bool] = None, stop_on_nohandler: Optional[bool] = None,
timeout: Optional[float] = None):
"""Context manager to wait until the first of following event occurs: all ordered and oneshot handlers were
executed, unexpected request was received (if `stop_on_nohandler` is set to `True`), or time was out
:param raise_assertions: whether raise assertions on unexpected request or timeout or not
:param stop_on_nohandler: whether stop on unexpected request or not
:param timeout: time (in seconds) until time is out
Example:
.. code-block:: python
def test_wait(httpserver):
httpserver.expect_oneshot_request('/').respond_with_data('OK')
with httpserver.wait(raise_assertions=False, stop_on_nohandler=False, timeout=1) as waiting:
requests.get(httpserver.url_for('/'))
# `waiting` is :py:class:`Waiting`
assert waiting.result
print('Elapsed time: {} sec'.format(waiting.elapsed_time))
"""
if raise_assertions is None:
self._waiting_settings.raise_assertions = self.default_waiting_settings.raise_assertions
else:
self._waiting_settings.raise_assertions = raise_assertions
if stop_on_nohandler is None:
self._waiting_settings.stop_on_nohandler = self.default_waiting_settings.stop_on_nohandler
else:
self._waiting_settings.stop_on_nohandler = stop_on_nohandler
if timeout is None:
self._waiting_settings.timeout = self.default_waiting_settings.timeout
else:
self._waiting_settings.timeout = timeout
# Ensure that waiting_result is empty
with suppress(queue.Empty):
self._waiting_result.get_nowait()
waiting = Waiting()
yield waiting
try:
waiting_result = self._waiting_result.get(timeout=self._waiting_settings.timeout)
waiting.complete(result=waiting_result)
except queue.Empty:
waiting.complete(result=False)
if self._waiting_settings.raise_assertions:
raise AssertionError('Wait timeout occurred, but some handlers left:\n'
'{}'.format(self.format_matchers()))
if self._waiting_settings.raise_assertions and not waiting.result:
self.check_assertions()
@Request.application
def application(self, request: Request):
"""
Entry point of werkzeug.
This method is called for each request, and it then calls the undecorated
:py:meth:`dispatch` method to serve the request.
:param request: the request object from the werkzeug library
:return: the response object what the dispatch returned
"""
request.get_data()
response = self.dispatch(request)
self.log.append((request, response))
return response
def __enter__(self):
"""
Provide the context API
It starts the server in a thread if the server is not already running.
"""
if not self.is_running():
self.start()
return self
def __exit__(self, *args, **kwargs):
"""
Provide the context API
It stops the server if the server is running.
Please note that depending on the internal things of werkzeug, it may take 0.5 seconds.
"""
if self.is_running():
self.stop()
You can’t perform that action at this time.