Merge pull request #654 from adamtheturtle/test-request-usage

Test request usage field

Author: adamtheturtle

src/mock_vws/_mock_web_services_api.py

@@ -11,7 +11,7 @@
 import random
 import statistics
 import uuid
-from typing import Callable, Dict, List, Optional, Set, Tuple, Union
+from typing import Any, Callable, Dict, List, Optional, Set, Tuple, Union
 
 import pytz
 import wrapt
@@ -49,6 +49,29 @@
 )
 
 
+@wrapt.decorator
+def update_request_count(
+    wrapped: Callable[..., str],
+    instance: Any,
+    args: Tuple[_RequestObjectProxy, _Context],
+    kwargs: Dict,
+) -> str:
+    """
+    Add to the request count.
+
+    Args:
+        wrapped: An endpoint function for `requests_mock`.
+        instance: The class that the endpoint function is in.
+        args: The arguments given to the endpoint function.
+        kwargs: The keyword arguments given to the endpoint function.
+
+    Returns:
+        The result of calling the endpoint.
+    """
+    instance.request_count += 1
+    return wrapped(*args, **kwargs)
+
+
 @wrapt.decorator
 def parse_target_id(
     wrapped: Callable[..., str],
@@ -151,8 +174,6 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
                 validate_not_invalid_json,
                 validate_date,
                 validate_date_header_given,
-                validate_auth_header_exists,
-                set_content_length_header,
             ]
         else:
             decorators = [
@@ -176,11 +197,15 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
                 validate_date,
                 validate_date_header_given,
                 validate_not_invalid_json,
-                validate_auth_header_exists,
-                set_content_length_header,
             ]
 
-        for decorator in decorators:
+        common_decorators = [
+            validate_auth_header_exists,
+            set_content_length_header,
+            update_request_count,
+        ]
+
+        for decorator in decorators + common_decorators:
             method = decorator(method)
 
         return method
@@ -368,6 +393,7 @@ def __init__(  # pylint: disable=too-many-arguments
         self.state = state
 
         self._processing_time_seconds = processing_time_seconds
+        self.request_count = 0
 
     @route(
         path_pattern='/targets',
@@ -516,7 +542,7 @@ def database_summary(
             'processing_images': processing_images,
             'reco_threshold': 1000,
             'request_quota': 100000,
-            'request_usage': '',
+            'request_usage': self.request_count,
         }
         return json_dump(body)
 

tests/mock_vws/test_database_summary.py

@@ -17,6 +17,7 @@
     add_target_to_vws,
     database_summary,
     delete_target,
+    query,
     wait_for_target_processed,
 )
 from tests.mock_vws.utils.assertions import assert_vws_response
@@ -362,7 +363,7 @@ def test_processing_images(
 @pytest.mark.usefixtures('verify_mock_vuforia')
 class TestQuotas:
     """
-    Tests for the mock of the database summary endpoint at `GET /summary`.
+    Tests for quotas and thresholds.
     """
 
     def test_quotas(self, vuforia_database_keys: VuforiaDatabaseKeys) -> None:
@@ -379,6 +380,93 @@ def test_quotas(self, vuforia_database_keys: VuforiaDatabaseKeys) -> None:
         assert response.json()['reco_threshold'] == 1000
 
 
+@pytest.mark.usefixtures('verify_mock_vuforia')
+class TestRequestUsage:
+    """
+    Tests for the ``request_usage`` field.
+    """
+
+    def test_target_request(
+        self,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+    ) -> None:
+        """
+        The ``request_usage`` count increases with each request to the target
+        API.
+        """
+        response = database_summary(
+            vuforia_database_keys=vuforia_database_keys,
+        )
+
+        original_request_usage = response.json()['request_usage']
+
+        response = database_summary(
+            vuforia_database_keys=vuforia_database_keys,
+        )
+
+        new_request_usage = response.json()['request_usage']
+        assert new_request_usage == original_request_usage + 1
+
+    def test_bad_target_request(
+        self,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+    ) -> None:
+        """
+        The ``request_usage`` count increases with each request to the target
+        API, even if it is a bad request.
+        """
+        response = database_summary(
+            vuforia_database_keys=vuforia_database_keys,
+        )
+
+        original_request_usage = response.json()['request_usage']
+
+        response = add_target_to_vws(
+            vuforia_database_keys=vuforia_database_keys,
+            # Missing data.
+            data={},
+        )
+
+        assert response.status_code == codes.BAD_REQUEST
+
+        response = database_summary(
+            vuforia_database_keys=vuforia_database_keys,
+        )
+        new_request_usage = response.json()['request_usage']
+        assert new_request_usage == original_request_usage + 2
+
+    def test_query_request(
+        self,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        The ``request_usage`` count does not increase with each query.
+        """
+        response = database_summary(
+            vuforia_database_keys=vuforia_database_keys,
+        )
+
+        original_request_usage = response.json()['request_usage']
+
+        image_content = high_quality_image.getvalue()
+        body = {'image': ('image.jpeg', image_content, 'image/jpeg')}
+        query_resp = query(
+            vuforia_database_keys=vuforia_database_keys,
+            body=body,
+        )
+
+        assert query_resp.status_code == codes.OK
+
+        response = database_summary(
+            vuforia_database_keys=vuforia_database_keys,
+        )
+        new_request_usage = response.json()['request_usage']
+        # The request usage goes up for the database summary request, not the
+        # query.
+        assert new_request_usage == original_request_usage + 1
+
+
 @pytest.mark.usefixtures('verify_mock_vuforia_inactive')
 class TestInactiveProject:
     """