Merge pull request #824 from adamtheturtle/test-image-too-large

Test image too large

Author: adamtheturtle

src/vws/exceptions.py

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

src/vws/vws.py

@@ -16,6 +16,7 @@
 
 from vws._authorization import authorization_header, rfc_1123_date
 from vws.exceptions import (
+    ImageTooLarge,
     MetadataTooLarge,
     TargetNameExist,
     TargetStatusProcessing,
@@ -110,6 +111,7 @@ class _ResultCodes(Enum):
 
 
 _EXCEPTIONS = {
+    _ResultCodes.IMAGE_TOO_LARGE: ImageTooLarge,
     _ResultCodes.METADATA_TOO_LARGE: MetadataTooLarge,
     _ResultCodes.TARGET_NAME_EXIST: TargetNameExist,
     _ResultCodes.TARGET_STATUS_PROCESSING: TargetStatusProcessing,

tests/test_exceptions/test_image_too_large.py

@@ -0,0 +1,66 @@
+"""
+Tests for giving an image which is too large.
+"""
+
+import io
+import random
+
+import pytest
+from PIL import Image
+from requests import codes
+
+from vws import VWS
+from vws.exceptions import ImageTooLarge
+
+
+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(client: VWS) -> 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:
+        client.add_target(name='x', width=1, image=png_too_large)
+
+    assert exc.value.response.status_code == codes.UNPROCESSABLE_ENTITY