Merge pull request #820 from adamtheturtle/test-name-exitst

Add TargetNameExist error

Author: adamtheturtle

src/vws/exceptions.py

@@ -48,3 +48,18 @@ def __init__(self, response: Response) -> None:
         """
         super().__init__()
         self.response = response
+
+
+class TargetNameExist(Exception):
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'TargetNameExist'.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response to a request to Vuforia.
+        """
+        super().__init__()
+        self.response = response

src/vws/vws.py

@@ -17,6 +17,7 @@
 from vws._authorization import authorization_header, rfc_1123_date
 from vws.exceptions import (
     MetadataTooLarge,
+    TargetNameExist,
     TargetStatusProcessing,
     UnknownTarget,
 )
@@ -109,9 +110,10 @@ class _ResultCodes(Enum):
 
 
 _EXCEPTIONS = {
-    _ResultCodes.UNKNOWN_TARGET: UnknownTarget,
-    _ResultCodes.TARGET_STATUS_PROCESSING: TargetStatusProcessing,
     _ResultCodes.METADATA_TOO_LARGE: MetadataTooLarge,
+    _ResultCodes.TARGET_NAME_EXIST: TargetNameExist,
+    _ResultCodes.TARGET_STATUS_PROCESSING: TargetStatusProcessing,
+    _ResultCodes.UNKNOWN_TARGET: UnknownTarget,
 }
 
 

tests/test_add_target.py

@@ -9,7 +9,7 @@
 from requests import codes
 
 from vws import VWS
-from vws.exceptions import MetadataTooLarge
+from vws.exceptions import MetadataTooLarge, TargetNameExist
 
 
 class TestSuccess:
@@ -51,6 +51,28 @@ def test_add_two_targets(
         client.add_target(name='a', width=1, image=high_quality_image)
 
 
+class TestName:
+    """
+    Tests for the ``name`` parameter to ``add_target``.
+    """
+
+    def test_add_two_targets_same_name(
+        self,
+        client: VWS,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        A ``TargetNameExist`` exception is raised after adding two targets with
+        the same name.
+        """
+        client.add_target(name='x', width=1, image=high_quality_image)
+
+        with pytest.raises(TargetNameExist) as exc:
+            client.add_target(name='x', width=1, image=high_quality_image)
+
+        assert exc.value.response.status_code == codes.FORBIDDEN
+
+
 class TestCustomBaseURL:
     """
     Tests for adding images to databases under custom VWS URLs.