Progress towards switching from requests_mock to responses

adamtheturtle · adamtheturtle · commit a0ad12d22d82 · 2024-08-30T01:04:43.000+01:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -44,7 +44,7 @@ dependencies = [
     "piq",
     "pydantic-settings",
     "requests",
-    "requests-mock",
+    "responses",
     "torch",
     "torchmetrics",
     "tzdata; sys_platform=='win32'",
diff --git a/src/mock_vws/_requests_mock_server/decorators.py b/src/mock_vws/_requests_mock_server/decorators.py
@@ -132,6 +132,7 @@ def __enter__(self) -> Self:
                     method=vws_http_method,
                     url=compiled_url_pattern,
                     callback=getattr(self._mock_vws_api, vws_route.route_name),
+                    content_type=None,
                 )
 
         for vwq_route in self._mock_vwq_api.routes:
@@ -147,6 +148,7 @@ def __enter__(self) -> Self:
                     method=vwq_http_method,
                     url=compiled_url_pattern,
                     callback=getattr(self._mock_vwq_api, vwq_route.route_name),
+                    content_type=None,
                 )
 
         if self._real_http:
diff --git a/src/mock_vws/_requests_mock_server/mock_web_query_api.py b/src/mock_vws/_requests_mock_server/mock_web_query_api.py
@@ -7,7 +7,9 @@
 
 import email.utils
 from collections.abc import Callable
