Merge pull request #645 from adamtheturtle/weird-target-name-384

Add tests for emoji in target names

Author: adamtheturtle

CONTRIBUTING.rst

@@ -178,6 +178,8 @@ A response to an invalid query may have an ``application/json`` content type but
 
 After deleting a target, for up to approximately 30 seconds, matching it with a query returns a 500 response.
 
+A target with the name ``\uffff`` gets stuck in processing.
+
 Performing a release
 --------------------
 

README.rst

@@ -193,6 +193,13 @@ The mock is strict.
 That is, it accepts only a few date formats, and rejects all others.
 If you find a date format which is accepted by the real Query API but rejected by the mock, please create a GitHub issue.
 
+Targets stuck in processing
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On the real Vuforia Web Services, targets sometimes get stuck in the processing state.
+For example, targets with the name ``\uffff`` get stuck in the processing state.
+On the mock, no targets get stuck in the processing state.
+
 .. |Build Status| image:: https://travis-ci.org/adamtheturtle/vws-python.svg?branch=master
    :target: https://travis-ci.org/adamtheturtle/vws-python
 .. |codecov| image:: https://codecov.io/gh/adamtheturtle/vws-python/branch/master/graph/badge.svg

src/mock_vws/_mock_web_services_api.py

@@ -41,6 +41,7 @@
     validate_metadata_encoding,
     validate_metadata_size,
     validate_metadata_type,
+    validate_name_characters_in_range,
     validate_name_length,
     validate_name_type,
     validate_not_invalid_json,
@@ -167,6 +168,7 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
                 validate_image_is_image,
                 validate_image_encoding,
                 validate_image_data_type,
+                validate_name_characters_in_range,
                 validate_name_length,
                 validate_name_type,
                 validate_width,

src/mock_vws/_validators.py

@@ -494,6 +494,48 @@ def validate_name_length(
     return json_dump(body)
 
 
+@wrapt.decorator
+def validate_name_characters_in_range(
+    wrapped: Callable[..., str],
+    instance: Any,  # pylint: disable=unused-argument
+    args: Tuple[_RequestObjectProxy, _Context],
+    kwargs: Dict,
+) -> str:
+    """
+    Validate the characters in the name argument given to a VWS endpoint.
+
+    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 ``INTERNAL_SERVER_ERROR`` response if the name is given includes
+        characters outside of the accepted range.
+    """
+    request, context = args
+
+    if not request.text:
+        return wrapped(*args, **kwargs)
+
+    if 'name' not in request.json():
+        return wrapped(*args, **kwargs)
+
+    name = request.json()['name']
+
+    if all(ord(character) <= 65535 for character in name):
+        return wrapped(*args, **kwargs)
+
+    context.status_code = codes.INTERNAL_SERVER_ERROR
+    body = {
+        'transaction_id': uuid.uuid4().hex,
+        'result_code': ResultCodes.FAIL.value,
+    }
+    return json_dump(body)
+
+
 @wrapt.decorator
 def validate_image_format(
     wrapped: Callable[..., str],

tests/mock_vws/test_add_target.py

@@ -203,13 +203,19 @@ class TestTargetName:
     Tests for the target name field.
     """
 
+    _MAX_CHAR_VALUE = 65535
+
     @pytest.mark.parametrize(
         'name',
         [
             'á',
+            # We test just below the max character value.
+            # This is because targets with the max character value in their
+            # names get stuck in the processing stage.
+            chr(_MAX_CHAR_VALUE - 2),
             'a' * 64,
         ],
-        ids=['Short name', 'Long name'],
+        ids=['Short name', 'Max char value', 'Long name'],
     )
     def test_name_valid(
         self,
@@ -250,6 +256,9 @@ def test_name_invalid(
     ) -> None:
         """
         A target's name must be a string of length 0 < N < 65.
+
+        We test characters out of range in another test as that gives a
+        different error.
         """
         image_data = png_rgb.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
@@ -271,6 +280,32 @@ def test_name_invalid(
             result_code=ResultCodes.FAIL,
         )
 
+    def test_character_out_of_range(
+        self,
+        png_rgb: io.BytesIO,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+    ) -> None:
+        name = chr(self._MAX_CHAR_VALUE + 1)
+        image_data = png_rgb.read()
+        image_data_encoded = base64.b64encode(image_data).decode('ascii')
+
+        data = {
+            'name': name,
+            'width': 1,
+            'image': image_data_encoded,
+        }
+
+        response = add_target_to_vws(
+            vuforia_database_keys=vuforia_database_keys,
+            data=data,
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.INTERNAL_SERVER_ERROR,
+            result_code=ResultCodes.FAIL,
+        )
+
     def test_existing_target_name(
         self,
         png_rgb: io.BytesIO,

tests/mock_vws/test_update_target.py

@@ -478,13 +478,19 @@ class TestTargetName:
     Tests for the target name field.
     """
 
+    _MAX_CHAR_VALUE = 65535
+
     @pytest.mark.parametrize(
         'name',
         [
-            'a',
+            'á',
+            # We test just below the max character value.
+            # This is because targets with the max character value in their
+            # names get stuck in the processing stage.
+            chr(_MAX_CHAR_VALUE - 2),
             'a' * 64,
         ],
-        ids=['Short name', 'Long name'],
+        ids=['Short name', 'Max char value', 'Long name'],
     )
     def test_name_valid(
         self,
@@ -493,7 +499,10 @@ def test_name_valid(
         target_id: str,
     ) -> None:
         """
-        Names between 1 and 64 characters in length are valid.
+        A target's name must be a string of length 0 < N < 65.
+
+        We test characters out of range in another test as that gives a
+        different error.
         """
         wait_for_target_processed(
             vuforia_database_keys=vuforia_database_keys,
@@ -550,6 +559,32 @@ def test_name_invalid(
             result_code=ResultCodes.FAIL,
         )
 
+    def test_character_out_of_range(
+        self,
+        png_rgb: io.BytesIO,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+    ) -> None:
+        name = chr(self._MAX_CHAR_VALUE + 1)
+        image_data = png_rgb.read()
+        image_data_encoded = base64.b64encode(image_data).decode('ascii')
+
+        data = {
+            'name': name,
+            'width': 1,
+            'image': image_data_encoded,
+        }
+
+        response = add_target_to_vws(
+            vuforia_database_keys=vuforia_database_keys,
+            data=data,
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.INTERNAL_SERVER_ERROR,
+            result_code=ResultCodes.FAIL,
+        )
+
     def test_existing_target_name(
         self,
         png_rgb_success: io.BytesIO,