Merge pull request #1045 from adamtheturtle/test-request-time-too-skewed

Test request time too skewed

Author: adamtheturtle

dev-requirements.txt

@@ -7,6 +7,7 @@ dulwich==0.19.11
 flake8-commas==2.0.0  # Require silicon valley commas
 flake8-quotes==2.0.1  # Require single quotes
 flake8==3.7.8  # Lint
+freezegun==0.3.12
 isort==4.3.21  # Lint imports
 mypy==0.720  # Type checking
 pip_check_reqs==2.0.3

src/vws/_result_codes.py

@@ -11,6 +11,7 @@
     ImageTooLarge,
     MetadataTooLarge,
     ProjectInactive,
+    RequestTimeTooSkewed,
     TargetNameExist,
     TargetStatusNotSuccess,
     TargetStatusProcessing,
@@ -43,6 +44,7 @@ def raise_for_result_code(
         'InactiveProject': ProjectInactive,
         'MetadataTooLarge': MetadataTooLarge,
         'ProjectInactive': ProjectInactive,
+        'RequestTimeTooSkewed': RequestTimeTooSkewed,
         'TargetNameExist': TargetNameExist,
         'TargetStatusNotSuccess': TargetStatusNotSuccess,
         'TargetStatusProcessing': TargetStatusProcessing,

src/vws/exceptions.py

@@ -203,6 +203,21 @@ def response(self) -> Response:
         return self._response
 
 
+class RequestTimeTooSkewed(Exception):
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'RequestTimeTooSkewed'.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response to a request to Vuforia.
+        """
+        super().__init__()
+        self.response = response
+
+
 class TargetNameExist(Exception):
     """
     Exception raised when Vuforia returns a response with a result code

src/vws/query.py

@@ -60,8 +60,11 @@ def query(
                 none (return no target_data), all (for all matched targets)".
 
         Raises:
+            ~vws.exceptions.AuthenticationFailure: The client access key pair
+                is not correct.
             ~vws.exceptions.MaxNumResultsOutOfRange: `max_num_results`` is not
                 within the range (1, 50).
+            ~vws.exceptions.ProjectInactive: The project is inactive.
 
         Returns:
             An ordered list of target details of matching targets.

src/vws/vws.py

@@ -176,6 +176,8 @@ def add_target(
             ~vws.exceptions.TargetNameExist: A target with the given ``name``
                 already exists.
             ~vws.exceptions.ProjectInactive: The project is inactive.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         image_data = image.getvalue()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
@@ -224,6 +226,8 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
                 example, the given access key does not match a known database.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         response = self._make_request(
             method='GET',
@@ -256,6 +260,8 @@ def _wait_for_target_processed(
                 than five minutes.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         while True:
             report = self.get_target_summary_report(target_id=target_id)
@@ -294,6 +300,8 @@ def wait_for_target_processed(
                 processing stage for more than ``timeout_seconds`` seconds.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
 
         @timeout(
@@ -323,6 +331,8 @@ def list_targets(self) -> List[str]:
                 correct.
             ~vws.exceptions.Fail: There was an error with the request. For
                 example, the given access key does not match a known database.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         response = self._make_request(
             method='GET',
@@ -356,6 +366,8 @@ def get_target_summary_report(
                 example, the given access key does not match a known database.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         response = self._make_request(
             method='GET',
@@ -381,6 +393,8 @@ def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
                 correct.
             ~vws.exceptions.Fail: There was an error with the request. For
                 example, the given access key does not match a known database.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         response = self._make_request(
             method='GET',
@@ -410,6 +424,8 @@ def delete_target(self, target_id: str) -> None:
                 target in the database.
             ~vws.exceptions.TargetStatusProcessing: The given target is in the
                 processing state.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         self._make_request(
             method='DELETE',
@@ -439,6 +455,8 @@ def get_duplicate_targets(self, target_id: str) -> List[str]:
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
             ~vws.exceptions.ProjectInactive: The project is inactive.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         response = self._make_request(
             method='GET',
@@ -489,6 +507,8 @@ def update_target(
             ~vws.exceptions.TargetNameExist: A target with the given ``name``
                 already exists.
             ~vws.exceptions.ProjectInactive: The project is inactive.
+            ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
+                time sent to Vuforia.
         """
         data: Dict[str, Union[str, bool, float, int]] = {}
 

tests/test_exceptions.py

@@ -6,6 +6,7 @@
 import random
 
 import pytest
+from freezegun import freeze_time
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 from mock_vws.states import States
@@ -21,6 +22,7 @@
     MatchProcessing,
     MetadataTooLarge,
     ProjectInactive,
+    RequestTimeTooSkewed,
     TargetNameExist,
     TargetStatusNotSuccess,
     TargetStatusProcessing,
@@ -219,6 +221,28 @@ def test_metadata_too_large(
     assert exc.value.response.status_code == codes.UNPROCESSABLE_ENTITY
 
 
+def test_request_time_too_skewed(vws_client: VWS) -> None:
+    """
+    A ``RequestTimeTooSkewed`` exception is raised when the request time is
+    more than five minutes different from the server time.
+    """
+    vws_max_time_skew = 60 * 5
+    leeway = 10
+    time_difference_from_now = vws_max_time_skew + leeway
+
+    # We use a custom tick because we expect the following:
+    #
+    # * At least one time check when creating the request
+    # * At least one time check when processing the request
+    #
+    # >= 1 ticks are acceptable.
+    with freeze_time(auto_tick_seconds=time_difference_from_now):
+        with pytest.raises(RequestTimeTooSkewed) as exc:
+            vws_client.get_target_record(target_id='a')
+
+    assert exc.value.response.status_code == codes.FORBIDDEN
+
+
 def test_authentication_failure(high_quality_image: io.BytesIO) -> None:
     """
     An ``AuthenticationFailure`` exception is raised when the server access key