Merge pull request #643 from adamtheturtle/fix-metadata-add-tests

Fix off by one error in metadata tests

Author: adamtheturtle

src/mock_vws/_validators.py

@@ -906,7 +906,8 @@ def validate_metadata_size(
         return wrapped(*args, **kwargs)
     decoded = base64.b64decode(application_metadata)
 
-    if len(decoded) <= 1024 * 1024:
+    max_metadata_bytes = 1024 * 1024 - 1
+    if len(decoded) <= max_metadata_bytes:
         return wrapped(*args, **kwargs)
 
     context.status_code = codes.UNPROCESSABLE_ENTITY

tests/mock_vws/test_add_target.py

@@ -645,11 +645,13 @@ class TestApplicationMetadata:
     Tests for the application metadata parameter.
     """
 
+    _MAX_METADATA_BYTES = 1024 * 1024 - 1
+
     @pytest.mark.parametrize(
         'metadata',
         [
             b'a',
-            b'a' * (1024 * 1024),
+            b'a' * _MAX_METADATA_BYTES,
         ],
         ids=['Short', 'Max length'],
     )
@@ -781,12 +783,12 @@ def test_metadata_too_large(
         png_rgb: io.BytesIO,
     ) -> None:
         """
-        A base64 encoded string of up to 1024 * 1024 bytes is valid application
-        metadata.
+        A base64 encoded string of greater than 1024 * 1024 bytes is too large
+        for application metadata.
         """
         image_data = png_rgb.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
-        metadata = b'a' * (1024 * 1024 + 1)
+        metadata = b'a' * (self._MAX_METADATA_BYTES + 1)
         metadata_encoded = base64.b64encode(metadata).decode('ascii')
 
         data = {

tests/mock_vws/test_update_target.py

@@ -347,15 +347,25 @@ class TestApplicationMetadata:
     Tests for the application metadata parameter.
     """
 
+    _MAX_METADATA_BYTES = 1024 * 1024 - 1
+
+    @pytest.mark.parametrize(
+        'metadata',
+        [
+            b'a',
+            b'a' * _MAX_METADATA_BYTES,
+        ],
+        ids=['Short', 'Max length'],
+    )
     def test_base64_encoded(
         self,
         vuforia_database_keys: VuforiaDatabaseKeys,
         target_id: str,
+        metadata: bytes,
     ) -> None:
         """
         A base64 encoded string is valid application metadata.
         """
-        metadata = b'Some data'
         metadata_encoded = base64.b64encode(metadata).decode('ascii')
 
         wait_for_target_processed(
@@ -432,6 +442,35 @@ def test_not_base64_encoded(
             result_code=ResultCodes.FAIL,
         )
 
+    def test_metadata_too_large(
+        self,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+        target_id: str,
+    ) -> None:
+        """
+        A base64 encoded string of greater than 1024 * 1024 bytes is too large
+        for application metadata.
+        """
+        metadata = b'a' * (self._MAX_METADATA_BYTES + 1)
+        metadata_encoded = base64.b64encode(metadata).decode('ascii')
+
+        wait_for_target_processed(
+            vuforia_database_keys=vuforia_database_keys,
+            target_id=target_id,
+        )
+
+        response = update_target(
+            vuforia_database_keys=vuforia_database_keys,
+            data={'application_metadata': metadata_encoded},
+            target_id=target_id,
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.UNPROCESSABLE_ENTITY,
+            result_code=ResultCodes.METADATA_TOO_LARGE,
+        )
+
 
 @pytest.mark.usefixtures('verify_mock_vuforia')
 class TestTargetName: