From 5b5b6ba434ca40ea57f385fecf421cad464e730f Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Thu, 29 Oct 2026 09:11:27 +0000 Subject: [PATCH 1/2] Separate Flask backend setup from test selection --- .../vws_mock_test_backends/flask_backend.py | 255 ++++++++++++++++ .../vws_mock_test_backends/mock_databases.py | 32 ++ .../vuforia_backends.py | 279 +----------------- 3 files changed, 301 insertions(+), 265 deletions(-) create mode 100644 test-backends/src/vws_mock_test_backends/flask_backend.py create mode 100644 test-backends/src/vws_mock_test_backends/mock_databases.py diff --git a/test-backends/src/vws_mock_test_backends/flask_backend.py b/test-backends/src/vws_mock_test_backends/flask_backend.py new file mode 100644 index 000000000..7354556d7 --- /dev/null +++ b/test-backends/src/vws_mock_test_backends/flask_backend.py @@ -0,0 +1,255 @@ +"""Flask transport setup and controls for the contract-test adapter.""" + +import gzip +import os +from collections.abc import Generator +from http import HTTPMethod + +import pytest +import requests +import responses +from beartype import beartype +from requests_mock_flask import add_flask_app_to_mock + +from mock_vws.database import CloudDatabase, VuMarkDatabase +from mock_vws.states import States +from vws_mock_contract_tests.fixtures.credentials import ( + InactiveVuMarkCloudDatabase, + VuMarkCloudDatabase, +) +from vws_mock_contract_tests.utils.unrouted_requests import UnroutedResponse +from vws_mock_server.target_manager import TARGET_MANAGER_FLASK_APP +from vws_mock_server.vwq import CLOUDRECO_FLASK_APP +from vws_mock_server.vws import VWS_FLASK_APP +from vws_mock_test_backends.mock_databases import create_vumark_database + + +@beartype +def enable_flask_in_process( + *, + working_database: CloudDatabase, + inactive_cloud_database: CloudDatabase, + vumark_vuforia_database: VuMarkCloudDatabase, + inactive_vumark_database: InactiveVuMarkCloudDatabase, + monkeypatch: pytest.MonkeyPatch, + base_vws_url: str, + base_vwq_url: str, +) -> Generator[None]: + """Test against the Flask applications of the mock, in this process. + + This exercises the handlers of the Flask applications which the + Docker deployment runs, but not the deployment itself: all three + applications are served from one process, so state which the + deployment keeps in separate containers is shared here. + ``tests/mock_vws/test_docker.py`` covers the container split. + """ + # We set ``wsgi.input_terminated`` to ``True`` so that when going through + # ``requests`` in our tests, the Flask applications + # have the given ``Content-Length`` headers and the given data in + # ``request.headers`` and ``request.data``. + # + # We do not set these in the Flask application itself. + # This is because when running the Flask application, if this is set, + # reading ``request.data`` hangs. + # + # Therefore, when running the real Flask application, the behavior is not + # the same as the real Vuforia. + # This is documented as a difference in the documentation for this package. + VWS_FLASK_APP.config["VWS_MOCK_TERMINATE_WSGI_INPUT"] = True + CLOUDRECO_FLASK_APP.config["VWS_MOCK_TERMINATE_WSGI_INPUT"] = True + + monkeypatch.setenv(name="VWS_BASE_URL", value=base_vws_url) + target_manager_base_url = "http://example.com" + monkeypatch.setenv( + name="TARGET_MANAGER_BASE_URL", + value=target_manager_base_url, + ) + vumark_database = create_vumark_database( + vumark_vuforia_database=vumark_vuforia_database, + ) + inactive_vumark_db = VuMarkDatabase( + state=States.PROJECT_INACTIVE, + database_name=inactive_vumark_database.target_manager_database_name, + server_access_key=inactive_vumark_database.server_access_key, + server_secret_key=inactive_vumark_database.server_secret_key, + ) + + with responses.RequestsMock(assert_all_requests_are_fired=False) as mock: + add_flask_app_to_mock( + mock_obj=mock, + flask_app=VWS_FLASK_APP, + base_url=base_vws_url, + ) + + add_flask_app_to_mock( + mock_obj=mock, + flask_app=CLOUDRECO_FLASK_APP, + base_url=base_vwq_url, + ) + + add_flask_app_to_mock( + mock_obj=mock, + flask_app=TARGET_MANAGER_FLASK_APP, + base_url=target_manager_base_url, + ) + + cloud_databases_url = target_manager_base_url + "/cloud_databases" + vumark_databases_url = target_manager_base_url + "/vumark_databases" + + for database in requests.get( + url=cloud_databases_url, timeout=30 + ).json(): + database_name: object = database["database_name"] + assert isinstance(database_name, str) + _ = requests.delete( + url=cloud_databases_url + "/" + database_name, + timeout=30, + ) + for database in requests.get( + url=vumark_databases_url, timeout=30 + ).json(): + database_name = database["database_name"] + assert isinstance(database_name, str) + _ = requests.delete( + url=vumark_databases_url + "/" + database_name, + timeout=30, + ) + + _ = requests.post( + url=cloud_databases_url, + json=working_database.to_dict(), + timeout=30, + ) + _ = requests.post( + url=cloud_databases_url, + json=inactive_cloud_database.to_dict(), + timeout=30, + ) + _ = requests.post( + url=vumark_databases_url, + json=vumark_database.to_dict(), + timeout=30, + ) + _ = requests.post( + url=vumark_databases_url, + json=inactive_vumark_db.to_dict(), + timeout=30, + ) + for vumark_target in vumark_database.vumark_targets: + _ = requests.post( + url=( + f"{vumark_databases_url}" + f"/{vumark_database.database_name}/vumark_targets" + ), + json=vumark_target.to_dict(), + timeout=30, + ) + + yield + + +@beartype +def enable_flask_model_targets( + *, + monkeypatch: pytest.MonkeyPatch, + base_vws_url: str, +) -> Generator[None]: + """Test against the Flask-backed mock Model Target Web API.""" + assert bool(monkeypatch) + VWS_FLASK_APP.config["VWS_MOCK_TERMINATE_WSGI_INPUT"] = True + target_manager_base_url = "http://example.com" + monkeypatch.setenv( + name="TARGET_MANAGER_BASE_URL", + value=target_manager_base_url, + ) + + with responses.RequestsMock(assert_all_requests_are_fired=False) as mock: + add_flask_app_to_mock( + mock_obj=mock, + flask_app=VWS_FLASK_APP, + base_url=base_vws_url, + ) + + # The VWS app stores Model Target datasets in the target manager + # service, just as it does cloud databases. + add_flask_app_to_mock( + mock_obj=mock, + flask_app=TARGET_MANAGER_FLASK_APP, + base_url=target_manager_base_url, + ) + + yield + + +@beartype +def send_flask_unrouted_request( + *, + method: HTTPMethod, + request_path: str, + headers: dict[str, str], +) -> UnroutedResponse: + """Send an unmatched request through the in-process Flask client.""" + # The ``responses`` library intercepts only the paths and methods + # which the Flask app routes, so requests to any other path never + # reach the app. A running container serves every path, so we drive + # the app with its own test client. + test_client_response = VWS_FLASK_APP.test_client().open( + request_path, + method=method, + headers=headers, + ) + response_body = test_client_response.data + content_encoding = test_client_response.headers.get( + key="Content-Encoding", + ) + if content_encoding == "gzip": + response_body = gzip.decompress(data=response_body) + return UnroutedResponse( + status_code=test_client_response.status_code, + body=response_body, + content_type=test_client_response.headers.get( + key="Content-Type", + ), + content_encoding=content_encoding, + upstream_service_time=test_client_response.headers.get( + key="x-envoy-upstream-service-time", + ), + ) + + +@beartype +def seed_flask_recognition_counts( + *, + database_name: str, + target_id: str, + current_month_recos: int, + previous_month_recos: int, + total_recos: int, +) -> None: + """Set recognition counts through the target manager service.""" + target_manager_base_url = os.environ["TARGET_MANAGER_BASE_URL"] + response = requests.post( + url=( + f"{target_manager_base_url}/cloud_databases/" + f"{database_name}/targets/{target_id}/recognition_counts" + ), + json={ + "current_month_recos": current_month_recos, + "previous_month_recos": previous_month_recos, + "total_recos": total_recos, + }, + timeout=30, + ) + response.raise_for_status() + + +@beartype +def add_cloud_database(*, cloud_database: CloudDatabase) -> None: + """Add a cloud database through the target manager service.""" + target_manager_base_url = os.environ["TARGET_MANAGER_BASE_URL"] + response = requests.post( + url=f"{target_manager_base_url}/cloud_databases", + json=cloud_database.to_dict(), + timeout=30, + ) + response.raise_for_status() diff --git a/test-backends/src/vws_mock_test_backends/mock_databases.py b/test-backends/src/vws_mock_test_backends/mock_databases.py new file mode 100644 index 000000000..36fd92a4e --- /dev/null +++ b/test-backends/src/vws_mock_test_backends/mock_databases.py @@ -0,0 +1,32 @@ +"""Database state shared by the two mock adapters.""" + +from beartype import beartype + +from mock_vws.database import VuMarkDatabase +from mock_vws.target import VuMarkTarget +from vws_mock_contract_tests.fixtures.credentials import VuMarkCloudDatabase + + +@beartype +def create_vumark_database( + *, + vumark_vuforia_database: VuMarkCloudDatabase, +) -> VuMarkDatabase: + """Return a database with a VuMark target for VuMark instance + generation. + """ + vumark_target = VuMarkTarget( + name="mock-vumark-target", + target_id=vumark_vuforia_database.target_id, + ) + processing_target = VuMarkTarget( + name="mock-processing-vumark-target", + target_id=vumark_vuforia_database.processing_target_id, + processing_time_seconds=9999, + ) + return VuMarkDatabase( + database_name=vumark_vuforia_database.target_manager_database_name, + server_access_key=vumark_vuforia_database.server_access_key, + server_secret_key=vumark_vuforia_database.server_secret_key, + vumark_targets={vumark_target, processing_target}, + ) diff --git a/test-backends/src/vws_mock_test_backends/vuforia_backends.py b/test-backends/src/vws_mock_test_backends/vuforia_backends.py index 9890f0d1b..ef1daece2 100644 --- a/test-backends/src/vws_mock_test_backends/vuforia_backends.py +++ b/test-backends/src/vws_mock_test_backends/vuforia_backends.py @@ -1,9 +1,7 @@ """Choose which backends to use for the tests.""" import contextlib -import gzip import logging -import os from collections.abc import Generator from enum import Enum from http import HTTPMethod @@ -12,11 +10,9 @@ import pytest import requests -import responses from beartype import BeartypeConf, beartype from pytest_multi_backend import backend_fixture from requests.exceptions import Timeout as RequestsTimeout -from requests_mock_flask import add_flask_app_to_mock from vws import VWS from vws.exceptions.vws_exceptions import ( TargetStatusNotSuccessError, @@ -24,13 +20,9 @@ from vws.response import Response from mock_vws import MockVWS -from mock_vws._flask_server.target_manager import TARGET_MANAGER_FLASK_APP -from mock_vws._flask_server.vwq import CLOUDRECO_FLASK_APP -from mock_vws._flask_server.vws import VWS_FLASK_APP from mock_vws.database import CloudDatabase, VuMarkDatabase from mock_vws.request_rate_limits import DOCUMENTED_REQUEST_RATE_LIMITS from mock_vws.states import States -from mock_vws.target import VuMarkTarget from vws_mock_contract_tests.fixtures.credentials import ( InactiveVuMarkCloudDatabase, ModelTargetCredentials, @@ -62,6 +54,14 @@ UnroutedRequests, UnroutedResponse, ) +from vws_mock_test_backends.flask_backend import ( + add_cloud_database, + enable_flask_in_process, + enable_flask_model_targets, + seed_flask_recognition_counts, + send_flask_unrouted_request, +) +from vws_mock_test_backends.mock_databases import create_vumark_database from vws_mock_test_backends.real_credentials import ( get_model_target_credentials, get_real_cloud_database, @@ -158,31 +158,6 @@ def _delete_processed_target(*, vws_client: VWS, target_id: str) -> None: vws_client.delete_target(target_id=target_id) -@beartype -def _vumark_database( - *, - vumark_vuforia_database: VuMarkCloudDatabase, -) -> VuMarkDatabase: - """Return a database with a VuMark target for VuMark instance - generation. - """ - vumark_target = VuMarkTarget( - name="mock-vumark-target", - target_id=vumark_vuforia_database.target_id, - ) - processing_target = VuMarkTarget( - name="mock-processing-vumark-target", - target_id=vumark_vuforia_database.processing_target_id, - processing_time_seconds=9999, - ) - return VuMarkDatabase( - database_name=vumark_vuforia_database.target_manager_database_name, - server_access_key=vumark_vuforia_database.server_access_key, - server_secret_key=vumark_vuforia_database.server_secret_key, - vumark_targets={vumark_target, processing_target}, - ) - - @beartype def _handle_real_request_timeout(*, url: str, error: RequestsTimeout) -> None: """Skip a shared request which timed out against the real service.""" @@ -247,7 +222,7 @@ def _enable_use_mock_vuforia( client_access_key=inactive_cloud_database.client_access_key, client_secret_key=inactive_cloud_database.client_secret_key, ) - vumark_database = _vumark_database( + vumark_database = create_vumark_database( vumark_vuforia_database=vumark_vuforia_database, ) inactive_vumark_db = VuMarkDatabase( @@ -269,130 +244,6 @@ def _enable_use_mock_vuforia( _RUNNING_IN_MEMORY_MOCKS.remove(mock) -@beartype -def _enable_use_flask_in_process( - *, - working_database: CloudDatabase, - inactive_cloud_database: CloudDatabase, - vumark_vuforia_database: VuMarkCloudDatabase, - inactive_vumark_database: InactiveVuMarkCloudDatabase, - monkeypatch: pytest.MonkeyPatch, - base_vws_url: str, - base_vwq_url: str, -) -> Generator[None]: - """Test against the Flask applications of the mock, in this process. - - This exercises the handlers of the Flask applications which the - Docker deployment runs, but not the deployment itself: all three - applications are served from one process, so state which the - deployment keeps in separate containers is shared here. - ``tests/mock_vws/test_docker.py`` covers the container split. - """ - # We set ``wsgi.input_terminated`` to ``True`` so that when going through - # ``requests`` in our tests, the Flask applications - # have the given ``Content-Length`` headers and the given data in - # ``request.headers`` and ``request.data``. - # - # We do not set these in the Flask application itself. - # This is because when running the Flask application, if this is set, - # reading ``request.data`` hangs. - # - # Therefore, when running the real Flask application, the behavior is not - # the same as the real Vuforia. - # This is documented as a difference in the documentation for this package. - VWS_FLASK_APP.config["VWS_MOCK_TERMINATE_WSGI_INPUT"] = True - CLOUDRECO_FLASK_APP.config["VWS_MOCK_TERMINATE_WSGI_INPUT"] = True - - monkeypatch.setenv(name="VWS_BASE_URL", value=base_vws_url) - target_manager_base_url = "http://example.com" - monkeypatch.setenv( - name="TARGET_MANAGER_BASE_URL", - value=target_manager_base_url, - ) - vumark_database = _vumark_database( - vumark_vuforia_database=vumark_vuforia_database, - ) - inactive_vumark_db = VuMarkDatabase( - state=States.PROJECT_INACTIVE, - database_name=inactive_vumark_database.target_manager_database_name, - server_access_key=inactive_vumark_database.server_access_key, - server_secret_key=inactive_vumark_database.server_secret_key, - ) - - with responses.RequestsMock(assert_all_requests_are_fired=False) as mock: - add_flask_app_to_mock( - mock_obj=mock, - flask_app=VWS_FLASK_APP, - base_url=base_vws_url, - ) - - add_flask_app_to_mock( - mock_obj=mock, - flask_app=CLOUDRECO_FLASK_APP, - base_url=base_vwq_url, - ) - - add_flask_app_to_mock( - mock_obj=mock, - flask_app=TARGET_MANAGER_FLASK_APP, - base_url=target_manager_base_url, - ) - - cloud_databases_url = target_manager_base_url + "/cloud_databases" - vumark_databases_url = target_manager_base_url + "/vumark_databases" - - for database in requests.get( - url=cloud_databases_url, timeout=30 - ).json(): - database_name: object = database["database_name"] - assert isinstance(database_name, str) - _ = requests.delete( - url=cloud_databases_url + "/" + database_name, - timeout=30, - ) - for database in requests.get( - url=vumark_databases_url, timeout=30 - ).json(): - database_name = database["database_name"] - assert isinstance(database_name, str) - _ = requests.delete( - url=vumark_databases_url + "/" + database_name, - timeout=30, - ) - - _ = requests.post( - url=cloud_databases_url, - json=working_database.to_dict(), - timeout=30, - ) - _ = requests.post( - url=cloud_databases_url, - json=inactive_cloud_database.to_dict(), - timeout=30, - ) - _ = requests.post( - url=vumark_databases_url, - json=vumark_database.to_dict(), - timeout=30, - ) - _ = requests.post( - url=vumark_databases_url, - json=inactive_vumark_db.to_dict(), - timeout=30, - ) - for vumark_target in vumark_database.vumark_targets: - _ = requests.post( - url=( - f"{vumark_databases_url}" - f"/{vumark_database.database_name}/vumark_targets" - ), - json=vumark_target.to_dict(), - timeout=30, - ) - - yield - - @beartype def _handle_real_model_target_response( *, @@ -446,39 +297,6 @@ def _enable_use_mock_model_target_vuforia( yield -@beartype -def _enable_use_flask_in_process_model_target_vuforia( - *, - monkeypatch: pytest.MonkeyPatch, - base_vws_url: str, -) -> Generator[None]: - """Test against the Flask-backed mock Model Target Web API.""" - assert bool(monkeypatch) - VWS_FLASK_APP.config["VWS_MOCK_TERMINATE_WSGI_INPUT"] = True - target_manager_base_url = "http://example.com" - monkeypatch.setenv( - name="TARGET_MANAGER_BASE_URL", - value=target_manager_base_url, - ) - - with responses.RequestsMock(assert_all_requests_are_fired=False) as mock: - add_flask_app_to_mock( - mock_obj=mock, - flask_app=VWS_FLASK_APP, - base_url=base_vws_url, - ) - - # The VWS app stores Model Target datasets in the target manager - # service, just as it does cloud databases. - add_flask_app_to_mock( - mock_obj=mock, - flask_app=TARGET_MANAGER_FLASK_APP, - base_url=target_manager_base_url, - ) - - yield - - class VuforiaBackend(Enum): """Backends for tests. @@ -601,15 +419,13 @@ def fixture_vumark_vuforia_database( _SETUP_FUNCTIONS = { VuforiaBackend.REAL: _enable_use_real_vuforia, VuforiaBackend.MOCK: _enable_use_mock_vuforia, - VuforiaBackend.FLASK_IN_PROCESS: _enable_use_flask_in_process, + VuforiaBackend.FLASK_IN_PROCESS: enable_flask_in_process, } _MODEL_TARGET_SETUP_FUNCTIONS = { VuforiaBackend.REAL: _enable_use_real_model_target_vuforia, VuforiaBackend.MOCK: _enable_use_mock_model_target_vuforia, - VuforiaBackend.FLASK_IN_PROCESS: ( - _enable_use_flask_in_process_model_target_vuforia - ), + VuforiaBackend.FLASK_IN_PROCESS: enable_flask_model_targets, } @@ -837,13 +653,7 @@ def _add_cloud_database( ) return - target_manager_base_url = os.environ["TARGET_MANAGER_BASE_URL"] - response = requests.post( - url=f"{target_manager_base_url}/cloud_databases", - json=cloud_database.to_dict(), - timeout=30, - ) - response.raise_for_status() + add_cloud_database(cloud_database=cloud_database) @pytest.fixture(name="create_cloud_database") @@ -924,32 +734,7 @@ def seed_in_memory_counts( return seed_in_memory_counts - @beartype - def seed_flask_counts( - *, - database_name: str, - target_id: str, - current_month_recos: int, - previous_month_recos: int, - total_recos: int, - ) -> None: - """Set recognition counts through the target manager service.""" - target_manager_base_url = os.environ["TARGET_MANAGER_BASE_URL"] - response = requests.post( - url=( - f"{target_manager_base_url}/cloud_databases/" - f"{database_name}/targets/{target_id}/recognition_counts" - ), - json={ - "current_month_recos": current_month_recos, - "previous_month_recos": previous_month_recos, - "total_recos": total_recos, - }, - timeout=30, - ) - response.raise_for_status() - - return seed_flask_counts + return seed_flask_recognition_counts @pytest.fixture(name="unrouted_requests") @@ -963,7 +748,7 @@ def fixture_unrouted_requests( del verify_mock_vuforia if _vws_backend == VuforiaBackend.FLASK_IN_PROCESS: return UnroutedRequests( - send=_send_flask_unrouted_request, + send=send_flask_unrouted_request, returns_response=True, ) @@ -1001,42 +786,6 @@ def send_http_request( ) -@beartype -def _send_flask_unrouted_request( - *, - method: HTTPMethod, - request_path: str, - headers: dict[str, str], -) -> UnroutedResponse: - """Send an unmatched request through the in-process Flask client.""" - # The ``responses`` library intercepts only the paths and methods - # which the Flask app routes, so requests to any other path never - # reach the app. A running container serves every path, so we drive - # the app with its own test client. - test_client_response = VWS_FLASK_APP.test_client().open( - request_path, - method=method, - headers=headers, - ) - response_body = test_client_response.data - content_encoding = test_client_response.headers.get( - key="Content-Encoding", - ) - if content_encoding == "gzip": - response_body = gzip.decompress(data=response_body) - return UnroutedResponse( - status_code=test_client_response.status_code, - body=response_body, - content_type=test_client_response.headers.get( - key="Content-Type", - ), - content_encoding=content_encoding, - upstream_service_time=test_client_response.headers.get( - key="x-envoy-upstream-service-time", - ), - ) - - @beartype def _model_target_credentials_for_backend( *, From eb7b24f097ad7e173b33e0987a490bfce84b050c Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Thu, 29 Oct 2026 09:37:02 +0000 Subject: [PATCH 2/2] Keep adapter documentation independent of test locations --- test-backends/src/vws_mock_test_backends/flask_backend.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test-backends/src/vws_mock_test_backends/flask_backend.py b/test-backends/src/vws_mock_test_backends/flask_backend.py index 7354556d7..a35795480 100644 --- a/test-backends/src/vws_mock_test_backends/flask_backend.py +++ b/test-backends/src/vws_mock_test_backends/flask_backend.py @@ -41,7 +41,7 @@ def enable_flask_in_process( Docker deployment runs, but not the deployment itself: all three applications are served from one process, so state which the deployment keeps in separate containers is shared here. - ``tests/mock_vws/test_docker.py`` covers the container split. + The Docker deployment tests cover the container split. """ # We set ``wsgi.input_terminated`` to ``True`` so that when going through # ``requests`` in our tests, the Flask applications