Merge pull request #815 from adamtheturtle/test-no-such-target

Test no such target

Author: adamtheturtle

src/vws/exceptions.py

@@ -0,0 +1,20 @@
+"""
+Custom exceptions for Vuforia errors.
+"""
+
+from requests import Response
+
+
+class UnknownTarget(Exception):
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'UnknownTarget'.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response to a request to Vuforia.
+        """
+        super().__init__()
+        self.response = response

src/vws/vws.py

@@ -5,6 +5,7 @@
 import base64
 import io
 import json
+from enum import Enum
 from time import sleep
 from typing import Dict, List, Union
 from urllib.parse import urljoin
@@ -14,6 +15,7 @@
 from requests import Response
 
 from vws._authorization import authorization_header, rfc_1123_date
+from vws.exceptions import UnknownTarget
 
 
 def _target_api_request(
@@ -74,6 +76,39 @@ def _target_api_request(
     return response
 
 
+class _ResultCodes(Enum):
+    """
+    Constants representing various VWS result codes.
+
+    See
+    https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
+
+    Some codes here are not documented in the above link.
+    """
+
+    SUCCESS = 'Success'
+    TARGET_CREATED = 'TargetCreated'
+    AUTHENTICATION_FAILURE = 'AuthenticationFailure'
+    REQUEST_TIME_TOO_SKEWED = 'RequestTimeTooSkewed'
+    TARGET_NAME_EXIST = 'TargetNameExist'
+    UNKNOWN_TARGET = 'UnknownTarget'
+    BAD_IMAGE = 'BadImage'
+    IMAGE_TOO_LARGE = 'ImageTooLarge'
+    METADATA_TOO_LARGE = 'MetadataTooLarge'
+    DATE_RANGE_ERROR = 'DateRangeError'
+    FAIL = 'Fail'
+    TARGET_STATUS_PROCESSING = 'TargetStatusProcessing'
+    REQUEST_QUOTA_REACHED = 'RequestQuotaReached'
+    TARGET_STATUS_NOT_SUCCESS = 'TargetStatusNotSuccess'
+    PROJECT_INACTIVE = 'ProjectInactive'
+    INACTIVE_PROJECT = 'InactiveProject'
+
+
+_EXCEPTIONS = {
+    _ResultCodes.UNKNOWN_TARGET: UnknownTarget,
+}
+
+
 class VWS:
     """
     An interface to Vuforia Web Services APIs.
@@ -162,7 +197,12 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
             base_vws_url=self._base_vws_url,
         )
 
-        return dict(response.json()['target_record'])
+        result_code = response.json()['result_code']
+        if _ResultCodes(result_code) == _ResultCodes.SUCCESS:
+            return dict(response.json()['target_record'])
+
+        exception = _EXCEPTIONS[_ResultCodes(result_code)]
+        raise exception(response=response)
 
     @timeout_decorator.timeout(seconds=60 * 5)
     def wait_for_target_processed(self, target_id: str) -> None:
@@ -187,11 +227,6 @@ def wait_for_target_processed(self, target_id: str) -> None:
             # hitting the request quota.
             sleep(0.2)
 
-            # We wait 0.2 seconds rather than less than that to decrease the
-            # number of calls made to the API, to decrease the likelihood of
-            # hitting the request quota.
-            sleep(0.2)
-
     def list_targets(self) -> List[str]:
         """
         List target IDs.
@@ -232,7 +267,12 @@ def get_target_summary_report(
             base_vws_url=self._base_vws_url,
         )
 
-        return dict(response.json())
+        result_code = response.json()['result_code']
+        if _ResultCodes(result_code) == _ResultCodes.SUCCESS:
+            return dict(response.json())
+
+        exception = _EXCEPTIONS[_ResultCodes(result_code)]
+        raise exception(response=response)
 
     def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
         """
@@ -259,3 +299,18 @@ def delete_target(self, target_id: str) -> None:
         Args:
             target_id: The ID of the target to delete.
         """
+        response = _target_api_request(
+            server_access_key=self._server_access_key,
+            server_secret_key=self._server_secret_key,
+            method='GET',
+            content=b'',
+            request_path=f'/summary/{target_id}',
+            base_vws_url=self._base_vws_url,
+        )
+
+        result_code = response.json()['result_code']
+        if _ResultCodes(result_code) == _ResultCodes.SUCCESS:
+            return
+
+        exception = _EXCEPTIONS[_ResultCodes(result_code)]
+        raise exception(response=response)

tests/test_unknown_target.py

@@ -0,0 +1,59 @@
+"""
+Tests for passing invalid target IDs to helpers which require a target ID to
+be given.
+"""
+
+from typing import Any, Callable, Dict, Union
+
+import pytest
+from _pytest.fixtures import SubRequest
+from requests import codes
+
+from vws import VWS
+from vws.exceptions import UnknownTarget
+
+
+@pytest.fixture()
+def _delete_target(client: VWS) -> Callable[[str], None]:
+    return client.delete_target
+
+
+@pytest.fixture()
+def _get_target_record(client: VWS,
+                       ) -> Callable[[str], Dict[str, Union[str, int]]]:
+    return client.get_target_record
+
+
+@pytest.fixture()
+def _wait_for_target_processed(client: VWS) -> Any:
+    return client.wait_for_target_processed
+
+
+@pytest.fixture()
+def _get_target_summary_report(
+    client: VWS,
+) -> Callable[[str], Dict[str, Union[str, int]]]:
+    return client.get_target_summary_report
+
+
+@pytest.mark.parametrize(
+    'fixture',
+    [
+        '_delete_target',
+        '_get_target_record',
+        '_wait_for_target_processed',
+        '_get_target_summary_report',
+    ],
+)
+def test_invalid_given_id(
+    fixture: Callable[[str], None],
+    request: SubRequest,
+) -> None:
+    """
+    Giving an invalid ID to a helper which requires a target ID to be given
+    causes an ``UnknownTarget`` exception to be raised.
+    """
+    func = request.getfixturevalue(fixture)
+    with pytest.raises(UnknownTarget) as exc:
+        func(target_id='x')
+    assert exc.value.response.status_code == codes.NOT_FOUND