Merge pull request #642 from adamtheturtle/metadata-too-large

Tests for "MetadataTooLarge"

Author: adamtheturtle

src/mock_vws/_mock_web_services_api.py

@@ -39,6 +39,7 @@
     validate_image_size,
     validate_keys,
     validate_metadata_encoding,
+    validate_metadata_size,
     validate_metadata_type,
     validate_name,
     validate_not_invalid_json,
@@ -155,6 +156,7 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
             decorators = [
                 parse_target_id,
                 validate_authorization,
+                validate_metadata_size,
                 validate_metadata_encoding,
                 validate_metadata_type,
                 validate_active_flag,

src/mock_vws/_validators.py

@@ -872,3 +872,46 @@ def validate_metadata_type(
         'result_code': ResultCodes.FAIL.value,
     }
     return json_dump(body)
+
+
+@wrapt.decorator
+def validate_metadata_size(
+    wrapped: Callable[..., str],
+    instance: Any,  # pylint: disable=unused-argument
+    args: Tuple[_RequestObjectProxy, _Context],
+    kwargs: Dict,
+) -> str:
+    """
+    Validate that the given application metadata is a string or 1024 * 1024
+    bytes or fewer.
+
+    Args:
+        wrapped: An endpoint function for `requests_mock`.
+        instance: The class that the endpoint function is in.
+        args: The arguments given to the endpoint function.
+        kwargs: The keyword arguments given to the endpoint function.
+
+    Returns:
+        The result of calling the endpoint.
+        An `UNPROCESSABLE_ENTITY` response if application metadata is given and
+        it is too large.
+    """
+    request, context = args
+
+    if not request.text:
+        return wrapped(*args, **kwargs)
+
+    application_metadata = request.json().get('application_metadata')
+    if application_metadata is None:
+        return wrapped(*args, **kwargs)
+    decoded = base64.b64decode(application_metadata)
+
+    if len(decoded) <= 1024 * 1024:
+        return wrapped(*args, **kwargs)
+
+    context.status_code = codes.UNPROCESSABLE_ENTITY
+    body = {
+        'transaction_id': uuid.uuid4().hex,
+        'result_code': ResultCodes.METADATA_TOO_LARGE.value,
+    }
+    return json_dump(body)

tests/mock_vws/test_add_target.py

@@ -645,18 +645,25 @@ class TestApplicationMetadata:
     Tests for the application metadata parameter.
     """
 
+    @pytest.mark.parametrize(
+        'metadata',
+        [
+            b'a',
+            b'a' * (1024 * 1024),
+        ],
+        ids=['Short', 'Max length'],
+    )
     def test_base64_encoded(
         self,
         vuforia_database_keys: VuforiaDatabaseKeys,
         png_rgb: io.BytesIO,
+        metadata: bytes,
     ) -> None:
         """
         A base64 encoded string is valid application metadata.
         """
         image_data = png_rgb.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
-
-        metadata = b'Some data'
         metadata_encoded = base64.b64encode(metadata).decode('ascii')
 
         data = {
@@ -767,3 +774,35 @@ def test_not_base64_encoded(
             status_code=codes.UNPROCESSABLE_ENTITY,
             result_code=ResultCodes.FAIL,
         )
+
+    def test_metadata_too_large(
+        self,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+        png_rgb: io.BytesIO,
+    ) -> None:
+        """
+        A base64 encoded string of up to 1024 * 1024 bytes is valid application
+        metadata.
+        """
+        image_data = png_rgb.read()
+        image_data_encoded = base64.b64encode(image_data).decode('ascii')
+        metadata = b'a' * (1024 * 1024 + 1)
+        metadata_encoded = base64.b64encode(metadata).decode('ascii')
+
+        data = {
+            'name': 'example_name',
+            'width': 1,
+            'image': image_data_encoded,
+            'application_metadata': metadata_encoded,
+        }
+
+        response = add_target_to_vws(
+            vuforia_database_keys=vuforia_database_keys,
+            data=data,
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.UNPROCESSABLE_ENTITY,
+            result_code=ResultCodes.METADATA_TOO_LARGE,
+        )