Add comprehensive VuMark instance generation tests (#2954)

* Add comprehensive VuMark instance generation tests and mock support

- Add tests for PNG, SVG, and PDF output formats (parametrized)
- Add tests for invalid Accept header (returns InvalidAcceptHeader 400)
- Add tests for empty instance_id (returns InvalidInstanceId 422)
- Organise tests into a class with verify_mock_vuforia on the class
- Implement Accept header validation and multi-format responses in mock
- Add InvalidAcceptHeader and InvalidInstanceId result codes and exceptions
- Add minimal SVG and PDF mock response content
- Document VuMark image simplification in differences-to-vws.rst

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix mypy errors in VuMark tests and Flask handler

- Use argnames=/argvalues= keyword arguments in pytest.mark.parametrize
- Use keyword argument key= for Flask Headers.get() call

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Add svg and pdf to spelling private dictionary

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Retry delete_target if TargetStatusProcessingError after update_target

Vuforia has a race condition where delete_target can raise
TargetStatusProcessingError immediately after wait_for_target_processed
returns, because update_target(active_flag=False) triggers a brief
reprocessing cycle that may not have started by the time the wait
completes. Retry once with another wait if this occurs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Complete remaining todos: ResultCodes constants, spelling revert, retry

- Use ResultCodes.INVALID_ACCEPT_HEADER.value and
  ResultCodes.INVALID_INSTANCE_ID.value in test assertions instead
  of raw strings
- Reword docstrings/docs to avoid acronyms that trigger the spell
  checker, and revert spelling_private_dict.txt to its pre-PR state
- Replace one-off try/except retry in _delete_all_targets with a
  proper tenacity-based _delete_target_when_processed helper function

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Extract multipart parsing helper; revert retry changes to separate issue

- Extract repeated multipart parsing logic in image_validators.py into
  _parse_multipart_files helper, eliminating four copies of the same
  six-line pattern
- Revert _delete_target_when_processed retry changes from vuforia_backends.py;
  tracked separately as #2955

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Simplify valid_accept_types: content type equals accept key

The dict values were (bytes, str) tuples where the str was always
identical to the dict key (the Accept MIME type). Use a plain
dict[str, bytes] and derive the content type directly from `accept`.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Remove duplicate _parse_multipart_files introduced by merge

Both branches independently added the same helper; keep the
@beartype-decorated version from main.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix Docker build on PRs; remove duplicate rst section

- Pass files: docker-bake.hcl explicitly to docker/bake-action so it
  uses the local checked-out file rather than fetching from the PR
  merge ref (refs/pull/*/merge) via HTTPS, which requires auth not
  available to the bake action
- Remove duplicate 'VuMark instance images' section in
  differences-to-vws.rst introduced by the merge

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Revert docker-build.yml change; Docker failure was transient

The Docker build failures are intermittent infrastructure issues, not a
systematic problem. The files: docker-bake.hcl change was unnecessary.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: adamtheturtle

src/mock_vws/_constants.py

@@ -11,6 +11,21 @@
     b"\xaeB`\x82"
 )
 
+VUMARK_SVG = (
+    b'<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100"></svg>'
+)
+
+VUMARK_PDF = (
+    b"%PDF-1.4\n"
+    b"1 0 obj<</Type /Catalog /Pages 2 0 R>>endobj\n"
+    b"2 0 obj<</Type /Pages /Kids [3 0 R] /Count 1>>endobj\n"
+    b"3 0 obj<</Type /Page /MediaBox [0 0 100 100]>>endobj\n"
+    b"xref\n0 4\n"
+    b"0000000000 65535 f \n"
+    b"trailer<</Size 4/Root 1 0 R>>\n"
+    b"startxref\n9\n%%EOF"
+)
+
 
 @beartype
 @unique
@@ -45,6 +60,8 @@ class ResultCodes(Enum):
     PROJECT_INACTIVE = "ProjectInactive"
     INACTIVE_PROJECT = "InactiveProject"
     TOO_MANY_REQUESTS = "TooManyRequests"
+    INVALID_ACCEPT_HEADER = "InvalidAcceptHeader"
+    INVALID_INSTANCE_ID = "InvalidInstanceId"
 
 
 @beartype

src/mock_vws/_flask_server/vws.py

@@ -18,12 +18,20 @@
 from flask import Flask, Response, request
 from pydantic_settings import BaseSettings
 
-from mock_vws._constants import VUMARK_PNG, ResultCodes, TargetStatuses
+from mock_vws._constants import (
+    VUMARK_PDF,
+    VUMARK_PNG,
+    VUMARK_SVG,
+    ResultCodes,
+    TargetStatuses,
+)
 from mock_vws._database_matchers import get_database_matching_server_keys
 from mock_vws._mock_common import json_dump
 from mock_vws._services_validators import run_services_validators
 from mock_vws._services_validators.exceptions import (
     FailError,
+    InvalidAcceptHeaderError,
+    InvalidInstanceIdError,
     TargetStatusNotSuccessError,
     TargetStatusProcessingError,
     ValidatorError,
@@ -351,10 +359,27 @@ def generate_vumark_instance(target_id: str) -> Response:
     """
     # ``target_id`` is validated by request validators.
     del target_id
+
+    accept = request.headers.get(key="Accept", default="")
+    valid_accept_types: dict[str, bytes] = {
+        "image/png": VUMARK_PNG,
+        "image/svg+xml": VUMARK_SVG,
+        "application/pdf": VUMARK_PDF,
+    }
+    if accept not in valid_accept_types:
+        raise InvalidAcceptHeaderError
+
+    request_json = json.loads(s=request.data)
+    instance_id = request_json.get("instance_id", "")
+    if not instance_id:
+        raise InvalidInstanceIdError
+
+    response_body = valid_accept_types[accept]
+    content_type = accept
     date = email.utils.formatdate(timeval=None, localtime=False, usegmt=True)
     headers = {
         "Connection": "keep-alive",
-        "Content-Type": "image/png",
+        "Content-Type": content_type,
         "server": "envoy",
         "Date": date,
         "x-envoy-upstream-service-time": "5",
@@ -364,7 +389,7 @@ def generate_vumark_instance(target_id: str) -> Response:
     }
     return Response(
         status=HTTPStatus.OK,
-        response=VUMARK_PNG,
+        response=response_body,
         headers=headers,
     )
 

src/mock_vws/_requests_mock_server/mock_web_services_api.py

@@ -18,12 +18,20 @@
 from beartype import BeartypeConf, beartype
 from requests.models import PreparedRequest
 
-from mock_vws._constants import VUMARK_PNG, ResultCodes, TargetStatuses
+from mock_vws._constants import (
+    VUMARK_PDF,
+    VUMARK_PNG,
+    VUMARK_SVG,
+    ResultCodes,
+    TargetStatuses,
+)
 from mock_vws._database_matchers import get_database_matching_server_keys
 from mock_vws._mock_common import Route, json_dump
 from mock_vws._services_validators import run_services_validators
 from mock_vws._services_validators.exceptions import (
     FailError,
+    InvalidAcceptHeaderError,
+    InvalidInstanceIdError,
     TargetStatusNotSuccessError,
     TargetStatusProcessingError,
     ValidatorError,
@@ -295,30 +303,49 @@ def generate_vumark_instance(
         self, request: PreparedRequest
     ) -> _ResponseType:
         """Generate a VuMark instance."""
-        run_services_validators(
-            request_headers=request.headers,
-            request_body=_body_bytes(request=request),
-            request_method=request.method or "",
-            request_path=request.path_url,
-            databases=self._target_manager.databases,
-        )
+        valid_accept_types: dict[str, bytes] = {
+            "image/png": VUMARK_PNG,
+            "image/svg+xml": VUMARK_SVG,
+            "application/pdf": VUMARK_PDF,
+        }
+        try:
+            run_services_validators(
+                request_headers=request.headers,
+                request_body=_body_bytes(request=request),
+                request_method=request.method or "",
+                request_path=request.path_url,
+                databases=self._target_manager.databases,
+            )
+
+            accept = dict(request.headers).get("Accept", "")
+            if accept not in valid_accept_types:
+                raise InvalidAcceptHeaderError
+
+            request_json = json.loads(s=_body_bytes(request=request))
+            instance_id = request_json.get("instance_id", "")
+            if not instance_id:
+                raise InvalidInstanceIdError
+        except ValidatorError as exc:
+            return exc.status_code, exc.headers, exc.response_text
 
+        response_body = valid_accept_types[accept]
+        content_type = accept
         date = email.utils.formatdate(
             timeval=None,
             localtime=False,
             usegmt=True,
         )
         headers = {
             "Connection": "keep-alive",
-            "Content-Type": "image/png",
+            "Content-Type": content_type,
             "Date": date,
             "server": "envoy",
             "x-envoy-upstream-service-time": "5",
             "strict-transport-security": "max-age=31536000",
             "x-aws-region": "us-east-2, us-west-2",
             "x-content-type-options": "nosniff",
         }
-        return HTTPStatus.OK, headers, VUMARK_PNG
+        return HTTPStatus.OK, headers, response_body
 
     @route(path_pattern="/summary", http_methods={HTTPMethod.GET})
     def database_summary(self, request: PreparedRequest) -> _ResponseType:

src/mock_vws/_services_validators/exceptions.py

@@ -530,6 +530,82 @@ def __init__(self) -> None:
         }
 
 
+@beartype
+class InvalidAcceptHeaderError(ValidatorError):
+    """Exception raised when an unsupported Accept header is given."""
+
+    def __init__(self) -> None:
+        """
+        Attributes:
+            status_code: The status code to use in a response if this is
+                raised.
+            response_text: The response text to use in a response if this
+        is
+                raised.
+        """
+        super().__init__()
+        self.status_code = HTTPStatus.BAD_REQUEST
+        body = {
+            "transaction_id": uuid.uuid4().hex,
+            "result_code": ResultCodes.INVALID_ACCEPT_HEADER.value,
+        }
+        self.response_text = json_dump(body=body)
+        date = email.utils.formatdate(
+            timeval=None,
+            localtime=False,
+            usegmt=True,
+        )
+        self.headers = {
+            "Connection": "keep-alive",
+            "Content-Type": "application/json",
+            "server": "envoy",
+            "Date": date,
+            "x-envoy-upstream-service-time": "5",
+            "Content-Length": str(object=len(self.response_text)),
+            "strict-transport-security": "max-age=31536000",
+            "x-aws-region": "us-east-2, us-west-2",
+            "x-content-type-options": "nosniff",
+        }
+
+
+@beartype
+class InvalidInstanceIdError(ValidatorError):
+    """Exception raised when an invalid instance_id is given."""
+
+    def __init__(self) -> None:
+        """
+        Attributes:
+            status_code: The status code to use in a response if this is
+                raised.
+            response_text: The response text to use in a response if this
+        is
+                raised.
+        """
+        super().__init__()
+        self.status_code = HTTPStatus.UNPROCESSABLE_ENTITY
+        body = {
+            "transaction_id": uuid.uuid4().hex,
+            "result_code": ResultCodes.INVALID_INSTANCE_ID.value,
+        }
+        self.response_text = json_dump(body=body)
+        date = email.utils.formatdate(
+            timeval=None,
+            localtime=False,
+            usegmt=True,
+        )
+        self.headers = {
+            "Connection": "keep-alive",
+            "Content-Type": "application/json",
+            "server": "envoy",
+            "Date": date,
+            "x-envoy-upstream-service-time": "5",
+            "Content-Length": str(object=len(self.response_text)),
+            "strict-transport-security": "max-age=31536000",
+            "x-aws-region": "us-east-2, us-west-2",
+            "x-content-type-options": "nosniff",
+        }
+
+
 @beartype
 class TargetStatusProcessingError(ValidatorError):
     """Exception raised when trying to delete a target which is processing."""