Merge pull request #664 from adamtheturtle/inactive-more

Full tests for inactive project

Author: adamtheturtle

src/mock_vws/_constants.py

@@ -50,6 +50,7 @@ class ResultCodes(Enum):
     REQUEST_QUOTA_REACHED = 'RequestQuotaReached'
     TARGET_STATUS_NOT_SUCCESS = 'TargetStatusNotSuccess'
     PROJECT_INACTIVE = 'ProjectInactive'
+    INACTIVE_PROJECT = 'InactiveProject'
 
 
 class TargetStatuses(Enum):

src/mock_vws/_mock_web_query_api.py

@@ -20,7 +20,7 @@
 from requests_mock.request import _RequestObjectProxy
 from requests_mock.response import _Context
 
-from mock_vws._constants import ResultCodes, TargetStatuses
+from mock_vws._constants import ResultCodes, States, TargetStatuses
 from mock_vws._mock_common import Route, json_dump, set_content_length_header
 from mock_vws._mock_web_services_api import MockVuforiaWebServicesAPI, Target
 
@@ -29,6 +29,46 @@
 ROUTES = set([])
 
 
+@wrapt.decorator
+def validate_project_state(
+    wrapped: Callable[..., str],
+    instance: Any,
+    args: Tuple[_RequestObjectProxy, _Context],
+    kwargs: Dict,
+) -> str:
+    """
+    Validate the state of the project.
+
+    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 with an InactiveProject result code if the
+        project is inactive.
+    """
+    _, context = args
+
+    if instance.mock_web_services_api.state != States.PROJECT_INACTIVE:
+        return wrapped(*args, **kwargs)
+
+    context.status_code = codes.FORBIDDEN
+    transaction_id = uuid.uuid4().hex
+    result_code = ResultCodes.INACTIVE_PROJECT.value
+
+    # The response has an unusual format of separators, so we construct it
+    # manually.
+    return (
+        '{"transaction_id": '
+        f'"{transaction_id}",'
+        f'"result_code":"{result_code}"'
+        '}'
+    )
+
+
 @wrapt.decorator
 def validate_image_format(
     wrapped: Callable[..., str],
@@ -593,6 +633,7 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
             validate_content_type_header,
             validate_accept_header,
             validate_auth_header_exists,
+            validate_project_state,
             set_content_length_header,
         ]
 

src/mock_vws/_mock_web_services_api.py

@@ -45,6 +45,7 @@
     validate_name_length,
     validate_name_type,
     validate_not_invalid_json,
+    validate_project_state,
     validate_width,
 )
 
