Separate tests for VWS and VWQ exceptions

adamtheturtle · adamtheturtle · commit 9a8e8cc14b86 · 2020-09-06T23:12:51.000+01:00
diff --git a/src/vws/vws.py b/src/vws/vws.py
@@ -148,6 +148,12 @@ def _make_request(
 
         Returns:
             The response to the request made by `requests`.
+
+        Raises:
+            ~vws.exceptions.UnknownVWSErrorPossiblyBadName: Vuforia returns an
+                HTML page with the text "Oops, an error occurred". This has
+                been seen to happen when the given name includes a bad
+                character.
         """
         response = _target_api_request(
             server_access_key=self._server_access_key,
diff --git a/tests/test_cloud_reco_exceptions.py b/tests/test_cloud_reco_exceptions.py
@@ -0,0 +1,152 @@
+"""
+Tests for exceptions raised when using the CloudRecoService.
+"""
+
+import io
+from http import HTTPStatus
+
+import pytest
+import requests
+from mock_vws import MockVWS
+from mock_vws.database import VuforiaDatabase
+from mock_vws.states import States
+
+from vws import VWS, CloudRecoService
+from vws.exceptions.base_exceptions import CloudRecoException
+from vws.exceptions.cloud_reco_exceptions import (
+    AuthenticationFailure,
+    MatchProcessing,
+    MaxNumResultsOutOfRange,
+    InactiveProject,
+)
+from vws.exceptions.custom_exceptions import (
+    ConnectionErrorPossiblyImageTooLarge,
+)
+
+
+def test_too_many_max_results(
+    cloud_reco_client: CloudRecoService,
+    high_quality_image: io.BytesIO,
+) -> None:
+    """
+    A ``MaxNumResultsOutOfRange`` error is raised if the given
+    ``max_num_results`` is out of range.
+    """
+    with pytest.raises(MaxNumResultsOutOfRange) as exc:
+        cloud_reco_client.query(
+            image=high_quality_image,
+            max_num_results=51,
+        )
+
+    expected_value = (
+        "Integer out of range (51) in form data part 'max_result'. "
+        'Accepted range is from 1 to 50 (inclusive).'
+    )
+    assert str(exc.value) == exc.value.response.text == expected_value
+
+
+def test_image_too_large(
+    cloud_reco_client: CloudRecoService,
+    png_too_large: io.BytesIO,
+) -> None:
+    """
+    A ``ConnectionErrorPossiblyImageTooLarge`` exception is raised if an
+    image which is too large is given.
+    """
+    with pytest.raises(ConnectionErrorPossiblyImageTooLarge) as exc:
+        cloud_reco_client.query(image=png_too_large)
+
+    assert isinstance(exc.value, requests.ConnectionError)
+
+
+def test_cloudrecoexception_inheritance() -> None:
+    """
+    CloudRecoService-specific exceptions inherit from CloudRecoException.
+    """
+    subclasses = [
+        MatchProcessing,
+        MaxNumResultsOutOfRange,
+    ]
+    for subclass in subclasses:
+        assert issubclass(subclass, CloudRecoException)
+
+
+def test_base_exception(
+    vws_client: VWS,
+    cloud_reco_client: CloudRecoService,
+    high_quality_image: io.BytesIO,
+) -> None:
+    """
+    ``CloudRecoException``s has a response property.
+    """
+    vws_client.add_target(
+        name='x',
+        width=1,
+        image=high_quality_image,
+        active_flag=True,
+        application_metadata=None,
+    )
+
+    with pytest.raises(CloudRecoException) as exc:
+        cloud_reco_client.query(image=high_quality_image)
+
+    assert exc.value.response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR
+
+
+def test_match_processing(
+    vws_client: VWS,
+    cloud_reco_client: CloudRecoService,
+    high_quality_image: io.BytesIO,
+) -> None:
+    """
+    A ``MatchProcessing`` exception is raised when a target in processing is
+    matched.
+    """
+    vws_client.add_target(
+        name='x',
+        width=1,
+        image=high_quality_image,
+        active_flag=True,
+        application_metadata=None,
+    )
+    with pytest.raises(MatchProcessing) as exc:
+        cloud_reco_client.query(image=high_quality_image)
+    assert exc.value.response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR
+
+
+def test_authentication_failure(high_quality_image: io.BytesIO) -> None:
+    """
+    An ``AuthenticationFailure`` exception is raised when the client access key
+    exists but the client secret key is incorrect.
+    """
+    database = VuforiaDatabase()
+    cloud_reco_client = CloudRecoService(
+        client_access_key=database.client_access_key,
+        client_secret_key='a',
+    )
+    with MockVWS() as mock:
+        mock.add_database(database=database)
+
+        with pytest.raises(AuthenticationFailure) as exc:
+            cloud_reco_client.query(image=high_quality_image)
+
+        assert exc.value.response.status_code == HTTPStatus.UNAUTHORIZED
+
+
+def test_inactive_project(high_quality_image: io.BytesIO) -> None:
+    """
+    An ``InactiveProject`` exception is raised when querying an inactive
+    database.
+    """
+    database = VuforiaDatabase(state=States.PROJECT_INACTIVE)
+    with MockVWS() as mock:
+        mock.add_database(database=database)
+        cloud_reco_client = CloudRecoService(
+            client_access_key=database.client_access_key,
+            client_secret_key=database.client_secret_key,
+        )
+
+        with pytest.raises(InactiveProject) as exc:
+            cloud_reco_client.query(image=high_quality_image)
+
+        assert exc.value.response.status_code == HTTPStatus.FORBIDDEN
diff --git a/tests/test_query.py b/tests/test_query.py
@@ -5,16 +5,10 @@
 import io
 import uuid
 
-import pytest
-import requests
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 
 from vws import VWS, CloudRecoService
-from vws.exceptions.cloud_reco_exceptions import MaxNumResultsOutOfRange
-from vws.exceptions.custom_exceptions import (
-    ConnectionErrorPossiblyImageTooLarge,
-)
 from vws.include_target_data import CloudRecoIncludeTargetData
 
 
@@ -54,20 +48,6 @@ def test_match(
         [matching_target] = cloud_reco_client.query(image=high_quality_image)
         assert matching_target.target_id == target_id
 
-    def test_too_large(
-        self,
-        cloud_reco_client: CloudRecoService,
-        png_too_large: io.BytesIO,
-    ) -> None:
-        """
-        A ``ConnectionErrorPossiblyImageTooLarge`` exception is raised if an
-        image which is too large is given.
-        """
-        with pytest.raises(ConnectionErrorPossiblyImageTooLarge) as exc:
-            cloud_reco_client.query(image=png_too_large)
-
-        assert isinstance(exc.value, requests.ConnectionError)
-
 
 class TestCustomBaseVWQURL:
     """
@@ -182,27 +162,6 @@ def test_custom(
         )
         assert len(matches) == 2
 
-    def test_too_many(
-        self,
-        cloud_reco_client: CloudRecoService,
-        high_quality_image: io.BytesIO,
-    ) -> None:
-        """
-        A ``MaxNumResultsOutOfRange`` error is raised if the given
-        ``max_num_results`` is out of range.
-        """
-        with pytest.raises(MaxNumResultsOutOfRange) as exc:
-            cloud_reco_client.query(
-                image=high_quality_image,
-                max_num_results=51,
-            )
-
-        expected_value = (
-            "Integer out of range (51) in form data part 'max_result'. "
-            'Accepted range is from 1 to 50 (inclusive).'
-        )
-        assert str(exc.value) == exc.value.response.text == expected_value
-
 
 class TestIncludeTargetData:
     """
diff --git a/tests/test_vws_exceptions.py b/tests/test_vws_exceptions.py
@@ -1,5 +1,5 @@
 """
-Tests for various exceptions.
+Tests for VWS exceptions.
 """
 
 import io
@@ -11,13 +11,8 @@
 from mock_vws.database import VuforiaDatabase
 from mock_vws.states import States
 
-from vws import VWS, CloudRecoService
-from vws.exceptions.base_exceptions import CloudRecoException, VWSException
-from vws.exceptions.cloud_reco_exceptions import (
-    InactiveProject,
-    MatchProcessing,
-    MaxNumResultsOutOfRange,
-)
+from vws import VWS
+from vws.exceptions.base_exceptions import VWSException
 from vws.exceptions.custom_exceptions import UnknownVWSErrorPossiblyBadName
 from vws.exceptions.vws_exceptions import (
     AuthenticationFailure,
@@ -187,25 +182,6 @@ def test_project_inactive(high_quality_image: io.BytesIO) -> None:
         assert exc.value.response.status_code == HTTPStatus.FORBIDDEN
 
 
-def test_inactive_project(high_quality_image: io.BytesIO) -> None:
-    """
-    An ``InactiveProject`` exception is raised when querying an inactive
-    database.
-    """
-    database = VuforiaDatabase(state=States.PROJECT_INACTIVE)
-    with MockVWS() as mock:
-        mock.add_database(database=database)
-        cloud_reco_client = CloudRecoService(
-            client_access_key=database.client_access_key,
-            client_secret_key=database.client_secret_key,
-        )
-
-        with pytest.raises(InactiveProject) as exc:
-            cloud_reco_client.query(image=high_quality_image)
-
-        assert exc.value.response.status_code == HTTPStatus.FORBIDDEN
-
-
 def test_target_status_processing(
     vws_client: VWS,
     high_quality_image: io.BytesIO,
@@ -278,12 +254,14 @@ def test_authentication_failure(high_quality_image: io.BytesIO) -> None:
     incorrect.
     """
     database = VuforiaDatabase()
+
+    vws_client = VWS(
+        server_access_key=database.server_access_key,
+        server_secret_key='a',
+    )
+
     with MockVWS() as mock:
         mock.add_database(database=database)
-        vws_client = VWS(
-            server_access_key=database.server_access_key,
-            server_secret_key='a',
-        )
 
         with pytest.raises(AuthenticationFailure) as exc:
             vws_client.add_target(
@@ -296,16 +274,6 @@ def test_authentication_failure(high_quality_image: io.BytesIO) -> None:
 
         assert exc.value.response.status_code == HTTPStatus.UNAUTHORIZED
 
-        cloud_reco_client = CloudRecoService(
-            client_access_key=database.client_access_key,
-            client_secret_key='a',
-        )
-
-        with pytest.raises(AuthenticationFailure) as exc:
-            cloud_reco_client.query(image=high_quality_image)
-
-        assert exc.value.response.status_code == HTTPStatus.UNAUTHORIZED
-
 
 def test_target_status_not_success(
     vws_client: VWS,
@@ -330,27 +298,6 @@ def test_target_status_not_success(
     assert exc.value.target_id == target_id
 
 
-def test_match_processing(
-    vws_client: VWS,
-    cloud_reco_client: CloudRecoService,
-    high_quality_image: io.BytesIO,
-) -> None:
-    """
-    A ``MatchProcessing`` exception is raised when a target in processing is
-    matched.
-    """
-    vws_client.add_target(
-        name='x',
-        width=1,
-        image=high_quality_image,
-        active_flag=True,
-        application_metadata=None,
-    )
-    with pytest.raises(MatchProcessing) as exc:
-        cloud_reco_client.query(image=high_quality_image)
-    assert exc.value.response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR
-
-
 def test_vwsexception_inheritance() -> None:
     """
     VWS-related exceptions should inherit from VWSException.
@@ -377,27 +324,12 @@ def test_vwsexception_inheritance() -> None:
         assert issubclass(subclass, VWSException)
 
 
-def test_cloudrecoexception_inheritance() -> None:
-    """
-    CloudRecoService-specific exceptions should inherit from
-    CloudRecoException.
-    """
-    subclasses = [
-        MatchProcessing,
-        MaxNumResultsOutOfRange,
-    ]
-    for subclass in subclasses:
-        assert issubclass(subclass, CloudRecoException)
-
-
-def test_base_exceptions_properties(
+def test_base_exception(
     vws_client: VWS,
-    cloud_reco_client: CloudRecoService,
     high_quality_image: io.BytesIO,
 ) -> None:
     """
-    ``VWSException``s and ``CloudRecoException```s each have a response
-    property.
+    ``VWSException``s has a response property.
     """
     with pytest.raises(VWSException) as exc:
         vws_client.get_target_record(target_id='a')
@@ -411,11 +343,3 @@ def test_base_exceptions_properties(
         active_flag=True,
         application_metadata=None,
     )
-
-    with pytest.raises(CloudRecoException) as cloud_reco_exc:
-        cloud_reco_client.query(image=high_quality_image)
-
-    assert (
-        cloud_reco_exc.value.response.status_code
-        == HTTPStatus.INTERNAL_SERVER_ERROR
-    )
