server: implement 'permanently failed' state

csernazs · csernazs · commit 7b2fb1f6a397 · 2018-08-06T21:58:54.000+02:00
This states that at least one request did not meet the requiremenets for the
ordered handlers.

Eg. we waited for a GET /example request to be the *first* request, but the
client sent a GET /foobar request, then we should pull the handbrake and
stop serving further requests.

The idea behing this is to avoid the situation having the 2nd ordered
expectation pass while the 1st failed.
diff --git a/pytest_httpserver/httpserver.py b/pytest_httpserver/httpserver.py
@@ -126,11 +126,13 @@ def __init__(self, host="localhost", port=4000):
         self.ordered_handlers = []
         self.oneshot_handlers = RequestHandlerList()
         self.handlers = RequestHandlerList()
+        self.permanently_failed = False
 
     def clear(self):
         self.clear_assertions()
         self.clear_log()
         self.clear_all_handlers()
+        self.permanently_failed = False
 
     def clear_assertions(self):
         self.assertions = []
@@ -152,7 +154,7 @@ def url_for(self, suffix: str):
     def create_matcher(self, *args, **kwargs):
         return RequestMatcher(*args, **kwargs)
 
-    def expect_oneshot_request(self, uri, method="GET", data=None, data_encoding="utf-8", headers=None, ordered=False):
+    def expect_oneshot_request(self, uri, method="GET", data=None, data_encoding="utf-8", headers=None, *, ordered=False):
         matcher = self.create_matcher(uri, method=method, data=data, data_encoding=data_encoding, headers=headers)
         request_handler = RequestHandler(matcher)
         if ordered:
@@ -221,13 +223,20 @@ def respond_nohandler(self, request: Request):
         self.add_assertion(text + self.format_matchers())
         return Response("No handler found for this request", 500)
 
+    def respond_permanent_failure(self):
+        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):
+        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)
-                self.ordered_handlers.pop(0)
                 return response
 
             self.ordered_handlers.pop(0)
diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 
 setup(
     name="pytest_httpserver",
-    version="0.2",
+    version="0.1",
     url="https://www.github.com/csernazs/pytest-httpserver",
     packages=find_packages(),
     author="Zsolt Cserna",
diff --git a/tests/test_oneshot.py b/tests/test_oneshot.py
@@ -58,10 +58,12 @@ def test_ordered_invalid_order(httpserver: HTTPServer):
     assert len(httpserver.ordered_handlers) == 2
 
     # these would not pass as the order is different
+    # this mark the whole thing 'permanently failed' so no further requests must pass
     response = requests.get(httpserver.url_for("/foobaz"))
     assert response.status_code == 500
 
     response = requests.get(httpserver.url_for("/foobar"))
     assert response.status_code == 500
 
-    assert len(httpserver.ordered_handlers) == 0
+    # as no ordered handlers are triggered yet, these must be intact..
+    assert len(httpserver.ordered_handlers) == 2