-from http import HTTPMethod
+from http import HTTPMethod, HTTPStatus
+
+from requests.models import PreparedRequest
 
 from mock_vws._mock_common import Route
 from mock_vws._query_tools import (
@@ -22,7 +24,7 @@
 
 _ROUTES: set[Route] = set()
 
-_ResponseType = str
+_ResponseType = tuple[int, dict[str, str], str]
 
 
 def route(
@@ -64,11 +66,15 @@ def decorator(
     return decorator
 
 
-def _body_bytes(request: "Request") -> bytes:
+def _body_bytes(request: PreparedRequest) -> bytes:
     """
     Return the body of a request as bytes.
     """
-    return request.body or b""
+    if request.body is None:
+        return b""
+
+    assert isinstance(request.body, bytes)
+    return request.body
 
 
 class MockVuforiaWebQueryAPI:
@@ -97,28 +103,26 @@ def __init__(
         self._query_match_checker = query_match_checker
 
     @route(path_pattern="/v1/query", http_methods={HTTPMethod.POST})
-    def query(self, request: "Request", context: "Context") -> _ResponseType:
+    def query(self, request: PreparedRequest) -> _ResponseType:
         """
         Perform an image recognition query.
         """
         try:
             run_query_validators(
-                request_path=request.path,
+                request_path=request.path_url,
                 request_headers=request.headers,
                 request_body=_body_bytes(request=request),
-                request_method=request.method,
+                request_method=request.method or "",
                 databases=self._target_manager.databases,
             )
         except ValidatorError as exc:
-            context.headers = exc.headers
-            context.status_code = exc.status_code
-            return exc.response_text
+            return exc.status_code, exc.headers, exc.response_text
 
         response_text = get_query_match_response_text(
             request_headers=request.headers,
             request_body=_body_bytes(request=request),
-            request_method=request.method,
-            request_path=request.path,
+            request_method=request.method or "",
+            request_path=request.path_url,
             databases=self._target_manager.databases,
             query_match_checker=self._query_match_checker,
         )
@@ -128,11 +132,11 @@ def query(self, request: "Request", context: "Context") -> _ResponseType:
             localtime=False,
             usegmt=True,
         )
-        context.headers = {
+        headers = {
             "Connection": "keep-alive",
             "Content-Type": "application/json",
             "Server": "nginx",
             "Date": date,
             "Content-Length": str(len(response_text)),
         }
-        return response_text
+        return HTTPStatus.OK, headers, response_text
diff --git a/src/mock_vws/_requests_mock_server/mock_web_services_api.py b/src/mock_vws/_requests_mock_server/mock_web_services_api.py
@@ -38,13 +38,13 @@
 
 _ROUTES: set[Route] = set()
 
-_ResponseType = str
+_ResponseType = tuple[int, dict[str, str], str]
 
 
 def route(
     path_pattern: str,
     http_methods: set[HTTPMethod],
-) -> Callable[[Callable[..., str]], Callable[..., _ResponseType]]:
+) -> Callable[[Callable[..., _ResponseType]], Callable[..., _ResponseType]]:
     """
     Register a decorated method so that it can be recognized as a route.
 
@@ -184,14 +184,14 @@ def add_target(self, request: PreparedRequest) -> _ResponseType:
             localtime=False,
             usegmt=True,
         )
-        context.status_code = HTTPStatus.CREATED
+        status_code = HTTPStatus.CREATED
         body = {
             "transaction_id": uuid.uuid4().hex,
             "result_code": ResultCodes.TARGET_CREATED.value,
             "target_id": new_target.target_id,
         }
         body_json = json_dump(body=body)
-        context.headers = {
+        headers = {
             "Connection": "keep-alive",
             "Content-Type": "application/json",
             "server": "envoy",
@@ -202,7 +202,7 @@ def add_target(self, request: PreparedRequest) -> _ResponseType:
             "x-aws-region": "us-east-2, us-west-2",
             "x-content-type-options": "nosniff",
         }
-        return body_json
+        return status_code, headers, body_json
 
     @route(
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
@@ -240,9 +240,11 @@ def delete_target(self, request: PreparedRequest) -> _ResponseType:
 
         if target.status == TargetStatuses.PROCESSING.value:
             target_processing_exception = TargetStatusProcessingError()
-            context.headers = target_processing_exception.headers
-            context.status_code = target_processing_exception.status_code
-            return target_processing_exception.response_text
+            return (
+                target_processing_exception.status_code,
+                target_processing_exception.headers,
+                target_processing_exception.response_text,
+            )
 
         now = datetime.datetime.now(tz=target.upload_date.tzinfo)
         new_target = dataclasses.replace(target, delete_date=now)
@@ -280,7 +282,6 @@ def database_summary(self, request: PreparedRequest) -> _ResponseType:
         Fake implementation of
         https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#summary-report
         """
-        breakpoint()
         try:
             run_services_validators(
                 request_headers=request.headers,
@@ -516,7 +517,7 @@ def get_duplicates(self, request: PreparedRequest) -> _ResponseType:
             "similar_targets": similar_targets,
         }
         body_json = json_dump(body=body)
-        context.headers = {
+        headers = {
             "Connection": "keep-alive",
             "Content-Length": str(len(body_json)),
             "Content-Type": "application/json",
@@ -528,7 +529,7 @@ def get_duplicates(self, request: PreparedRequest) -> _ResponseType:
             "x-content-type-options": "nosniff",
         }
 
-        return body_json
+        return HTTPStatus.OK, headers, body_json
 
     @route(
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
@@ -572,9 +573,11 @@ def update_target(self, request: PreparedRequest) -> _ResponseType:
 
         if target.status != TargetStatuses.SUCCESS.value:
             exception = TargetStatusNotSuccessError()
-            context.headers = exception.headers
-            context.status_code = exception.status_code
-            return exception.response_text
+            return (
+                exception.status_code,
+                exception.headers,
+                exception.response_text,
+            )
 
         request_json: dict[str, Any] = json.loads(s=request.body or b"")
         width = request_json.get("width", target.width)
@@ -591,18 +594,22 @@ def update_target(self, request: PreparedRequest) -> _ResponseType:
 
         if "active_flag" in request_json and active_flag is None:
             fail_exception = FailError(status_code=HTTPStatus.BAD_REQUEST)
-            context.headers = fail_exception.headers
-            context.status_code = fail_exception.status_code
-            return fail_exception.response_text
+            return (
+                fail_exception.status_code,
+                fail_exception.headers,
+                fail_exception.response_text,
+            )
 
         if (
             "application_metadata" in request_json
             and application_metadata is None
         ):
             fail_exception = FailError(status_code=HTTPStatus.BAD_REQUEST)
-            context.headers = fail_exception.headers
-            context.status_code = fail_exception.status_code
-            return fail_exception.response_text
+            return (
+                fail_exception.status_code,
+                fail_exception.headers,
+                fail_exception.response_text,
+            )
 
         gmt = ZoneInfo(key="GMT")
         last_modified_date = datetime.datetime.now(tz=gmt)
@@ -636,7 +643,7 @@ def update_target(self, request: PreparedRequest) -> _ResponseType:
             "x-aws-region": "us-east-2, us-west-2",
             "x-content-type-options": "nosniff",
         }
-        return body_json
+        return HTTPStatus.OK, headers, body_json
 
     @route(
         path_pattern=f"/summary/{_TARGET_ID_PATTERN}",
@@ -658,9 +665,7 @@ def target_summary(self, request: PreparedRequest) -> _ResponseType:
                 databases=self._target_manager.databases,
             )
         except ValidatorError as exc:
-            context.headers = exc.headers
-            context.status_code = exc.status_code
-            return exc.response_text
+            return exc.status_code, exc.headers, exc.response_text
 
         database = get_database_matching_server_keys(
             request_headers=request.headers,
@@ -691,7 +696,7 @@ def target_summary(self, request: PreparedRequest) -> _ResponseType:
             "previous_month_recos": target.previous_month_recos,
         }
         body_json = json_dump(body=body)
-        context.headers = {
+        headers = {
             "Connection": "keep-alive",
             "Content-Length": str(len(body_json)),
             "Content-Type": "application/json",
@@ -703,4 +708,4 @@ def target_summary(self, request: PreparedRequest) -> _ResponseType:
             "x-content-type-options": "nosniff",
         }
 
-        return body_json
+        return HTTPStatus.OK, headers, body_json
diff --git a/tests/mock_vws/test_requests_mock_usage.py b/tests/mock_vws/test_requests_mock_usage.py
@@ -80,7 +80,7 @@ def test_default() -> None:
         By default, the mock stops any requests made with `requests` to
         non-Vuforia addresses, but not to mocked Vuforia endpoints.
         """
-        with MockVWS() as mock:
+        with MockVWS():
             with pytest.raises(
                 expected_exception=requests.exceptions.ConnectionError
             ):

Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,7 @@ def __enter__(self) -> Self:`
`132`	`132`	`method=vws_http_method,`
`133`	`133`	`url=compiled_url_pattern,`
`134`	`134`	`callback=getattr(self._mock_vws_api, vws_route.route_name),`
	`135`	`+ content_type=None,`
`135`	`136`	`)`
`136`	`137`
`137`	`138`	`for vwq_route in self._mock_vwq_api.routes:`
`@@ -147,6 +148,7 @@ def __enter__(self) -> Self:`
`147`	`148`	`method=vwq_http_method,`
`148`	`149`	`url=compiled_url_pattern,`
`149`	`150`	`callback=getattr(self._mock_vwq_api, vwq_route.route_name),`
	`151`	`+ content_type=None,`
`150`	`152`	`)`
`151`	`153`
`152`	`154`	`if self._real_http:`