Merge remote-tracking branch 'origin/master' into fewer-preps

Author: adamtheturtle

ci/run_script.py

@@ -22,7 +22,7 @@ def run_test(test_filename: str) -> None:
             str(path),
             '--cov=src',
             '--cov=tests',
-        ]
+        ],
     )
     sys.exit(result)
 

dev-requirements.txt

@@ -1,21 +1,22 @@
 autoflake==1.1
 check-manifest==0.36
-codecov==2.0.13 # Upload coverage data
+codecov==2.0.15 # Upload coverage data
 dodgy==0.1.9  # Look for uploaded secrets
 flake8==3.5.0  # Lint
-flake8-quotes==0.13.0  # Require single quotes
-freezegun==0.3.9  # Freeze time in tests
-hypothesis==3.44.16  # Generate test cases
-isort==4.2.15  # Lint imports
-mypy==0.560  # Type checking
+flake8-commas==2.0.0  # Require silicon valley commas
+flake8-quotes==0.14.0  # Require single quotes
+freezegun==0.3.10  # Freeze time in tests
+hypothesis==3.50.2  # Generate test cases
+isort==4.3.4  # Lint imports
+mypy==0.570  # Type checking
 pip_check_reqs==2.0.1
 pydocstyle==2.1.1  # Lint docstrings
 pyenchant==2.0.0  # Bindings for a spellchecking sytem
-pylint==1.8.1  # Lint
+pylint==1.8.3  # Lint
 pyroma==2.3  # Packaging best practices checker
 pytest-cov==2.5.1  # Measure code coverage
 pytest-envfiles==0.1.0  # Use files for environment variables for tests
-pytest==3.3.2  # Test runners
+pytest==3.4.2  # Test runners
 timeout-decorator==0.4.0  # Decorate functions to time out.
 vulture==0.26
-yapf==0.20.1  # Automatic formatting for Python
+yapf==0.21.0  # Automatic formatting for Python

pylintrc

@@ -55,7 +55,9 @@ confidence=
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time (only on the command line, not in the configuration file where
 # it should appear only once). See also the "--disable" option for examples.
-enable=spelling
+enable=
+    spelling,
+    useless-suppression,
 
 # Disable the message, report, category or checker with the given id(s). You
 # can either give multiple identifiers separated by comma (,) or put this

src/mock_vws/_mock_web_query_api.py

@@ -48,7 +48,7 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
                 route_name=method.__name__,
                 path_pattern=path_pattern,
                 http_methods=http_methods,
-            )
+            ),
         )
 
         return method

src/mock_vws/_mock_web_services_api.py

@@ -97,7 +97,7 @@ def set_content_length_header(
     wrapped: Callable[..., str],
     instance: 'MockVuforiaWebServicesAPI',  # pylint: disable=unused-argument
     args: Tuple[_RequestObjectProxy, _Context],
-    kwargs: Dict
+    kwargs: Dict,
 ) -> str:
     """
     Set the `Content-Length` header.
@@ -155,7 +155,7 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
                 route_name=method.__name__,
                 path_pattern=path_pattern,
                 http_methods=http_methods,
-            )
+            ),
         )
 
         key_validator = validate_keys(
@@ -287,7 +287,7 @@ def status(self) -> str:
         target is for detection.
         """
         processing_time = datetime.timedelta(
-            seconds=self._processing_time_seconds
+            seconds=self._processing_time_seconds,
         )
 
         time_since_change = datetime.datetime.now() - self.last_modified_date
@@ -312,7 +312,7 @@ def tracking_rating(self) -> int:
         pre_rating_time = datetime.timedelta(
             # That this is half of the total processing time is unrealistic.
             # In VWS it is not a constant percentage.
-            seconds=self._processing_time_seconds / 2
+            seconds=self._processing_time_seconds / 2,
         )
 
         time_since_upload = datetime.datetime.now() - self.upload_date
