Merge remote-tracking branch 'origin/master' into metadata-too-large

Author: adamtheturtle

README.rst

@@ -185,6 +185,14 @@ This timeframe is not consistent on the real Vuforia Web Services.
 On the mock, this timeframe is three seconds by default.
 ``MockVWS`` takes a parameter ``query_recognizes_deletion_seconds`` to change this.
 
+Accepted date formats for the Query API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Query API documentation is not clear on which date formats are expected exactly in the ``Date`` header.
+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.
+
 .. |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_query_api.py

@@ -277,15 +277,36 @@ def validate_include_target_data(
     return unexpected_target_data_message
 
 
+def _accepted_date_formats() -> Set[str]:
+    """
+    Return all known accepted date formats.
+
+    We expect that more formats than this will be accepted.
+    These are the accepted ones we know of at the time of writing.
+    """
+    known_accepted_formats = {
+        '%a, %b %d %H:%M:%S %Y',
+        '%a %b %d %H:%M:%S %Y',
+        '%a, %d %b %Y %H:%M:%S',
+        '%a %d %b %Y %H:%M:%S',
+    }
+
+    known_accepted_formats = known_accepted_formats.union(
+        set(date_format + ' GMT' for date_format in known_accepted_formats),
+    )
+
+    return known_accepted_formats
+
+
 @wrapt.decorator
-def validate_date(
+def validate_date_format(
     wrapped: Callable[..., str],
     instance: Any,  # pylint: disable=unused-argument
     args: Tuple[_RequestObjectProxy, _Context],
     kwargs: Dict,
 ) -> str:
     """
-    Validate the date header given to the query endpoint.
+    Validate the format of the date header given to the query endpoint.
 
     Args:
         wrapped: An endpoint function for `requests_mock`.
@@ -296,26 +317,60 @@ def validate_date(
     Returns:
         The result of calling the endpoint.
         An `UNAUTHORIZED` response if the date is in the wrong format.
+    """
+    request, context = args
+    date_header = request.headers['Date']
+
+    for date_format in _accepted_date_formats():
+        try:
+            datetime.datetime.strptime(date_header, date_format)
+        except ValueError:
+            pass
+        else:
+            return wrapped(*args, **kwargs)
+
+    context.status_code = codes.UNAUTHORIZED
+    context.headers['WWW-Authenticate'] = 'VWS'
+    text = 'Malformed date header.'
+    content_type = 'text/plain; charset=ISO-8859-1'
+    context.headers['Content-Type'] = content_type
+    return text
+
+
+@wrapt.decorator
+def validate_date(
+    wrapped: Callable[..., str],
+    instance: Any,  # pylint: disable=unused-argument
+    args: Tuple[_RequestObjectProxy, _Context],
+    kwargs: Dict,
+) -> str:
+    """
+    Validate date in the date header given to the query 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.
         A `FORBIDDEN` response if the date is out of range.
     """
     request, context = args
+    date_header = request.headers['Date']
 
-    try:
-        date_from_header = datetime.datetime.strptime(
-            request.headers['Date'],
-            '%a, %d %b %Y %H:%M:%S GMT',
-        )
-    except ValueError:
-        context.status_code = codes.UNAUTHORIZED
-        context.headers['WWW-Authenticate'] = 'VWS'
-        text = 'Malformed date header.'
-        content_type = 'text/plain; charset=ISO-8859-1'
-        context.headers['Content-Type'] = content_type
-        return text
+    for date_format in _accepted_date_formats():
+        try:
+            date = datetime.datetime.strptime(date_header, date_format)
+        except ValueError:
+            pass
+        else:
+            break
 
     gmt = pytz.timezone('GMT')
     now = datetime.datetime.now(tz=gmt)
-    date_from_header = date_from_header.replace(tzinfo=gmt)
+    date_from_header = date.replace(tzinfo=gmt)
     time_difference = now - date_from_header
 
     maximum_time_difference = datetime.timedelta(minutes=65)
@@ -527,6 +582,7 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
         decorators = [
             validate_authorization,
             validate_date,
+            validate_date_format,
             validate_date_header_given,
             validate_include_target_data,
             validate_max_num_results,

tests/mock_vws/test_query.py

@@ -6,12 +6,14 @@
 
 import base64
 import calendar
+import datetime
 import io
 import time
 from typing import Dict, Union
 from urllib.parse import urljoin
 
 import pytest
+import pytz
 import requests
 from PIL import Image
 from requests import codes
@@ -525,7 +527,7 @@ def test_default(
         assert len(response.json()['results']) == 1
 
     @pytest.mark.parametrize('num_results', [1, b'1', 50])
-    def test_valid_foo(
+    def test_valid_accepted(
         self,
         high_quality_image: io.BytesIO,
         vuforia_database_keys: VuforiaDatabaseKeys,
@@ -1600,3 +1602,84 @@ def test_status_failed(
 
         assert_query_success(response=response)
         assert response.json()['results'] == []
+
+
+@pytest.mark.usefixtures('verify_mock_vuforia')
+class TestDateFormats:
+    """
+    Tests for various date formats.
+
+    The date format for the VWS API as per
+    https://library.vuforia.com/articles/Training/Using-the-VWS-API.html must
+    be in the rfc1123-date format.
+
+    However, for the query endpoint, the documentation does not mention the
+    format. It says:
+
+    > The data format must exactly match the Date that is sent in the ‘Date’
+    > header.
+    """
+
+    @pytest.mark.parametrize(
+        'datetime_format',
+        [
+            '%a, %b %d %H:%M:%S %Y',
+            '%a %b %d %H:%M:%S %Y',
+            '%a, %d %b %Y %H:%M:%S',
+            '%a %d %b %Y %H:%M:%S',
+        ],
+    )
+    @pytest.mark.parametrize('include_tz', [True, False])
+    def test_date_formats(
+        self,
+        high_quality_image: io.BytesIO,
+        vuforia_database_keys: VuforiaDatabaseKeys,
+        datetime_format: str,
+        include_tz: bool,
+    ) -> None:
+        """
+        Test various date formats which are known to be accepted.
+
+        We expect that more formats than this will be accepted.
+        These are the accepted ones we know of at the time of writing.
+        """
+        image_content = high_quality_image.getvalue()
+        body = {'image': ('image.jpeg', image_content, 'image/jpeg')}
+
+        if include_tz:
+            datetime_format += ' GMT'
+
+        gmt = pytz.timezone('GMT')
+        now = datetime.datetime.now(tz=gmt)
+        date = now.strftime(datetime_format)
+        request_path = '/v1/query'
+        content, content_type_header = encode_multipart_formdata(body)
+        method = POST
+
+        access_key = vuforia_database_keys.client_access_key
+        secret_key = vuforia_database_keys.client_secret_key
+        authorization_string = authorization_header(
+            access_key=access_key,
+            secret_key=secret_key,
+            method=method,
+            content=content,
+            content_type='multipart/form-data',
+            date=date,
+            request_path=request_path,
+        )
+
+        headers = {
+            'Authorization': authorization_string,
+            'Date': date,
+            'Content-Type': content_type_header,
+        }
+
+        response = requests.request(
+            method=method,
+            url=urljoin(base=VWQ_HOST, url=request_path),
+            headers=headers,
+            data=content,
+        )
+
+        assert_query_success(response=response)
+        assert response.json()['results'] == []