Merge pull request #800 from adamtheturtle/active-flag

Add tests for active flag

Author: adamtheturtle

src/vws/vws.py

@@ -100,6 +100,7 @@ def add_target(
         name: str,
         width: Union[int, float],
         image: io.BytesIO,
+        active_flag: bool = True,
     ) -> str:
         """
         Add a target to a Vuforia Web Services database.
@@ -108,19 +109,19 @@ def add_target(
             name: The name of the target.
             width: The width of the target.
             image: The image of the target.
+            active_flag: Whether or not the target is active for query.
 
         Returns:
             The target ID of the new target.
         """
         image_data = image.getvalue()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
-        metadata_encoded = None
 
         data = {
             'name': name,
             'width': width,
             'image': image_data_encoded,
-            'application_metadata': metadata_encoded,
+            'active_flag': active_flag,
         }
 
         content = bytes(json.dumps(data), encoding='utf-8')

tests/test_add_target.py

@@ -4,6 +4,7 @@
 
 import io
 
+import pytest
 from mock_vws import MockVWS
 
 from vws import VWS
@@ -70,3 +71,47 @@ def test_custom_base_url(self, high_quality_image: io.BytesIO) -> None:
                 width=1,
                 image=high_quality_image,
             )
+
+
+class TestActiveFlag:
+    """
+    Tests for the ``active_flag`` parameter to ``add_target``.
+    """
+
+    def test_default(
+        self,
+        client: VWS,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        By default, the active flag is set to ``True``.
+        """
+        target_id = client.add_target(
+            name='x',
+            width=1,
+            image=high_quality_image,
+        )
+        get_result = client.get_target(target_id=target_id)
+        target_record = get_result['target_record']
+        assert target_record['active_flag'] is True
+
+    @pytest.mark.parametrize('active_flag', [True, False])
+    def test_given(
+        self,
+        client: VWS,
+        high_quality_image: io.BytesIO,
+        active_flag: bool,
+    ) -> None:
+        """
+        It is possible to set the active flag to a boolean value.
+        """
+        target_id = client.add_target(
+            name='x',
+            width=1,
+            image=high_quality_image,
+            active_flag=active_flag,
+        )
+
+        get_result = client.get_target(target_id=target_id)
+        target_record = get_result['target_record']
+        assert target_record['active_flag'] is active_flag