Merge pull request #1119 from adamtheturtle/no-base64

Do not encode application metadata as base64 - require user to do that

Author: adamtheturtle

src/vws/vws.py

@@ -142,7 +142,7 @@ def add_target(
         width: Union[int, float],
         image: io.BytesIO,
         active_flag: bool,
-        application_metadata: Optional[bytes],
+        application_metadata: Optional[str],
     ) -> str:
         """
         Add a target to a Vuforia Web Services database.
@@ -157,7 +157,9 @@ def add_target(
             image: The image of the target.
             active_flag: Whether or not the target is active for query.
             application_metadata: The application metadata of the target.
-                This will be base64 encoded.
+                This must be base64 encoded, for example by using::
+
+                    base64.b64encode('input_string').decode('ascii')
 
         Returns:
             The target ID of the new target.
@@ -185,18 +187,13 @@ def add_target(
         """
         image_data = image.getvalue()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
-        if application_metadata is None:
-            metadata_encoded = None
-        else:
-            metadata_encoded_str = base64.b64encode(application_metadata)
-            metadata_encoded = metadata_encoded_str.decode('ascii')
 
         data = {
             'name': name,
             'width': width,
             'image': image_data_encoded,
             'active_flag': active_flag,
-            'application_metadata': metadata_encoded,
+            'application_metadata': application_metadata,
         }
 
         content = bytes(json.dumps(data), encoding='utf-8')
@@ -478,7 +475,7 @@ def update_target(
         width: Optional[Union[int, float]] = None,
         image: Optional[io.BytesIO] = None,
         active_flag: Optional[bool] = None,
-        application_metadata: Optional[bytes] = None,
+        application_metadata: Optional[str] = None,
     ) -> None:
         """
         Add a target to a Vuforia Web Services database.
@@ -494,8 +491,11 @@ def update_target(
             image: The image of the target.
             active_flag: Whether or not the target is active for query.
             application_metadata: The application metadata of the target.
-                This will be base64 encoded. Giving ``None`` will not change
-                the application metadata.
+                This must be base64 encoded, for example by using::
+
+                    base64.b64encode('input_string').decode('ascii')
+
+                Giving ``None`` will not change the application metadata.
 
         Raises:
             ~vws.exceptions.AuthenticationFailure: The secret key is not
@@ -531,9 +531,7 @@ def update_target(
             data['active_flag'] = active_flag
 
         if application_metadata is not None:
-            metadata_encoded_str = base64.b64encode(application_metadata)
-            metadata_encoded = metadata_encoded_str.decode('ascii')
-            data['application_metadata'] = metadata_encoded
+            data['application_metadata'] = application_metadata
 
         content = bytes(json.dumps(data), encoding='utf-8')
 

tests/test_exceptions.py

@@ -225,7 +225,7 @@ def test_metadata_too_large(
             width=1,
             image=high_quality_image,
             active_flag=True,
-            application_metadata=b'a' * 1024 * 1024,
+            application_metadata='a' * 1024 * 1024 * 10,
         )
 
     assert exc.value.response.status_code == codes.UNPROCESSABLE_ENTITY

tests/test_vws.py

@@ -2,14 +2,15 @@
 Tests for helper functions for managing a Vuforia database.
 """
 
+import base64
 import io
 from typing import Optional
 
 import pytest
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 
-from vws import VWS
+from vws import VWS, CloudRecoService
 from vws.exceptions import TargetProcessingTimeout
 
 
@@ -26,23 +27,40 @@ def test_add_target(
         high_quality_image: io.BytesIO,
         active_flag: bool,
         application_metadata: Optional[bytes],
+        cloud_reco_client: CloudRecoService,
     ) -> None:
         """
         No exception is raised when adding one target.
         """
         name = 'x'
         width = 1
+        if application_metadata is None:
+            encoded_metadata = None
+        else:
+            encoded_metadata_bytes = base64.b64encode(application_metadata)
+            encoded_metadata = encoded_metadata_bytes.decode('utf-8')
+
         target_id = vws_client.add_target(
             name=name,
             width=width,
             image=high_quality_image,
-            application_metadata=application_metadata,
+            application_metadata=encoded_metadata,
             active_flag=active_flag,
         )
         target_record = vws_client.get_target_record(target_id=target_id)
         assert target_record['name'] == name
         assert target_record['width'] == width
         assert target_record['active_flag'] is active_flag
+        vws_client.wait_for_target_processed(target_id=target_id)
+        matching_targets = cloud_reco_client.query(image=high_quality_image)
+        if active_flag:
+            [matching_target] = matching_targets
+            assert matching_target['target_id'] == target_id
+            query_target_data = matching_target['target_data']
+            query_metadata = query_target_data['application_metadata']
+            assert query_metadata == encoded_metadata
+        else:
+            assert matching_targets == []
 
     def test_add_two_targets(
         self,
@@ -475,7 +493,7 @@ def test_update_target(
             width=2,
             active_flag=False,
             image=image_file_failed_state,
-            application_metadata=b'a',
+            application_metadata=base64.b64encode(b'a').decode('ascii'),
         )
 
         vws_client.wait_for_target_processed(target_id=target_id)