Merge pull request #34 from ScottFreeCode/v1.4.0/http-verify-pattern

HTTP mock urlPattern option in verify

touchstone-tests/touchstone/tests/test_http.py

@@ -120,4 +120,4 @@ def when(self, given) -> object:
         return None
 
     def then(self, given, result) -> bool:
-        return self.mocks.http.verify().get_called('/some-endpoint/foo/bar')
+        return self.mocks.http.verify().get_called('/some-endpoint/([a-z]*)/bar', url_pattern=True)

touchstone/lib/nodes/mocks/behaviors/i_http_behavior.py

@@ -31,61 +31,61 @@ def delete(self, endpoint: str, response: str, response_status: int = 200, url_p
 
 class IHttpVerify(object):
     @abc.abstractmethod
-    def get_called(self, endpoint: str, times: int = 1) -> bool:
+    def get_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a GET request the given number of times.
         If times is set to None, the endpoint can be called any number of times."""
         pass
 
     @abc.abstractmethod
-    def post_called(self, endpoint: str, times: int = 1) -> bool:
+    def post_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a POST request the given number of times.
         If times is set to None, the endpoint can be called any number of times."""
         pass
 
     @abc.abstractmethod
-    def post_contained(self, endpoint: str, expected_body: str) -> bool:
+    def post_contained(self, endpoint: str, expected_body: str, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a POST request containing the given expected
         body."""
         pass
 
     @abc.abstractmethod
-    def post_contained_json(self, endpoint: str, expected_body: dict) -> bool:
+    def post_contained_json(self, endpoint: str, expected_body: dict, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a POST request containing the given expected
         JSON body."""
         pass
 
     @abc.abstractmethod
-    def put_called(self, endpoint: str, times: int = 1) -> bool:
+    def put_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a PUT request the given number of times.
         If times is set to None, the endpoint can be called any number of times."""
         pass
 
     @abc.abstractmethod
-    def put_contained(self, endpoint: str, expected_body: str) -> bool:
+    def put_contained(self, endpoint: str, expected_body: str, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a PUT request containing the given expected
         body."""
         pass
 
     @abc.abstractmethod
-    def put_contained_json(self, endpoint: str, expected_body: dict) -> bool:
+    def put_contained_json(self, endpoint: str, expected_body: dict, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a PUT request containing the given expected
         JSON body."""
         pass
 
     @abc.abstractmethod
-    def delete_called(self, endpoint: str, times: int = 1) -> bool:
+    def delete_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a DELETE request the given number of times.
         If times is set to None, the endpoint can be called any number of times."""
         pass
 
     @abc.abstractmethod
-    def delete_contained(self, endpoint: str, expected_body: str) -> bool:
+    def delete_contained(self, endpoint: str, expected_body: str, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a DELETE request containing the given expected
         body."""
         pass
 
     @abc.abstractmethod
-    def delete_contained_json(self, endpoint: str, expected_body: dict) -> bool:
+    def delete_contained_json(self, endpoint: str, expected_body: dict, url_pattern: bool = False) -> bool:
         """Returns True if the given endpoint has been called with a DELETE request containing the given expected
         JSON body."""
         pass

touchstone/lib/nodes/mocks/docker/http/docker_http_verify.py

@@ -14,40 +14,40 @@ def __init__(self):
     def set_url(self, url: str):
         self.__url = url
 
-    def get_called(self, endpoint: str, times: int = 1) -> bool:
-        return self.__count_verification(endpoint, 'GET', times)
+    def get_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
+        return self.__count_verification(endpoint, 'GET', times, url_pattern)
 
-    def post_called(self, endpoint: str, times: int = 1) -> bool:
-        return self.__count_verification(endpoint, 'POST', times)
+    def post_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
+        return self.__count_verification(endpoint, 'POST', times, url_pattern)
 
-    def post_contained(self, endpoint: str, expected_body: str) -> bool:
-        return self.__contained_verification(endpoint, 'POST', expected_body)
+    def post_contained(self, endpoint: str, expected_body: str, url_pattern: bool = False) -> bool:
+        return self.__contained_verification(endpoint, 'POST', expected_body, url_pattern)
 
-    def post_contained_json(self, endpoint: str, expected_body: dict) -> bool:
-        return self.__contained_json_verification(endpoint, 'POST', expected_body)
+    def post_contained_json(self, endpoint: str, expected_body: dict, url_pattern: bool = False) -> bool:
+        return self.__contained_json_verification(endpoint, 'POST', expected_body, url_pattern)
 
-    def put_called(self, endpoint: str, times: int = 1) -> bool:
-        return self.__count_verification(endpoint, 'PUT', times)
+    def put_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
+        return self.__count_verification(endpoint, 'PUT', times, url_pattern)
 
-    def put_contained(self, endpoint: str, expected_body: str) -> bool:
-        return self.__contained_verification(endpoint, 'PUT', expected_body)
+    def put_contained(self, endpoint: str, expected_body: str, url_pattern: bool = False) -> bool:
+        return self.__contained_verification(endpoint, 'PUT', expected_body, url_pattern)
 
-    def put_contained_json(self, endpoint: str, expected_body: dict) -> bool:
-        return self.__contained_json_verification(endpoint, 'PUT', expected_body)
+    def put_contained_json(self, endpoint: str, expected_body: dict, url_pattern: bool = False) -> bool:
+        return self.__contained_json_verification(endpoint, 'PUT', expected_body, url_pattern)
 
-    def delete_called(self, endpoint: str, times: int = 1) -> bool:
-        return self.__count_verification(endpoint, 'DELETE', times)
+    def delete_called(self, endpoint: str, times: int = 1, url_pattern: bool = False) -> bool:
+        return self.__count_verification(endpoint, 'DELETE', times, url_pattern)
 
-    def delete_contained(self, endpoint: str, expected_body: str) -> bool:
-        return self.__contained_verification(endpoint, 'DELETE', expected_body)
+    def delete_contained(self, endpoint: str, expected_body: str, url_pattern: bool = False) -> bool:
+        return self.__contained_verification(endpoint, 'DELETE', expected_body, url_pattern)
 
-    def delete_contained_json(self, endpoint: str, expected_body: dict) -> bool:
-        return self.__contained_json_verification(endpoint, 'DELETE', expected_body)
+    def delete_contained_json(self, endpoint: str, expected_body: dict, url_pattern: bool = False) -> bool:
+        return self.__contained_json_verification(endpoint, 'DELETE', expected_body, url_pattern)
 
-    def __count_verification(self, endpoint, http_verb, times):
+    def __count_verification(self, endpoint, http_verb, times, url_pattern):
         payload = {
             'method': http_verb,
-            'url': endpoint
+            self.__get_url_type(url_pattern): endpoint
         }
         data = json.dumps(payload).encode('utf-8')
         request = urllib.request.Request(
@@ -60,10 +60,10 @@ def __count_verification(self, endpoint, http_verb, times):
             return call_count > 0
         return validation.matches(times, call_count)
 
-    def __get_request_bodies(self, endpoint, http_verb):
+    def __get_request_bodies(self, endpoint, http_verb, url_pattern):
         payload = {
             'method': http_verb,
-            'url': endpoint
+            self.__get_url_type(url_pattern): endpoint
         }
         data = json.dumps(payload).encode('utf-8')
         request = urllib.request.Request(
@@ -76,12 +76,17 @@ def __get_request_bodies(self, endpoint, http_verb):
             bodies.append(request['body'])
         return bodies
 
-    def __contained_verification(self, endpoint, http_verb, expected_body):
-        bodies = self.__get_request_bodies(endpoint, http_verb)
+    def __get_url_type(self, url_pattern: bool):
+        if url_pattern:
+            return 'urlPattern'
+        return 'url'
+
+    def __contained_verification(self, endpoint, http_verb, expected_body, url_pattern):
+        bodies = self.__get_request_bodies(endpoint, http_verb, url_pattern)
         return validation.contains(expected_body, bodies)
 
-    def __contained_json_verification(self, endpoint, http_verb, expected_body):
-        bodies = self.__get_request_bodies(endpoint, http_verb)
+    def __contained_json_verification(self, endpoint, http_verb, expected_body, url_pattern):
+        bodies = self.__get_request_bodies(endpoint, http_verb, url_pattern)
         for body in bodies:
             try:
                 body = json.loads(body)