@@ -179,6 +180,7 @@ def decorator(method: Callable[..., str]) -> Callable[..., str]:
             decorators = [
                 parse_target_id,
                 validate_authorization,
+                validate_project_state,
                 validate_metadata_size,
                 validate_metadata_encoding,
                 validate_metadata_type,

src/mock_vws/_validators.py

@@ -24,6 +24,8 @@
 from mock_vws._constants import ResultCodes
 from mock_vws._mock_common import json_dump
 
+from ._constants import States
+
 
 def compute_hmac_base64(key: bytes, data: bytes) -> bytes:
     """
@@ -126,6 +128,44 @@ def validate_active_flag(
     return json_dump(body)
 
 
+@wrapt.decorator
+def validate_project_state(
+    wrapped: Callable[..., str],
+    instance: Any,
+    args: Tuple[_RequestObjectProxy, _Context],
+    kwargs: Dict,
+) -> str:
+    """
+    Validate the state of the project.
+
+    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 with a PROJECT_INACTIVE result code if the
+        project is inactive.
+    """
+    request, context = args
+
+    if instance.state != States.PROJECT_INACTIVE:
+        return wrapped(*args, **kwargs)
+
+    if request.method == 'GET' and 'duplicates' not in request.path:
+        return wrapped(*args, **kwargs)
+
+    context.status_code = codes.FORBIDDEN
+
+    body: Dict[str, str] = {
+        'transaction_id': uuid.uuid4().hex,
+        'result_code': ResultCodes.PROJECT_INACTIVE.value,
+    }
+    return json_dump(body)
+
+
 @wrapt.decorator
 def validate_not_invalid_json(
     wrapped: Callable[..., str],

tests/mock_vws/fixtures/credentials.py

@@ -34,7 +34,7 @@ def inactive_database_keys() -> VuforiaDatabaseKeys:
         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'],
+        client_access_key=os.environ['INACTIVE_VUFORIA_CLIENT_ACCESS_KEY'],
+        client_secret_key=os.environ['INACTIVE_VUFORIA_CLIENT_SECRET_KEY'],
     )
     return credentials

tests/mock_vws/test_add_target.py

@@ -834,3 +834,39 @@ def test_metadata_too_large(
             status_code=codes.UNPROCESSABLE_ENTITY,
             result_code=ResultCodes.METADATA_TOO_LARGE,
         )
+
+
+@pytest.mark.usefixtures('verify_mock_vuforia_inactive')
+class TestInactiveProject:
+    """
+    Tests for inactive projects.
+    """
+
+    def test_inactive_project(
+        self,
+        inactive_database_keys: VuforiaDatabaseKeys,
+        png_rgb: io.BytesIO,
+    ) -> None:
+        """
+        If the project is inactive, a FORBIDDEN response is returned.
+        """
+        image_data = png_rgb.read()
+        image_data_encoded = base64.b64encode(image_data).decode('ascii')
+
+        data = {
+            'name': 'example',
+            'width': 1,
+            'image': image_data_encoded,
+        }
+
+        response = add_target_to_vws(
+            vuforia_database_keys=inactive_database_keys,
+            data=data,
+            content_type='application/json',
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.FORBIDDEN,
+            result_code=ResultCodes.PROJECT_INACTIVE,
+        )

tests/mock_vws/test_delete_target.py

@@ -83,3 +83,29 @@ def test_processed(
             status_code=codes.NOT_FOUND,
             result_code=ResultCodes.UNKNOWN_TARGET,
         )
+
+
+@pytest.mark.usefixtures('verify_mock_vuforia_inactive')
+class TestInactiveProject:
+    """
+    Tests for inactive projects.
+    """
+
+    def test_inactive_project(
+        self,
+        inactive_database_keys: VuforiaDatabaseKeys,
+    ) -> None:
+        """
+        If the project is inactive, a FORBIDDEN response is returned.
+        """
+        target_id = 'does_not_exist'
+        response = delete_target(
+            vuforia_database_keys=inactive_database_keys,
+            target_id=target_id,
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.FORBIDDEN,
+            result_code=ResultCodes.PROJECT_INACTIVE,
+        )

tests/mock_vws/test_get_duplicates.py

@@ -17,7 +17,10 @@
     target_api_request,
     wait_for_target_processed,
 )
-from tests.mock_vws.utils.assertions import assert_vws_response
+from tests.mock_vws.utils.assertions import (
+    assert_vws_failure,
+    assert_vws_response,
+)
 from tests.mock_vws.utils.authorization import VuforiaDatabaseKeys
 
 
@@ -379,3 +382,28 @@ def test_processing(
 
         assert status_response.json()['status'] == 'processing'
         assert response.json()['similar_targets'] == [processed_target_id]
+
+
+@pytest.mark.usefixtures('verify_mock_vuforia_inactive')
+class TestInactiveProject:
+    """
+    Tests for inactive projects.
+    """
+
+    def test_inactive_project(
+        self,
+        inactive_database_keys: VuforiaDatabaseKeys,
+    ) -> None:
+        """
+        If the project is inactive, a FORBIDDEN response is returned.
+        """
+        response = target_duplicates(
+            target_id=uuid.uuid4().hex,
+            vuforia_database_keys=inactive_database_keys,
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.FORBIDDEN,
+            result_code=ResultCodes.PROJECT_INACTIVE,
+        )

tests/mock_vws/test_get_target.py

@@ -6,6 +6,7 @@
 
 import base64
 import io
+import uuid
 
 import pytest
 from requests import codes
@@ -16,7 +17,10 @@
     get_vws_target,
     wait_for_target_processed,
 )
-from tests.mock_vws.utils.assertions import assert_vws_response
+from tests.mock_vws.utils.assertions import (
+    assert_vws_failure,
+    assert_vws_response,
+)
 from tests.mock_vws.utils.authorization import VuforiaDatabaseKeys
 
 
@@ -249,3 +253,28 @@ def test_success_status(
         new_target_record = response.json()['target_record']
         new_tracking_rating = new_target_record['tracking_rating']
         assert new_tracking_rating == tracking_rating
+
+
+@pytest.mark.usefixtures('verify_mock_vuforia_inactive')
+class TestInactiveProject:
+    """
+    Tests for inactive projects.
+    """
+
+    def test_inactive_project(
+        self,
+        inactive_database_keys: VuforiaDatabaseKeys,
+    ) -> None:
+        """
+        The project's active state does not affect getting a target.
+        """
+        response = get_vws_target(
+            target_id=uuid.uuid4().hex,
+            vuforia_database_keys=inactive_database_keys,
+        )
+
+        assert_vws_failure(
+            response=response,
+            status_code=codes.NOT_FOUND,
+            result_code=ResultCodes.UNKNOWN_TARGET,
+        )

tests/mock_vws/test_query.py

@@ -1641,3 +1641,46 @@ def test_date_formats(
 
         assert_query_success(response=response)
         assert response.json()['results'] == []
+
+
+@pytest.mark.usefixtures('verify_mock_vuforia_inactive')
+class TestInactiveProject:
+    """
+    Tests for inactive projects.
+    """
+
+    def test_inactive_project(
+        self,
+        inactive_database_keys: VuforiaDatabaseKeys,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        If the project is inactive, a FORBIDDEN response is returned.
+        """
+        image_content = high_quality_image.getvalue()
+        body = {'image': ('image.jpeg', image_content, 'image/jpeg')}
+
+        response = query(
+            vuforia_database_keys=inactive_database_keys,
+            body=body,
+        )
+
+        assert_vwq_failure(
+            response=response,
+            status_code=codes.FORBIDDEN,
+            content_type='application/json',
+        )
+        assert response.json().keys() == {'transaction_id', 'result_code'}
+        assert_valid_transaction_id(response=response)
+        assert_valid_date_header(response=response)
+        result_code = response.json()['result_code']
+        transaction_id = response.json()['transaction_id']
+        assert result_code == ResultCodes.INACTIVE_PROJECT.value
+        # The separators are inconsistent and we test this.
+        expected_text = (
+            '{"transaction_id": '
+            f'"{transaction_id}",'
+            f'"result_code":"{result_code}"'
+            '}'
+        )
+        assert response.text == expected_text