Merge pull request #1046 from adamtheturtle/test-update-image

Test update image

Author: adamtheturtle

spelling_private_dict.txt

@@ -1,9 +1,11 @@
 AuthenticationFailure
 BadImage
 ImageTooLarge
+MatchProcessing
 MaxNumResultsOutOfRange
 MetadataTooLarge
 ProjectInactive
+RequestTimeTooSkewed
 TargetNameExist
 TargetProcessingTimeout
 TargetStatusProcessing

src/vws/query.py

@@ -64,6 +64,9 @@ def query(
                 is not correct.
             ~vws.exceptions.MaxNumResultsOutOfRange: `max_num_results`` is not
                 within the range (1, 50).
+            ~vws.exceptions.MatchProcessing: The given image matches a target
+                which was recently added, updated or deleted and Vuforia
+                returns an error in this case.
             ~vws.exceptions.ProjectInactive: The project is inactive.
 
         Returns:

tests/fixtures/images.py

@@ -3,8 +3,43 @@
 """
 
 import io
+import random
 
 import pytest
+from PIL import Image
+
+
+def _make_image_file(
+    file_format: str,
+    color_space: str,
+    width: int,
+    height: int,
+) -> io.BytesIO:
+    """
+    Return an image file in the given format and color space.
+
+    The image file is filled with randomly colored pixels.
+
+    Args:
+        file_format: See
+            http://pillow.readthedocs.io/en/3.1.x/handbook/image-file-formats.html
+        color_space: One of "L", "RGB", or "CMYK".
+        width: The width, in pixels of the image.
+        height: The width, in pixels of the image.
+
+    Returns:
+        An image file in the given format and color space.
+    """
+    image_buffer = io.BytesIO()
+    reds = random.choices(population=range(0, 255), k=width * height)
+    greens = random.choices(population=range(0, 255), k=width * height)
+    blues = random.choices(population=range(0, 255), k=width * height)
+    pixels = list(zip(reds, greens, blues))
+    image = Image.new(color_space, (width, height))
+    image.putdata(pixels)
+    image.save(image_buffer, file_format)
+    image_buffer.seek(0)
+    return image_buffer
 
 
 @pytest.fixture()
@@ -18,3 +53,34 @@ def high_quality_image() -> io.BytesIO:
     path = 'tests/data/high_quality_image.jpg'
     with open(path, 'rb') as high_quality_image_file:
         return io.BytesIO(high_quality_image_file.read())
+
+
+@pytest.fixture
+def image_file_failed_state() -> io.BytesIO:
+    """
+    Return an image file which is expected to be accepted by the add and
+    update target endpoints, but get a "failed" status.
+    """
+    # This image gets a "failed" status because it is so small.
+    return _make_image_file(
+        file_format='PNG',
+        color_space='RGB',
+        width=1,
+        height=1,
+    )
+
+
+@pytest.fixture
+def png_too_large() -> io.BytesIO:
+    """
+    Return a PNG file which has dimensions which are too large to be added to
+    a Vuforia database.
+    """
+    width = height = 890
+
+    return _make_image_file(
+        file_format='PNG',
+        color_space='RGB',
+        width=width,
+        height=height,
+    )

tests/test_exceptions.py

@@ -3,14 +3,12 @@
 """
 
 import io
-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
-from PIL import Image
 from requests import codes
 
 from vws import VWS, CloudRecoService
@@ -30,53 +28,14 @@
 )
 
 
-def _make_image_file(
-    file_format: str,
-    color_space: str,
-    width: int,
-    height: int,
-) -> io.BytesIO:
-    """
-    Return an image file in the given format and color space.
-
-    The image file is filled with randomly colored pixels.
-
-    Args:
-        file_format: See
-            http://pillow.readthedocs.io/en/3.1.x/handbook/image-file-formats.html
-        color_space: One of "L", "RGB", or "CMYK".
-        width: The width, in pixels of the image.
-        height: The width, in pixels of the image.
-
-    Returns:
-        An image file in the given format and color space.
-    """
-    image_buffer = io.BytesIO()
-    reds = random.choices(population=range(0, 255), k=width * height)
-    greens = random.choices(population=range(0, 255), k=width * height)
-    blues = random.choices(population=range(0, 255), k=width * height)
-    pixels = list(zip(reds, greens, blues))
-    image = Image.new(color_space, (width, height))
-    image.putdata(pixels)
-    image.save(image_buffer, file_format)
-    image_buffer.seek(0)
-    return image_buffer
-
-
-def test_image_too_large(vws_client: VWS) -> None:
+def test_image_too_large(
+    vws_client: VWS,
+    png_too_large: io.BytesIO,
+) -> None:
     """
     When giving an image which is too large, an ``ImageTooLarge`` exception is
     raised.
     """
-    width = height = 890
-
-    png_too_large = _make_image_file(
-        file_format='PNG',
-        color_space='RGB',
-        width=width,
-        height=height,
-    )
-
     with pytest.raises(ImageTooLarge) as exc:
         vws_client.add_target(name='x', width=1, image=png_too_large)
 

tests/test_vws.py

@@ -454,6 +454,7 @@ def test_update_target(
         self,
         vws_client: VWS,
         high_quality_image: io.BytesIO,
+        image_file_failed_state: io.BytesIO,
     ) -> None:
         """
         It is possible to update a target.
@@ -465,21 +466,24 @@ def test_update_target(
             active_flag=True,
         )
         vws_client.wait_for_target_processed(target_id=target_id)
+        report = vws_client.get_target_summary_report(target_id=target_id)
+        assert report['status'] == 'success'
         vws_client.update_target(
             target_id=target_id,
             name='x2',
             width=2,
             active_flag=False,
-            # These will be tested in
-            # https://github.com/adamtheturtle/vws-python/issues/809.
-            image=high_quality_image,
+            image=image_file_failed_state,
             application_metadata=b'a',
         )
 
+        vws_client.wait_for_target_processed(target_id=target_id)
         target_details = vws_client.get_target_record(target_id=target_id)
         assert target_details['name'] == 'x2'
         assert target_details['width'] == 2
         assert not target_details['active_flag']
+        report = vws_client.get_target_summary_report(target_id=target_id)
+        assert report['status'] == 'failed'
 
     def test_no_fields_given(
         self,