From 6249180d1652597797120ebfc1abcb034d87b3f9 Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Thu, 29 Oct 2026 09:37:28 +0000 Subject: [PATCH] Move Flask and deployment tests into the server project --- .dockerignore | 1 + .github/workflows/test.yml | 8 ++-- conftest.py | 7 +++ .../consumer/test_installed_suite.py | 4 +- .../utils/usage_test_helpers.py | 44 ++++++++++++++++++ prek.toml | 2 +- pyproject.toml | 7 ++- server/README.rst | 15 +++++++ .../tests/vws_mock_server_tests/__init__.py | 1 + .../flask_app/__init__.py | 0 .../flask_app/conftest.py | 6 +-- .../flask_app/test_concurrency.py | 4 +- .../flask_app/test_databases.py | 6 +-- .../flask_app/test_delays.py | 0 .../flask_app/test_images.py | 0 .../flask_app/test_model_targets.py | 2 +- .../flask_app/test_processing.py | 2 +- .../flask_app/test_quotas.py | 0 .../flask_app/test_reports.py | 0 .../flask_app/test_routing.py | 36 +++++++++++++++ .../flask_app/test_vumark.py | 0 .../vws_mock_server_tests}/test_docker.py | 2 +- .../test_healthcheck.py | 6 ++- tests/conftest.py | 8 ---- tests/mock_vws/flask_app/test_routing.py | 24 ---------- tests/mock_vws/utils/usage_test_helpers.py | 45 +++---------------- 26 files changed, 138 insertions(+), 92 deletions(-) create mode 100644 contract-tests/src/vws_mock_contract_tests/utils/usage_test_helpers.py create mode 100644 server/tests/vws_mock_server_tests/__init__.py rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/__init__.py (100%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/conftest.py (93%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_concurrency.py (99%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_databases.py (99%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_delays.py (100%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_images.py (100%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_model_targets.py (98%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_processing.py (96%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_quotas.py (100%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_reports.py (100%) create mode 100644 server/tests/vws_mock_server_tests/flask_app/test_routing.py rename {tests/mock_vws => server/tests/vws_mock_server_tests}/flask_app/test_vumark.py (100%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/test_docker.py (99%) rename {tests/mock_vws => server/tests/vws_mock_server_tests}/test_healthcheck.py (94%) delete mode 100644 tests/conftest.py delete mode 100644 tests/mock_vws/flask_app/test_routing.py diff --git a/.dockerignore b/.dockerignore index fc054acbe..a36d767a4 100644 --- a/.dockerignore +++ b/.dockerignore @@ -31,6 +31,7 @@ newsfragments secrets.tar.gpg spelling_private_dict.txt tests +server/tests vuforia_secrets.env.example zizmor.yml diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 03b8049e6..075390a83 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -136,9 +136,9 @@ jobs: - tests/mock_vws/requests_mock - tests/mock_vws/respx_mock - tests/mock_vws/httpx2_mock - - tests/mock_vws/flask_app - - tests/mock_vws/test_healthcheck.py - - tests/mock_vws/test_docker.py + - server/tests/vws_mock_server_tests/flask_app + - server/tests/vws_mock_server_tests/test_healthcheck.py + - server/tests/vws_mock_server_tests/test_docker.py - README.rst - docs/ @@ -170,7 +170,7 @@ jobs: # We have seen issues with running out of disk space on test_docker - name: Free Disk Space (Ubuntu) uses: jlumbroso/free-disk-space@main - if: matrix.ci_pattern == 'tests/mock_vws/test_docker.py' + if: matrix.ci_pattern == 'server/tests/vws_mock_server_tests/test_docker.py' with: # All of these default to true (meaning they are removed). docker-images: false diff --git a/conftest.py b/conftest.py index 972f875ba..91642fb49 100644 --- a/conftest.py +++ b/conftest.py @@ -15,3 +15,10 @@ ], patterns=["*.rst", "*.py"], ).pytest() + + +# Load shared fixtures for both core and server tests. +pytest_plugins = [ + "vws_mock_contract_tests.fixtures.plugin", + "vws_mock_test_backends.vuforia_backends", +] diff --git a/contract-tests/consumer/test_installed_suite.py b/contract-tests/consumer/test_installed_suite.py index 6fccd615c..ba33e2792 100644 --- a/contract-tests/consumer/test_installed_suite.py +++ b/contract-tests/consumer/test_installed_suite.py @@ -93,7 +93,9 @@ def test_installed_suite( ) health_tests = tmp_path / "test_server_health.py" _ = shutil.copyfile( - src=repository / "tests/mock_vws/test_healthcheck.py", dst=health_tests + src=repository + / "server/tests/vws_mock_server_tests/test_healthcheck.py", + dst=health_tests, ) _run(args=[python, "-m", "pytest", health_tests, "-q"], cwd=tmp_path) _run( diff --git a/contract-tests/src/vws_mock_contract_tests/utils/usage_test_helpers.py b/contract-tests/src/vws_mock_contract_tests/utils/usage_test_helpers.py new file mode 100644 index 000000000..a2e992ccb --- /dev/null +++ b/contract-tests/src/vws_mock_contract_tests/utils/usage_test_helpers.py @@ -0,0 +1,44 @@ +"""Helpers for testing the usage of the mocks.""" + +import datetime as dt +import io + +from beartype import beartype +from vws import VWS +from vws.reports import TargetStatuses + +from vws_mock_contract_tests.fixtures.credentials import ( + CloudDatabaseCredentials, +) + + +@beartype +def processing_time_seconds( + *, + vuforia_database: CloudDatabaseCredentials, + base_vws_url: str, + image: io.BytesIO, +) -> float: + """Return the time taken to process a target in the database.""" + vws_client = VWS( + base_vws_url=base_vws_url, + server_access_key=vuforia_database.server_access_key, + server_secret_key=vuforia_database.server_secret_key, + ) + target_id = vws_client.add_target( + name="example", + width=1, + image=image, + active_flag=True, + application_metadata=None, + ) + start_time = dt.datetime.now(tz=dt.UTC) + + while ( + vws_client.get_target_record(target_id=target_id).status + == TargetStatuses.PROCESSING + ): + pass + + processing_time = dt.datetime.now(tz=dt.UTC) - start_time + return processing_time.total_seconds() diff --git a/prek.toml b/prek.toml index 9e2b99ca1..4fa0aad35 100644 --- a/prek.toml +++ b/prek.toml @@ -329,7 +329,7 @@ hooks = [ { id = "pylint", name = "pylint", - entry = "uv run --group=dev -m pylint *.py src/ tests/ server/src/ contract-tests/src/ contract-tests/consumer/ test-backends/src/ docs/ ci/ admin/", + entry = "uv run --group=dev -m pylint *.py src/ tests/ server/src/ server/tests/ contract-tests/src/ contract-tests/consumer/ test-backends/src/ docs/ ci/ admin/", language = "python", stages = ["manual"], pass_filenames = false, diff --git a/pyproject.toml b/pyproject.toml index 87ae7d20b..05011d969 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -210,6 +210,7 @@ lint.per-file-ignores."doccmd_*.py" = [ # Allow asserts in docs. "S101", ] +lint.per-file-ignores."server/tests/**" = [ "S101", "S105", "S106" ] lint.per-file-ignores."test-backends/src/**" = [ "S101", "S105", "S106" ] lint.per-file-ignores."tests/**" = [ # Allow asserts in tests. @@ -375,6 +376,7 @@ ignore = [ "prek.toml", "secrets.tar.gpg", "server/Dockerfile", + "server/tests/**", "spelling_private_dict.txt", "styles/snapper/*.yml", "tests", @@ -514,14 +516,14 @@ markers = [ "requires_docker_build", ] # Legacy import modules keep the existing CI partitions stable. -norecursedirs = [ "contract-tests", "server", "test-backends" ] +norecursedirs = [ "contract-tests", "test-backends" ] # Options for pytest-retry. retries = "10" retry_delay = "10" xfail_strict = true [tool.coverage] -run.source = [ "ci/", "contract-tests/src/", "server/src/", "src/", "test-backends/src/", "tests/" ] +run.source = [ "ci/", "contract-tests/src/", "server/src/", "server/tests/", "src/", "test-backends/src/", "tests/" ] # Import-only compatibility modules contain no assertions or backend logic. # Their authoritative implementations remain subject to full coverage. run.omit = [ @@ -543,6 +545,7 @@ run.omit = [ "tests/mock_vws/utils/retries.py", "tests/mock_vws/utils/too_many_requests.py", "tests/mock_vws/utils/unrouted_requests.py", + "tests/mock_vws/utils/usage_test_helpers.py", ] run.branch = true run.parallel = true diff --git a/server/README.rst b/server/README.rst index 5ad5f5318..92edf5ac4 100644 --- a/server/README.rst +++ b/server/README.rst @@ -43,3 +43,18 @@ The published images continue to probe the local service on port 5000: The probe accepts the existing unauthorized, forbidden and missing-route responses as healthy. It fails on connection errors, timeouts and other HTTP statuses. + +Development tests +----------------- + +The server project owns its Flask, health-check and container deployment tests. +Run them from the workspace root: + +.. code-block:: console + + $ uv run --group=dev pytest server/tests --skip-backend=real + +The Docker tests build and start all three services and require a running Docker daemon. +For the Flask and health-check cases alone, add ``--skip-marker=requires_docker_build``. +The shared fixtures are loaded explicitly from the installed contract package. +Shared API assertions remain maintained in that package. diff --git a/server/tests/vws_mock_server_tests/__init__.py b/server/tests/vws_mock_server_tests/__init__.py new file mode 100644 index 000000000..809d755f6 --- /dev/null +++ b/server/tests/vws_mock_server_tests/__init__.py @@ -0,0 +1 @@ +"""Tests owned by the server project.""" diff --git a/tests/mock_vws/flask_app/__init__.py b/server/tests/vws_mock_server_tests/flask_app/__init__.py similarity index 100% rename from tests/mock_vws/flask_app/__init__.py rename to server/tests/vws_mock_server_tests/flask_app/__init__.py diff --git a/tests/mock_vws/flask_app/conftest.py b/server/tests/vws_mock_server_tests/flask_app/conftest.py similarity index 93% rename from tests/mock_vws/flask_app/conftest.py rename to server/tests/vws_mock_server_tests/flask_app/conftest.py index 049cae31a..5ef2038fb 100644 --- a/tests/mock_vws/flask_app/conftest.py +++ b/server/tests/vws_mock_server_tests/flask_app/conftest.py @@ -8,12 +8,12 @@ from beartype import beartype from requests_mock_flask import add_flask_app_to_mock -from mock_vws._flask_server.target_manager import ( +from vws_mock_server.target_manager import ( TARGET_MANAGER, 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 vws_mock_server.vwq import CLOUDRECO_FLASK_APP +from vws_mock_server.vws import VWS_FLASK_APP @beartype diff --git a/tests/mock_vws/flask_app/test_concurrency.py b/server/tests/vws_mock_server_tests/flask_app/test_concurrency.py similarity index 99% rename from tests/mock_vws/flask_app/test_concurrency.py rename to server/tests/vws_mock_server_tests/flask_app/test_concurrency.py index cbe1be2f3..24c26b150 100644 --- a/tests/mock_vws/flask_app/test_concurrency.py +++ b/server/tests/vws_mock_server_tests/flask_app/test_concurrency.py @@ -20,11 +20,11 @@ from pydantic import JsonValue, TypeAdapter from werkzeug.serving import BaseWSGIServer, make_server -from mock_vws._flask_server.target_manager import ( +from mock_vws.database import CloudDatabase +from vws_mock_server.target_manager import ( TARGET_MANAGER, TARGET_MANAGER_FLASK_APP, ) -from mock_vws.database import CloudDatabase _NUM_WRITER_THREADS = 4 _NUM_READER_THREADS = 4 diff --git a/tests/mock_vws/flask_app/test_databases.py b/server/tests/vws_mock_server_tests/flask_app/test_databases.py similarity index 99% rename from tests/mock_vws/flask_app/test_databases.py rename to server/tests/vws_mock_server_tests/flask_app/test_databases.py index 21682b605..305809abc 100644 --- a/tests/mock_vws/flask_app/test_databases.py +++ b/server/tests/vws_mock_server_tests/flask_app/test_databases.py @@ -10,11 +10,11 @@ from pydantic import JsonValue, TypeAdapter from vws import VWS, CloudRecoService -from mock_vws._flask_server.target_manager import ( - TARGET_MANAGER, -) from mock_vws.database import CloudDatabase, VuMarkDatabase from mock_vws.target import VuMarkTarget +from vws_mock_server.target_manager import ( + TARGET_MANAGER, +) def test_add_cloud_database_duplicate_keys(target_manager_url: str) -> None: diff --git a/tests/mock_vws/flask_app/test_delays.py b/server/tests/vws_mock_server_tests/flask_app/test_delays.py similarity index 100% rename from tests/mock_vws/flask_app/test_delays.py rename to server/tests/vws_mock_server_tests/flask_app/test_delays.py diff --git a/tests/mock_vws/flask_app/test_images.py b/server/tests/vws_mock_server_tests/flask_app/test_images.py similarity index 100% rename from tests/mock_vws/flask_app/test_images.py rename to server/tests/vws_mock_server_tests/flask_app/test_images.py diff --git a/tests/mock_vws/flask_app/test_model_targets.py b/server/tests/vws_mock_server_tests/flask_app/test_model_targets.py similarity index 98% rename from tests/mock_vws/flask_app/test_model_targets.py rename to server/tests/vws_mock_server_tests/flask_app/test_model_targets.py index 6c9d82256..3f1ccb65e 100644 --- a/tests/mock_vws/flask_app/test_model_targets.py +++ b/server/tests/vws_mock_server_tests/flask_app/test_model_targets.py @@ -9,13 +9,13 @@ import requests from pydantic import JsonValue, TypeAdapter -from mock_vws._flask_server import target_manager as flask_target_manager from mock_vws.model_target import ( ModelTargetDataset, ModelTargetDatasetType, ModelTargetGenerationFailure, ModelTargetGenerationWarning, ) +from vws_mock_server import target_manager as flask_target_manager _MODEL_TARGET_DATASET_REQUEST: dict[str, JsonValue] = { "name": "dataset-name", diff --git a/tests/mock_vws/flask_app/test_processing.py b/server/tests/vws_mock_server_tests/flask_app/test_processing.py similarity index 96% rename from tests/mock_vws/flask_app/test_processing.py rename to server/tests/vws_mock_server_tests/flask_app/test_processing.py index e01944a38..d55e8be5b 100644 --- a/tests/mock_vws/flask_app/test_processing.py +++ b/server/tests/vws_mock_server_tests/flask_app/test_processing.py @@ -6,7 +6,7 @@ import requests from mock_vws.database import CloudDatabase -from tests.mock_vws.utils.usage_test_helpers import ( +from vws_mock_contract_tests.utils.usage_test_helpers import ( processing_time_seconds, ) diff --git a/tests/mock_vws/flask_app/test_quotas.py b/server/tests/vws_mock_server_tests/flask_app/test_quotas.py similarity index 100% rename from tests/mock_vws/flask_app/test_quotas.py rename to server/tests/vws_mock_server_tests/flask_app/test_quotas.py diff --git a/tests/mock_vws/flask_app/test_reports.py b/server/tests/vws_mock_server_tests/flask_app/test_reports.py similarity index 100% rename from tests/mock_vws/flask_app/test_reports.py rename to server/tests/vws_mock_server_tests/flask_app/test_reports.py diff --git a/server/tests/vws_mock_server_tests/flask_app/test_routing.py b/server/tests/vws_mock_server_tests/flask_app/test_routing.py new file mode 100644 index 000000000..32df1bb66 --- /dev/null +++ b/server/tests/vws_mock_server_tests/flask_app/test_routing.py @@ -0,0 +1,36 @@ +"""Tests for routing through the Flask app. + +Tests for requests which the Flask app does not route. + +Signed requests are covered by +``tests/mock_vws/invalid_given_id``, which verifies the +responses against real Vuforia. +""" + +from http import HTTPStatus + +from mock_vws._flask_server import target_manager as legacy_target_manager +from mock_vws._flask_server import vwq as legacy_vwq +from mock_vws._flask_server import vws as legacy_vws +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 + + +def test_unauthenticated_unknown_path() -> None: + """A request to a path which is not routed returns a 404 even + without credentials. + + The Docker health check relies on this request returning a + response. + """ + # Compatibility imports must share the same applications and state. + assert legacy_vws.VWS_FLASK_APP is VWS_FLASK_APP + assert legacy_vwq.CLOUDRECO_FLASK_APP is CLOUDRECO_FLASK_APP + assert ( + legacy_target_manager.TARGET_MANAGER_FLASK_APP + is TARGET_MANAGER_FLASK_APP + ) + response = VWS_FLASK_APP.test_client().get("/some-random-endpoint") + + assert response.status_code == HTTPStatus.NOT_FOUND diff --git a/tests/mock_vws/flask_app/test_vumark.py b/server/tests/vws_mock_server_tests/flask_app/test_vumark.py similarity index 100% rename from tests/mock_vws/flask_app/test_vumark.py rename to server/tests/vws_mock_server_tests/flask_app/test_vumark.py diff --git a/tests/mock_vws/test_docker.py b/server/tests/vws_mock_server_tests/test_docker.py similarity index 99% rename from tests/mock_vws/test_docker.py rename to server/tests/vws_mock_server_tests/test_docker.py index 1c1a6968b..8cd1b784f 100644 --- a/tests/mock_vws/test_docker.py +++ b/server/tests/vws_mock_server_tests/test_docker.py @@ -378,7 +378,7 @@ def fixture_mock_deployment() -> Iterator[_MockDeployment]: """ repository_root = str( object=find_root( - criterion=has_file(file="pyproject.toml"), + criterion=has_file(file="docker-bake.hcl"), start=Path(__file__).resolve(), ) ) diff --git a/tests/mock_vws/test_healthcheck.py b/server/tests/vws_mock_server_tests/test_healthcheck.py similarity index 94% rename from tests/mock_vws/test_healthcheck.py rename to server/tests/vws_mock_server_tests/test_healthcheck.py index bf9d5a798..6eea5d431 100644 --- a/tests/mock_vws/test_healthcheck.py +++ b/server/tests/vws_mock_server_tests/test_healthcheck.py @@ -12,7 +12,10 @@ from flask import Flask, Response from werkzeug.serving import make_server -from mock_vws._flask_server.healthcheck import flask_app_healthy +from mock_vws._flask_server.healthcheck import ( + flask_app_healthy as legacy_flask_app_healthy, +) +from vws_mock_server.healthcheck import flask_app_healthy _HEALTH_CHECK_DEADLINE_SECONDS = 10 @@ -117,6 +120,7 @@ def test_healthy(*, status: HTTPStatus) -> None: """An app which handles a request for an unknown endpoint is healthy. """ + assert legacy_flask_app_healthy is flask_app_healthy with _app_responding_with(status=status) as port: assert flask_app_healthy(port=port) diff --git a/tests/conftest.py b/tests/conftest.py deleted file mode 100644 index 32c992040..000000000 --- a/tests/conftest.py +++ /dev/null @@ -1,8 +0,0 @@ -"""Register shared fixtures and the backend adapters for this -repository. -""" - -pytest_plugins = [ - "vws_mock_contract_tests.fixtures.plugin", - "vws_mock_test_backends.vuforia_backends", -] diff --git a/tests/mock_vws/flask_app/test_routing.py b/tests/mock_vws/flask_app/test_routing.py deleted file mode 100644 index ff9731426..000000000 --- a/tests/mock_vws/flask_app/test_routing.py +++ /dev/null @@ -1,24 +0,0 @@ -"""Tests for routing through the Flask app. - -Tests for requests which the Flask app does not route. - -Signed requests are covered by -``tests/mock_vws/invalid_given_id``, which verifies the -responses against real Vuforia. -""" - -from http import HTTPStatus - -from mock_vws._flask_server.vws import VWS_FLASK_APP - - -def test_unauthenticated_unknown_path() -> None: - """A request to a path which is not routed returns a 404 even - without credentials. - - The Docker health check relies on this request returning a - response. - """ - response = VWS_FLASK_APP.test_client().get("/some-random-endpoint") - - assert response.status_code == HTTPStatus.NOT_FOUND diff --git a/tests/mock_vws/utils/usage_test_helpers.py b/tests/mock_vws/utils/usage_test_helpers.py index 462c6a6f0..6d302aef9 100644 --- a/tests/mock_vws/utils/usage_test_helpers.py +++ b/tests/mock_vws/utils/usage_test_helpers.py @@ -1,42 +1,7 @@ -"""Helpers for testing the usage of the mocks.""" +"""Compatibility imports for shared mock usage helpers.""" -import datetime as dt -import io +from vws_mock_contract_tests.utils.usage_test_helpers import ( + processing_time_seconds, +) -from beartype import beartype -from vws import VWS -from vws.reports import TargetStatuses - -from tests.mock_vws.fixtures.credentials import CloudDatabaseCredentials - - -@beartype -def processing_time_seconds( - *, - vuforia_database: CloudDatabaseCredentials, - base_vws_url: str, - image: io.BytesIO, -) -> float: - """Return the time taken to process a target in the database.""" - vws_client = VWS( - base_vws_url=base_vws_url, - server_access_key=vuforia_database.server_access_key, - server_secret_key=vuforia_database.server_secret_key, - ) - target_id = vws_client.add_target( - name="example", - width=1, - image=image, - active_flag=True, - application_metadata=None, - ) - start_time = dt.datetime.now(tz=dt.UTC) - - while ( - vws_client.get_target_record(target_id=target_id).status - == TargetStatuses.PROCESSING - ): - pass - - processing_time = dt.datetime.now(tz=dt.UTC) - start_time - return processing_time.total_seconds() +__all__ = ["processing_time_seconds"]