@@ -474,29 +474,29 @@ def database_summary(
                 target for target in self.targets
                 if target.status == TargetStatuses.SUCCESS.value
                 and target.active_flag
-            ]
+            ],
         )
 
         failed_images = len(
             [
                 target for target in self.targets
                 if target.status == TargetStatuses.FAILED.value
-            ]
+            ],
         )
 
         inactive_images = len(
             [
                 target for target in self.targets
                 if target.status == TargetStatuses.SUCCESS.value
                 and not target.active_flag
-            ]
+            ],
         )
 
         processing_images = len(
             [
                 target for target in self.targets
                 if target.status == TargetStatuses.PROCESSING.value
-            ]
+            ],
         )
 
         body = {
@@ -573,7 +573,7 @@ def get_duplicates(
         self,
         request: _RequestObjectProxy,  # pylint: disable=unused-argument
         context: _Context,  # pylint: disable=unused-argument
-        target: Target,  # pylint: disable=unused-argument
+        target: Target,
     ) -> str:
         """
         Get targets which may be considered duplicates of a given target.

src/mock_vws/_validators.py

@@ -41,7 +41,7 @@ def authorization_header(  # pylint: disable=too-many-arguments
     content: bytes,
     content_type: str,
     date: str,
-    request_path: str
+    request_path: str,
 ) -> bytes:
     """
     Return an `Authorization` header which can be used for a request made to

tests/mock_vws/conftest.py

@@ -23,6 +23,7 @@
 pytest_plugins = [  # pylint: disable=invalid-name
     'tests.mock_vws.fixtures.prepared_requests',
     'tests.mock_vws.fixtures.images',
+    'tests.mock_vws.fixtures.credentials',
 ]
 
 
@@ -55,8 +56,8 @@ def _delete_all_targets(database_keys: VuforiaDatabaseKeys) -> None:
 
 @pytest.fixture()
 def target_id(
-    png_rgb_success: io.BytesIO,  # pylint: disable=redefined-outer-name
-    vuforia_database_keys: VuforiaDatabaseKeys,  # noqa: E501 pylint: disable=redefined-outer-name
+    png_rgb_success: io.BytesIO,
+    vuforia_database_keys: VuforiaDatabaseKeys,
 ) -> str:
     """
     Return the target ID of a target in the database.
@@ -84,7 +85,7 @@ def target_id(
 @pytest.fixture(params=[True, False], ids=['Real Vuforia', 'Mock Vuforia'])
 def verify_mock_vuforia(
     request: SubRequest,
-    vuforia_database_keys: VuforiaDatabaseKeys,  # noqa: E501 pylint: disable=redefined-outer-name
+    vuforia_database_keys: VuforiaDatabaseKeys,
 ) -> Generator:
     """
     Test functions which use this fixture are run twice. Once with the real
@@ -121,7 +122,7 @@ def verify_mock_vuforia(
 @pytest.fixture(params=[True, False], ids=['Real Vuforia', 'Mock Vuforia'])
 def verify_mock_vuforia_inactive(
     request: SubRequest,
-    inactive_database_keys: VuforiaDatabaseKeys,  # noqa: E501 pylint: disable=redefined-outer-name
+    inactive_database_keys: VuforiaDatabaseKeys,
 ) -> Generator:
     """
     Test functions which use this fixture are run twice. Once with the real
@@ -167,44 +168,13 @@ def verify_mock_vuforia_inactive(
         '_target_list',
         '_target_summary',
         '_update_target',
-    ]
+    ],
 )
 def endpoint(request: SubRequest) -> TargetAPIEndpoint:
     """
     Return details of an endpoint.
     """
     endpoint_fixture: TargetAPIEndpoint = request.getfixturevalue(
-        request.param
+        request.param,
     )
     return endpoint_fixture
-
-
-@pytest.fixture()
-def vuforia_database_keys() -> VuforiaDatabaseKeys:
-    """
-    Return VWS credentials from environment variables.
-    """
-    credentials: VuforiaDatabaseKeys = VuforiaDatabaseKeys(
-        database_name=os.environ['VUFORIA_TARGET_MANAGER_DATABASE_NAME'],
-        server_access_key=os.environ['VUFORIA_SERVER_ACCESS_KEY'],
-        server_secret_key=os.environ['VUFORIA_SERVER_SECRET_KEY'],
-        client_access_key=os.environ['VUFORIA_CLIENT_ACCESS_KEY'],
-        client_secret_key=os.environ['VUFORIA_CLIENT_SECRET_KEY'],
-    )
-    return credentials
-
-
-@pytest.fixture()
-def inactive_database_keys() -> VuforiaDatabaseKeys:
-    """
-    Return VWS credentials for an inactive project from environment variables.
-    """
-    credentials: VuforiaDatabaseKeys = VuforiaDatabaseKeys(
-        database_name=os.
-        environ['INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME'],
-        server_access_key=os.environ['INACTIVE_VUFORIA_SERVER_ACCESS_KEY'],
-        server_secret_key=os.environ['INACTIVE_VUFORIA_SERVER_SECRET_KEY'],
-        client_access_key=os.environ['INACTIVE_VUFORIA_SERVER_ACCESS_KEY'],
-        client_secret_key=os.environ['INACTIVE_VUFORIA_SERVER_SECRET_KEY'],
-    )
-    return credentials

tests/mock_vws/fixtures/credentials.py

@@ -0,0 +1,40 @@
+"""
+Fixtures for credentials for Vuforia databases.
+"""
+
+import os
+
+import pytest
+
+from tests.mock_vws.utils import VuforiaDatabaseKeys
+
+
+@pytest.fixture()
+def vuforia_database_keys() -> VuforiaDatabaseKeys:
+    """
+    Return VWS credentials from environment variables.
+    """
+    credentials: VuforiaDatabaseKeys = VuforiaDatabaseKeys(
+        database_name=os.environ['VUFORIA_TARGET_MANAGER_DATABASE_NAME'],
+        server_access_key=os.environ['VUFORIA_SERVER_ACCESS_KEY'],
+        server_secret_key=os.environ['VUFORIA_SERVER_SECRET_KEY'],
+        client_access_key=os.environ['VUFORIA_CLIENT_ACCESS_KEY'],
+        client_secret_key=os.environ['VUFORIA_CLIENT_SECRET_KEY'],
+    )
+    return credentials
+
+
+@pytest.fixture()
+def inactive_database_keys() -> VuforiaDatabaseKeys:
+    """
+    Return VWS credentials for an inactive project from environment variables.
+    """
+    credentials: VuforiaDatabaseKeys = VuforiaDatabaseKeys(
+        database_name=os.
+        environ['INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME'],
+        server_access_key=os.environ['INACTIVE_VUFORIA_SERVER_ACCESS_KEY'],
+        server_secret_key=os.environ['INACTIVE_VUFORIA_SERVER_SECRET_KEY'],
+        client_access_key=os.environ['INACTIVE_VUFORIA_SERVER_ACCESS_KEY'],
+        client_secret_key=os.environ['INACTIVE_VUFORIA_SERVER_SECRET_KEY'],
+    )
+    return credentials

tests/mock_vws/fixtures/prepared_requests.py

@@ -2,6 +2,8 @@
 Fixtures which prepare requests.
 """
 
+import base64
+import io
 import json
 from typing import Any, Dict
 from urllib.parse import urljoin
@@ -26,12 +28,19 @@
 @pytest.fixture()
 def _add_target(
     vuforia_database_keys: VuforiaDatabaseKeys,
+    png_rgb: io.BytesIO,
 ) -> TargetAPIEndpoint:
     """
     Return details of the endpoint for adding a target.
     """
+    image_data = png_rgb.read()
+    image_data_encoded = base64.b64encode(image_data).decode('ascii')
     date = rfc_1123_date()
-    data: Dict[str, Any] = {}
+    data: Dict[str, Any] = {
+        'name': 'example_name',
+        'width': 1,
+        'image': image_data_encoded,
+    }
     request_path = '/targets'
     content_type = 'application/json'
     method = POST
@@ -66,10 +75,8 @@ def _add_target(
     prepared_request = request.prepare()  # type: ignore
 
     return TargetAPIEndpoint(
-        # We expect a bad request error because we have not given the required
-        # JSON body elements.
-        successful_headers_status_code=codes.BAD_REQUEST,
-        successful_headers_result_code=ResultCodes.FAIL,
+        successful_headers_status_code=codes.CREATED,
+        successful_headers_result_code=ResultCodes.TARGET_CREATED,
         prepared_request=prepared_request,
         access_key=access_key,
         secret_key=secret_key,
@@ -397,7 +404,7 @@ def _update_target(
     )
     data: Dict[str, Any] = {}
     request_path = f'/targets/{target_id}'
-    content = bytes(str(data), encoding='utf-8')
+    content = bytes(json.dumps(data), encoding='utf-8')
     content_type = 'application/json'
 
     date = rfc_1123_date()

tests/mock_vws/test_add_target.py

@@ -60,7 +60,7 @@ class TestContentTypes:
             'Documented Content-Type',
             'Undocumented Content-Type',
             'Empty',
-        ]
+        ],
     )
     def test_content_types(
         self,
@@ -203,7 +203,8 @@ class TestTargetName:
         'name', [
             'a',
             'a' * 64,
-        ], ids=['Short name', 'Long name']
+        ],
+        ids=['Short name', 'Long name'],
     )
     def test_name_valid(
         self,