Merge remote-tracking branch 'origin/master' into query-2

Author: adamtheturtle

tests/conftest.py

@@ -24,10 +24,8 @@ def _mock_database() -> Iterator[VuforiaDatabase]:
 
 
 @pytest.fixture()
-def client(_mock_database: VuforiaDatabase) -> Iterator[VWS]:
+def vws_client(_mock_database: VuforiaDatabase) -> Iterator[VWS]:
     """
-    # TODO rename this fixture
-
     Yield a VWS client which connects to a mock.
     """
     vws_client = VWS(

tests/test_exceptions.py

@@ -60,7 +60,7 @@ def _make_image_file(
     return image_buffer
 
 
-def test_image_too_large(client: VWS) -> None:
+def test_image_too_large(vws_client: VWS) -> None:
     """
     When giving an image which is too large, an ``ImageTooLarge`` exception is
     raised.
@@ -75,18 +75,18 @@ def test_image_too_large(client: VWS) -> None:
     )
 
     with pytest.raises(ImageTooLarge) as exc:
-        client.add_target(name='x', width=1, image=png_too_large)
+        vws_client.add_target(name='x', width=1, image=png_too_large)
 
     assert exc.value.response.status_code == codes.UNPROCESSABLE_ENTITY
 
 
-def test_invalid_given_id(client: VWS) -> None:
+def test_invalid_given_id(vws_client: VWS) -> None:
     """
     Giving an invalid ID to a helper which requires a target ID to be given
     causes an ``UnknownTarget`` exception to be raised.
     """
     with pytest.raises(UnknownTarget) as exc:
-        client.delete_target(target_id='x')
+        vws_client.delete_target(target_id='x')
     assert exc.value.response.status_code == codes.NOT_FOUND
 
 
@@ -102,13 +102,13 @@ def test_fail(high_quality_image: io.BytesIO) -> None:
     A ``Fail`` exception is raised when the server access key does not exist.
     """
     with MockVWS():
-        client = VWS(
+        vws_client = VWS(
             server_access_key='a',
             server_secret_key='a',
         )
 
         with pytest.raises(Fail) as exc:
-            client.add_target(
+            vws_client.add_target(
                 name='x',
                 width=1,
                 image=high_quality_image,
@@ -117,47 +117,50 @@ def test_fail(high_quality_image: io.BytesIO) -> None:
         assert exc.value.response.status_code == codes.BAD_REQUEST
 
 
-def test_bad_image(client: VWS) -> None:
+def test_bad_image(vws_client: VWS) -> None:
     """
     A ``BadImage`` exception is raised when a non-image is given.
     """
     not_an_image = io.BytesIO(b'Not an image')
     with pytest.raises(BadImage) as exc:
-        client.add_target(name='x', width=1, image=not_an_image)
+        vws_client.add_target(name='x', width=1, image=not_an_image)
 
     assert exc.value.response.status_code == codes.UNPROCESSABLE_ENTITY
 
 
 def test_target_name_exist(
-    client: VWS,
+    vws_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)
+    vws_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)
+        vws_client.add_target(name='x', width=1, image=high_quality_image)
 
     assert exc.value.response.status_code == codes.FORBIDDEN
 
 
-def test_project_inactive(client: VWS, high_quality_image: io.BytesIO) -> None:
+def test_project_inactive(
+    vws_client: VWS,
+    high_quality_image: io.BytesIO,
+) -> None:
     """
     A ``ProjectInactive`` exception is raised if adding a target to an
     inactive database.
     """
     database = VuforiaDatabase(state=States.PROJECT_INACTIVE)
     with MockVWS() as mock:
         mock.add_database(database=database)
-        client = VWS(
+        vws_client = VWS(
             server_access_key=database.server_access_key,
             server_secret_key=database.server_secret_key,
         )
 
         with pytest.raises(ProjectInactive) as exc:
-            client.add_target(
+            vws_client.add_target(
                 name='x',
                 width=1,
                 image=high_quality_image,
@@ -167,35 +170,35 @@ def test_project_inactive(client: VWS, high_quality_image: io.BytesIO) -> None:
 
 
 def test_target_status_processing(
-    client: VWS,
+    vws_client: VWS,
     high_quality_image: io.BytesIO,
 ) -> None:
     """
     A ``TargetStatusProcessing`` exception is raised if trying to delete a
     target which is processing.
     """
-    target_id = client.add_target(
+    target_id = vws_client.add_target(
         name='x',
         width=1,
         image=high_quality_image,
     )
 
     with pytest.raises(TargetStatusProcessing) as exc:
-        client.delete_target(target_id=target_id)
+        vws_client.delete_target(target_id=target_id)
 
     assert exc.value.response.status_code == codes.FORBIDDEN
 
 
 def test_metadata_too_large(
-    client: VWS,
+    vws_client: VWS,
     high_quality_image: io.BytesIO,
 ) -> None:
     """
     A ``MetadataTooLarge`` exception is raised if the metadata given is too
     large.
     """
     with pytest.raises(MetadataTooLarge) as exc:
-        client.add_target(
+        vws_client.add_target(
             name='x',
             width=1,
             image=high_quality_image,
@@ -213,13 +216,13 @@ def test_authentication_failure(high_quality_image: io.BytesIO) -> None:
     database = VuforiaDatabase()
     with MockVWS() as mock:
         mock.add_database(database=database)
-        client = VWS(
+        vws_client = VWS(
             server_access_key=database.server_access_key,
             server_secret_key='a',
         )
 
         with pytest.raises(AuthenticationFailure) as exc:
-            client.add_target(
+            vws_client.add_target(
                 name='x',
                 width=1,
                 image=high_quality_image,
@@ -229,20 +232,20 @@ def test_authentication_failure(high_quality_image: io.BytesIO) -> None:
 
 
 def test_target_status_not_success(
-    client: VWS,
+    vws_client: VWS,
     high_quality_image: io.BytesIO,
 ) -> None:
     """
     A ``TargetStatusNotSuccess`` exception is raised when updating a target
     which has a status which is not "Success".
     """
-    target_id = client.add_target(
+    target_id = vws_client.add_target(
         name='x',
         width=1,
         image=high_quality_image,
     )
 
     with pytest.raises(TargetStatusNotSuccess) as exc:
-        client.update_target(target_id=target_id)
+        vws_client.update_target(target_id=target_id)
 
     assert exc.value.response.status_code == codes.FORBIDDEN

tests/test_query.py

@@ -30,19 +30,19 @@ def test_no_matches(
 
     def test_match(
         self,
-        client: VWS,
+        vws_client: VWS,
         cloud_reco_client: CloudRecoService,
         high_quality_image: io.BytesIO,
     ) -> None:
         """
         XXX
         """
-        target_id = client.add_target(
+        target_id = vws_client.add_target(
             name='x',
             width=1,
             image=high_quality_image,
         )
-        client.wait_for_target_processed(target_id=target_id)
+        vws_client.wait_for_target_processed(target_id=target_id)
         [matching_target] = cloud_reco_client.query(image=high_quality_image)
         assert matching_target['target_id'] == target_id
 
@@ -54,55 +54,55 @@ class TestMaxNumResults:
 
     def test_default(
         self,
-        client: VWS,
+        vws_client: VWS,
         cloud_reco_client: CloudRecoService,
         high_quality_image: io.BytesIO,
     ) -> None:
         """
         XXX
         """
-        target_id = client.add_target(
+        target_id = vws_client.add_target(
             name=uuid.uuid4().hex,
             width=1,
             image=high_quality_image,
         )
-        target_id_2 = client.add_target(
+        target_id_2 = vws_client.add_target(
             name=uuid.uuid4().hex,
             width=1,
             image=high_quality_image,
         )
-        client.wait_for_target_processed(target_id=target_id)
-        client.wait_for_target_processed(target_id=target_id_2)
+        vws_client.wait_for_target_processed(target_id=target_id)
+        vws_client.wait_for_target_processed(target_id=target_id_2)
         matches = cloud_reco_client.query(image=high_quality_image)
         assert len(matches) == 1
 
     def test_custom(
         self,
-        client: VWS,
+        vws_client: VWS,
         cloud_reco_client: CloudRecoService,
         high_quality_image: io.BytesIO,
     ) -> None:
         """
         XXX
         """
-        target_id = client.add_target(
+        target_id = vws_client.add_target(
             name=uuid.uuid4().hex,
             width=1,
             image=high_quality_image,
         )
-        target_id_2 = client.add_target(
+        target_id_2 = vws_client.add_target(
             name=uuid.uuid4().hex,
             width=1,
             image=high_quality_image,
         )
-        target_id_3 = client.add_target(
+        target_id_3 = vws_client.add_target(
             name=uuid.uuid4().hex,
             width=1,
             image=high_quality_image,
         )
-        client.wait_for_target_processed(target_id=target_id)
-        client.wait_for_target_processed(target_id=target_id_2)
-        client.wait_for_target_processed(target_id=target_id_3)
+        vws_client.wait_for_target_processed(target_id=target_id)
+        vws_client.wait_for_target_processed(target_id=target_id_2)
+        vws_client.wait_for_target_processed(target_id=target_id_3)
         matches = cloud_reco_client.query(
             image=high_quality_image,
             max_num_results=2,