{{ 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
1405 lines (1108 loc) · 51.7 KB
/
Copy pathhttpserver.py
File metadata and controls
1405 lines (1108 loc) · 51.7 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
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
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import abc
import ipaddress
import json
import queue
import re
import threading
import time
import urllib.parse
from collections import defaultdict
from contextlib import contextmanager
from contextlib import suppress
from copy import copy
from enum import Enum
from typing import TYPE_CHECKING
from typing import Any
from typing import Callable
from typing import ClassVar
from typing import Iterable
from typing import Mapping
from typing import MutableMapping
from typing import Optional
from typing import Pattern
from typing import Tuple
from typing import Union
import werkzeug.http
from werkzeug.datastructures import Authorization
from werkzeug.datastructures import MultiDict
from werkzeug.serving import make_server
from werkzeug.wrappers import Request
from werkzeug.wrappers import Response
if TYPE_CHECKING:
from ssl import SSLContext
URI_DEFAULT = ""
METHOD_ALL = "__ALL"
HEADERS_T = Union[
Mapping[str, Union[str, Iterable[str]]],
Iterable[Tuple[str, str]],
]
HVMATCHER_T = Callable[[str, Optional[str], str], bool]
class Undefined:
def __repr__(self):
return "<UNDEFINED>"
UNDEFINED = Undefined()
class Error(Exception):
"""
Base class for all exception defined in this package.
"""
class NoHandlerError(Error):
"""
Raised when a :py:class:`RequestHandler` has no registered method to serve the request.
"""
class HTTPServerError(Error):
"""
Raised when there's a problem with HTTP server.
"""
class NoMethodFoundForMatchingHeaderValueError(Error):
"""
Raised when a :py:class:`HeaderValueMatcher` has no registered method to match the header value.
"""
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, # noqa: FBT001
stop_on_nohandler: bool = True, # noqa: FBT001
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): # noqa: FBT001
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: ClassVar[MutableMapping[str, Callable[[str | None, str], bool]]] = {}
def __init__(self, matchers: Mapping[str, Callable[[str | None, str], bool]] | None = None):
self.matchers = self.DEFAULT_MATCHERS if matchers is None else matchers
@staticmethod
def authorization_header_value_matcher(actual: str | None, expected: str) -> bool:
func = getattr(Authorization, "from_header", None)
if func is None: # Werkzeug < 2.3.0
func = werkzeug.http.parse_authorization_header # type: ignore[attr-defined]
return func(actual) == func(expected)
@staticmethod
def default_header_value_matcher(actual: str | None, expected: str) -> bool:
return actual == expected
def __call__(self, header_name: str, actual: str | None, 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 QueryMatcher(abc.ABC):
"""
Abstract class for QueryMatchers
get_comparing_values should return a 2-element tuple whose elements will
be compared.
"""
def match(self, request_query_string: bytes) -> bool:
values = self.get_comparing_values(request_query_string)
return values[0] == values[1]
@abc.abstractmethod
def get_comparing_values(self, request_query_string: bytes) -> tuple:
pass
class StringQueryMatcher(QueryMatcher):
"""
Matches a query for a string or bytes specified
"""
def __init__(self, query_string: bytes | str):
"""
:param query_string: the query string will be compared to this string or bytes.
If string is specified, it will be encoded by the encode() method.
The query must not start with '?' but will be exactly (byte-by-byte) equal
the actual query string of the incoming request.
"""
if not isinstance(query_string, (str, bytes)):
raise TypeError("query_string must be a string, or a bytes-like object")
self.query_string = query_string
def get_comparing_values(self, request_query_string: bytes) -> tuple:
if isinstance(self.query_string, str):
query_string = self.query_string.encode()
elif isinstance(self.query_string, bytes):
query_string = self.query_string
else:
raise TypeError("query_string must be a string, or a bytes-like object")
return (request_query_string, query_string)
class MappingQueryMatcher(QueryMatcher):
"""
Matches a query string to a dictionary or MultiDict specified
"""
def __init__(self, query_dict: Mapping | MultiDict):
"""
:param query_dict: if dictionary (Mapping) is specified, it will be used as a
key-value mapping where both key and value should be string. If there are multiple
values specified for the same key in the request, the first element will be used.
If you want to match multiple values, use a MultiDict object from werkzeug, which
represents multiple values for one key.
"""
self.query_dict = query_dict
def get_comparing_values(self, request_query_string: bytes) -> tuple:
query = MultiDict(urllib.parse.parse_qsl(request_query_string.decode("utf-8")))
if isinstance(self.query_dict, MultiDict):
return (query, self.query_dict)
else:
return (query.to_dict(), dict(self.query_dict))
class BooleanQueryMatcher(QueryMatcher):
"""
Matches the query depending on the boolean value
"""
def __init__(self, result: bool): # noqa: FBT001
"""
:param result: if this parameter is true, the query match will be always
successful. Otherwise, no query match will be successful.
"""
self.result = result
def get_comparing_values(self, request_query_string): # noqa: ARG002
if self.result:
return (True, True)
else:
return (True, False)
def _create_query_matcher(query_string: None | QueryMatcher | str | bytes | Mapping) -> QueryMatcher:
if isinstance(query_string, QueryMatcher):
return query_string
if query_string is None:
return BooleanQueryMatcher(result=True)
if isinstance(query_string, (str, bytes)):
return StringQueryMatcher(query_string)
if isinstance(query_string, Mapping):
return MappingQueryMatcher(query_string)
raise TypeError("Unable to cast this type to QueryMatcher: {!r}".format(type(query_string)))
class URIPattern(abc.ABC):
@abc.abstractmethod
def match(self, uri: str) -> bool:
"""
Matches the provided URI.
:param uri: URI of the request. This is an absolute path starting
with "/" and does not contain the query part.
:return: True if there's a match, False otherwise
"""
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 ``/``, a
:py:class:`URIPattern` object, or a regular expression compiled by :py:func:`re.compile`.
: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, after ``?``, such as ``username=user``.
If string is specified it will be encoded to bytes with the encode method of
the string. If dict is specified, it will be matched to the ``key=value`` pairs
specified in the request. If multiple values specified for a given key, the first
value will be used. If multiple values needed to be handled, use ``MultiDict``
object from werkzeug.
:param header_value_matcher: :py:class:`HeaderValueMatcher` that matches
values of headers, or a ``Callable[[str, Optional[str], str], bool]``
receiving the header key (from `headers`), header value (or `None`) and the expected
value (from `headers`) and should return ``True`` if the header matches, ``False`` otherwise.
:param json: a python object (eg. a dict) whose value will be compared to the request body after it
is loaded as json. If load fails, this matcher will be failed also. *Content-Type* is not checked.
If that's desired, add it to the headers parameter.
"""
def __init__(
self,
uri: str | URIPattern | Pattern[str],
method: str = METHOD_ALL,
data: str | bytes | None = None,
data_encoding: str = "utf-8",
headers: Mapping[str, str] | None = None,
query_string: None | QueryMatcher | str | bytes | Mapping = None,
header_value_matcher: HVMATCHER_T | None = None,
json: Any = UNDEFINED,
):
if json is not UNDEFINED and data is not None:
raise ValueError("data and json parameters are mutually exclusive")
self.uri = uri
self.method = method
self.query_string = query_string
self.query_matcher = _create_query_matcher(self.query_string)
self.json = json
self.headers: Mapping[str, str] = {}
if headers is not None:
self.headers = headers
if isinstance(data, str):
data = data.encode(data_encoding)
self.data = data
self.data_encoding = data_encoding
self.header_value_matcher: HVMATCHER_T = HeaderValueMatcher()
if header_value_matcher is not None:
self.header_value_matcher = 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} json={json!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 match_uri(self, request: Request) -> bool:
path = request.path
if isinstance(self.uri, URIPattern):
return self.uri.match(path)
# this is python version depending
# in python 3.7 and above: it is re.Pattern
# below python 3.7 it is _sre.SRE_Pattern which cannot be accessed directly
elif isinstance(self.uri, re.compile("").__class__):
return bool(self.uri.match(path))
else:
# there could be a guard isinstance(self.uri, str) been here
# but we want to allow any object which provides the __eq__ parameter
# (note: in this case it will be not typeing correct)
#
# also, python will raise TypeError when self.uri is a conflicting type
return self.uri in (URI_DEFAULT, path)
def match_json(self, request: Request) -> bool:
"""
Matches the request data as json.
Load the request data as json and compare it to self.json which is a
json-serializable data structure (eg. a dict or list).
:param request: the HTTP request
:return: `True` when the data is matched or no matching is required. `False` otherwise.
"""
if self.json is UNDEFINED:
return True
try:
# do the decoding here as python 3.5 requires string and does not
# accept bytes
json_received = json.loads(request.data.decode(self.data_encoding))
except json.JSONDecodeError:
return False
except UnicodeDecodeError:
return False
return json_received == self.json
def difference(self, request: Request) -> list[tuple]:
"""
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: list[tuple] = []
if not self.match_uri(request):
retval.append(("uri", request.path, self.uri))
if self.method not in (METHOD_ALL, request.method):
retval.append(("method", request.method, self.method))
if not self.query_matcher.match(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))
if not self.match_json(request):
retval.append(("json", request.data, self.json))
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 RequestHandlerBase(abc.ABC):
"""
Represents a :py:class:`RequestHandler` object providing a response for the corresponding request.
"""
def respond_with_json(
self,
response_json,
status: int = 200,
headers: Mapping[str, str] | None = None,
content_type: str = "application/json",
):
"""
Prepares a response 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: str | bytes = "",
status: int = 200,
headers: HEADERS_T | None = None,
mimetype: str | None = None,
content_type: str | None = None,
):
"""
Prepares a response with raw data.
For detailed description please see the :py:class:`werkzeug.wrappers.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
"""
self.respond_with_response(Response(response_data, status, headers, mimetype, content_type))
@abc.abstractmethod
def respond_with_response(self, response: Response):
"""
Prepares a response with the specified response object.
:param response: the response object which will be responded
"""
class RequestHandler(RequestHandlerBase):
"""
Represents a response function and a :py:class:`RequestHandler` object.
This class connects the matcher object with the function responsible for the response.
The respond handler function can be registered with the `respond_with_` methods.
:param matcher: the matcher object
"""
def __init__(self, matcher: RequestMatcher):
self.matcher = matcher
self.request_handler: Callable[[Request], Response] | None = None
def respond(self, request: Request) -> Response:
"""
Calls the request handler registered for this object.
If no response 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(
"Matching request handler found but no response defined: {} {}".format(request.method, request.path)
)
else:
return self.request_handler(request)
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
def respond_with_response(self, response: Response):
self.request_handler = lambda request: response
def __repr__(self) -> str:
class_name = self.__class__.__name__
retval = (
f"<{class_name} uri={self.matcher.uri!r} method={self.matcher.method!r} "
f"query_string={self.matcher.query_string!r} headers={self.matcher.headers!r} data={self.matcher.data!r} "
f"json={self.matcher.json!r}>"
)
return retval
class RequestHandlerList(list):
"""
Represents a list of :py:class:`RequestHandler` objects.
"""
def match(self, request: Request) -> RequestHandler | None:
"""
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 HTTPServerBase(abc.ABC): # pylint: disable=too-many-instance-attributes
"""
Abstract HTTP server with error handling.
: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
.. py:attribute:: log
Attribute containing the list of two-element tuples. Each tuple contains
:py:class:`werkzeug.wrappers.Request` and :py:class:`werkzeug.wrappers.Response` object which represents the
incoming request and the outgoing response which happened during the lifetime
of the server.
.. py:attribute:: no_handler_status_code
Attribute containing the http status code (int) which will be the response
status when no matcher is found for the request. By default, it is set to *500*
but it can be overridden to any valid http status code such as *404* if needed.
"""
def __init__(
self,
host: str,
port: int,
ssl_context: SSLContext | None = None,
):
"""
Initializes the instance.
"""
self.host = host
self.port = port
self.server = None
self.server_thread = None
self.assertions: list[str] = []
self.handler_errors: list[Exception] = []
self.log: list[tuple[Request, Response]] = []
self.ssl_context = ssl_context
self.no_handler_status_code = 500
def __repr__(self):
return f"<{self.__class__.__name__} host={self.host} port={self.port}>"
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_handler_errors()
self.clear_log()
self.no_handler_status_code = 500
def clear_assertions(self):
"""
Clears the list of assertions
"""
self.assertions = []
def clear_handler_errors(self):
"""
Clears the list of collected errors from handler invocations
"""
self.handler_errors = []
def clear_log(self):
"""
Clears the list of log entries
"""
self.log = []
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).
When host is an IPv6 address, the required square brackets will be added
to it, forming a valid URL.
When SSL or TLS is in use, the protocol of the returned URL will be ``https``.
: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"
host = self.format_host(self.host)
return "{}://{}:{}{}".format(protocol, 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 thread_target(self):
"""
This method serves as a thread target when the server is started.
This should not be called directly, but can be overridden 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 thread 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 running, :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 AssertionError, or an object which will be passed to an AssertionError.
"""
self.assertions.append(obj)
def check(self):
"""
Raises AssertionError or Errors raised in handlers.
Runs both :py:meth:`check_assertions` and :py:meth:`check_handler_errors`
"""
self.check_assertions()
self.check_handler_errors()
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:
assertion = self.assertions.pop(0)
if isinstance(assertion, AssertionError):
raise assertion
raise AssertionError(assertion)
def check_handler_errors(self):
"""
Re-Raises any errors caused in request handlers
The first error raised by a handler will be re-raised here, and then
removed from the list.
"""
if self.handler_errors:
raise self.handler_errors.pop(0)
def respond_nohandler(self, request: Request, extra_message: str = ""):
"""
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`).
"""
text = "No handler found for request {!r} with data {!r}.".format(request, request.data)
self.add_assertion(text + extra_message)
return Response(text + extra_message, self.no_handler_status_code)
@abc.abstractmethod
def dispatch(self, request: Request) -> Response:
"""
Dispatch a request to the appropriate request handler.
:param request: the request object from the werkzeug library
:return: the response object what the handler responded, or a response which contains the error
"""
@Request.application # type: ignore
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()
@staticmethod
def format_host(host):
"""
Formats a hostname so it can be used in a URL.
Notably, this adds brackets around IPV6 addresses when
they are missing.
"""
try:
ipaddress.IPv6Address(host)
is_ipv6 = True
except ValueError:
is_ipv6 = False
if is_ipv6 and not host.startswith("[") and not host.endswith("]"):
return f"[{host}]"
return host
class HTTPServer(HTTPServerBase): # 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:: no_handler_status_code
Attribute containing the http status code (int) which will be the response
status when no matcher is found for the request. By default, it is set to *500*
but it can be overridden to any valid http status code such as *404* if needed.
"""
DEFAULT_LISTEN_HOST = "localhost"
DEFAULT_LISTEN_PORT = 0 # Use ephemeral port
def __init__(
self,
host=DEFAULT_LISTEN_HOST,
port=DEFAULT_LISTEN_PORT,
ssl_context: SSLContext | None = None,
default_waiting_settings: WaitingSettings | None = None,
):
"""
Initializes the instance.
"""
super().__init__(host, port, ssl_context)
self.ordered_handlers: list[RequestHandler] = []
self.oneshot_handlers = RequestHandlerList()
self.handlers = RequestHandlerList()
self.permanently_failed = False
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[bool] = 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.
"""
super().clear()
self.clear_all_handlers()
self.permanently_failed = False
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 expect_request(
self,
uri: str | URIPattern | Pattern[str],
method: str = METHOD_ALL,
data: str | bytes | None = None,
data_encoding: str = "utf-8",
headers: Mapping[str, str] | None = None,
query_string: None | QueryMatcher | str | bytes | Mapping = None,
header_value_matcher: HVMATCHER_T | None = None,
handler_type: HandlerType = HandlerType.PERMANENT,
json: Any = UNDEFINED,
) -> 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.
.. note::
Once this method is called, the response should also be specified by
calling one of the respond methods of the returned
:py:class:`RequestHandler` object, otherwise
:py:class:`NoHandlerError` will be raised on an incoming request.
:param uri: URI of the request. This must be an absolute path starting with ``/``, a
:py:class:`URIPattern` object, or a regular expression compiled by :py:func:`re.compile`.
:param method: HTTP method of the request. If not specified (or `METHOD_ALL`
specified), all HTTP requests will match. Case insensitive.
: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, after ``?``, such as ``username=user``.
You can’t perform that action at this time.