Merge pull request #440 from adamtheturtle/endpoint-access-key

Endpoint access key

Author: adamtheturtle

tests/mock_vws/fixtures/prepared_requests.py

@@ -38,9 +38,11 @@ def _add_target(
 
     content = bytes(json.dumps(data), encoding='utf-8')
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type=content_type,
@@ -69,6 +71,8 @@ def _add_target(
         successful_headers_status_code=codes.BAD_REQUEST,
         successful_headers_result_code=ResultCodes.FAIL,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )
 
 
@@ -89,9 +93,11 @@ def _delete_target(
     method = DELETE
     content = b''
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type='',
@@ -116,6 +122,8 @@ def _delete_target(
         successful_headers_status_code=codes.OK,
         successful_headers_result_code=ResultCodes.SUCCESS,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )
 
 
@@ -132,9 +140,11 @@ def _database_summary(
 
     content = b''
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type='',
@@ -160,6 +170,8 @@ def _database_summary(
         successful_headers_status_code=codes.OK,
         successful_headers_result_code=ResultCodes.SUCCESS,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )
 
 
@@ -182,9 +194,11 @@ def _get_duplicates(
 
     content = b''
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type='',
@@ -210,6 +224,8 @@ def _get_duplicates(
         successful_headers_status_code=codes.OK,
         successful_headers_result_code=ResultCodes.SUCCESS,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )
 
 
@@ -231,9 +247,11 @@ def _get_target(
 
     content = b''
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type='',
@@ -259,6 +277,8 @@ def _get_target(
         successful_headers_status_code=codes.OK,
         successful_headers_result_code=ResultCodes.SUCCESS,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )
 
 
@@ -275,9 +295,11 @@ def _target_list(
 
     content = b''
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type='',
@@ -303,6 +325,8 @@ def _target_list(
         successful_headers_status_code=codes.OK,
         successful_headers_result_code=ResultCodes.SUCCESS,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )
 
 
@@ -324,9 +348,11 @@ def _target_summary(
 
     content = b''
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type='',
@@ -352,6 +378,8 @@ def _target_summary(
         successful_headers_status_code=codes.OK,
         successful_headers_result_code=ResultCodes.SUCCESS,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )
 
 
@@ -375,9 +403,11 @@ def _update_target(
     date = rfc_1123_date()
     method = PUT
 
+    access_key = vuforia_database_keys.server_access_key
+    secret_key = vuforia_database_keys.server_secret_key
     authorization_string = authorization_header(
-        access_key=vuforia_database_keys.server_access_key,
-        secret_key=vuforia_database_keys.server_secret_key,
+        access_key=access_key,
+        secret_key=secret_key,
         method=method,
         content=content,
         content_type=content_type,
@@ -404,4 +434,6 @@ def _update_target(
         successful_headers_status_code=codes.OK,
         successful_headers_result_code=ResultCodes.SUCCESS,
         prepared_request=prepared_request,
+        access_key=access_key,
+        secret_key=secret_key,
     )

tests/mock_vws/test_date_header.py

@@ -13,7 +13,6 @@
 from mock_vws._constants import ResultCodes
 from tests.mock_vws.utils import (
     TargetAPIEndpoint,
-    VuforiaDatabaseKeys,
     assert_vws_failure,
     assert_vws_response,
     authorization_header,
@@ -29,7 +28,6 @@ class TestMissing:
 
     def test_no_date_header(
         self,
-        vuforia_database_keys: VuforiaDatabaseKeys,
         endpoint: TargetAPIEndpoint,
     ) -> None:
         """
@@ -40,8 +38,8 @@ def test_no_date_header(
         assert isinstance(content, bytes)
 
         authorization_string = authorization_header(
-            access_key=vuforia_database_keys.server_access_key,
-            secret_key=vuforia_database_keys.server_secret_key,
+            access_key=endpoint.access_key,
+            secret_key=endpoint.secret_key,
             method=str(endpoint.prepared_request.method),
             content=content,
             content_type=endpoint.auth_header_content_type,
@@ -79,7 +77,6 @@ class TestFormat:
 
     def test_incorrect_date_format(
         self,
-        vuforia_database_keys: VuforiaDatabaseKeys,
         endpoint: TargetAPIEndpoint,
     ) -> None:
         """
@@ -95,8 +92,8 @@ def test_incorrect_date_format(
         assert isinstance(content, bytes)
 
         authorization_string = authorization_header(
-            access_key=vuforia_database_keys.server_access_key,
-            secret_key=vuforia_database_keys.server_secret_key,
+            access_key=endpoint.access_key,
+            secret_key=endpoint.secret_key,
             method=str(endpoint.prepared_request.method),
             content=content,
             content_type=endpoint.auth_header_content_type,
@@ -139,7 +136,6 @@ class TestSkewedTime:
     )
     def test_date_out_of_range(
         self,
-        vuforia_database_keys: VuforiaDatabaseKeys,
         time_multiplier: int,
         endpoint: TargetAPIEndpoint,
     ) -> None:
@@ -160,8 +156,8 @@ def test_date_out_of_range(
         assert isinstance(content, bytes)
 
         authorization_string = authorization_header(
-            access_key=vuforia_database_keys.server_access_key,
-            secret_key=vuforia_database_keys.server_secret_key,
+            access_key=endpoint.access_key,
+            secret_key=endpoint.secret_key,
             method=str(endpoint.prepared_request.method),
             content=content,
             content_type=endpoint.auth_header_content_type,
@@ -196,7 +192,6 @@ def test_date_out_of_range(
     )
     def test_date_in_range(
         self,
-        vuforia_database_keys: VuforiaDatabaseKeys,
         time_multiplier: int,
         endpoint: TargetAPIEndpoint,
     ) -> None:
@@ -217,8 +212,8 @@ def test_date_in_range(
         assert isinstance(content, bytes)
 
         authorization_string = authorization_header(
-            access_key=vuforia_database_keys.server_access_key,
-            secret_key=vuforia_database_keys.server_secret_key,
+            access_key=endpoint.access_key,
+            secret_key=endpoint.secret_key,
             method=str(endpoint.prepared_request.method),
             content=content,
             content_type=endpoint.auth_header_content_type,

tests/mock_vws/test_unexpected_json.py

@@ -11,7 +11,6 @@
 from mock_vws._constants import ResultCodes
 from tests.mock_vws.utils import (
     TargetAPIEndpoint,
-    VuforiaDatabaseKeys,
     assert_vws_failure,
     authorization_header,
     rfc_1123_date,
@@ -26,7 +25,6 @@ class TestUnexpectedJSON:
 
     def test_does_not_take_data(
         self,
-        vuforia_database_keys: VuforiaDatabaseKeys,
         endpoint: TargetAPIEndpoint,
     ) -> None:
         """
@@ -42,8 +40,8 @@ def test_does_not_take_data(
         endpoint_headers = dict(endpoint.prepared_request.headers)
 
         authorization_string = authorization_header(
-            access_key=vuforia_database_keys.server_access_key,
-            secret_key=vuforia_database_keys.server_secret_key,
+            access_key=endpoint.access_key,
+            secret_key=endpoint.secret_key,
             method=str(endpoint.prepared_request.method),
             content=content,
             content_type=content_type,

tests/mock_vws/utils.py

@@ -79,6 +79,8 @@ def __init__(
         prepared_request: requests.PreparedRequest,
         successful_headers_result_code: ResultCodes,
         successful_headers_status_code: int,
+        access_key: bytes,
+        secret_key: bytes,
     ) -> None:
         """
         Args:
@@ -87,6 +89,8 @@ def __init__(
                 example path is requested with the method.
             successful_headers_status_code: The expected status code if the
                 example path is requested with the method.
+            access_key: The access key used in the prepared request.
+            secret_key: The secret key used in the prepared request.
 
         Attributes:
             prepared_request: A request to make which would be successful.
@@ -96,6 +100,8 @@ def __init__(
                 example path is requested with the method.
             auth_header_content_type: The content type to use for the
                 `Authorization` header.
+            access_key: The access key used in the prepared request.
+            secret_key: The secret key used in the prepared request.
         """
         self.prepared_request = prepared_request
         self.successful_headers_status_code = successful_headers_status_code
@@ -104,6 +110,8 @@ def __init__(
         content_type = headers.get('Content-Type', '')
         assert isinstance(content_type, str)
         self.auth_header_content_type: str = content_type
+        self.access_key = access_key
+        self.secret_key = secret_key
 
 
 def assert_vws_failure(