Add VuMark Generation API endpoint (#473) by adamtheturtle · Pull Request #2878 · VWS-Python/vws-python-mock

adamtheturtle · 2026-01-28T08:14:14Z

Implements POST /targets/<target_id>/instances endpoint for generating VuMark instance images in SVG, PNG, or PDF format. Includes validators, exception classes, image generators, and comprehensive test coverage for both requests-mock and Flask implementations.

Closes #473

🤖 Generated with Claude Code

Note

Medium Risk
Adds a new binary-returning API route and new validation/error paths across both mock backends, plus changes to database/target serialization that could break compatibility if any callers assume the previous schemas.

Overview
Adds support for the VuMark Generation API via POST /targets/<target_id>/instances in both the Flask server and the requests-mock backend, returning placeholder SVG/PNG/PDF content based on the Accept header.

Introduces VuMark-specific validators and new ResultCodes/ValidatorError types for invalid Accept, invalid/missing instance_id, non-vumark target types, and non-success target status; updates key/target-id routing validation to handle the new /instances path shape.

Extends the data model to persist target_type per target and default_target_type per database (configurable via target-manager), and adds comprehensive tests plus CI inclusion for the new endpoint and a regression around target IDs named instances.

^{Written by Cursor Bugbot for commit b536a1d. This will update automatically on new commits. Configure here.}

Implement POST /targets/<target_id>/instances endpoint for generating VuMark instance images in SVG, PNG, or PDF format. Includes validators, exception classes, image generators, and comprehensive test coverage for both requests-mock and Flask implementations. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

Address mypy type checking issues in vumark implementation: - Use keyword arguments for PIL Image/ImageDraw methods - Add proper type annotation for accept_header variable - Use str(object=...) syntax for strict type checking Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

src/mock_vws/_vumark_generators.py

Add 'svg' to spelling dictionary and fix 'pdf' to 'PDF' in comments to pass pylint spell checking. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

Use the standard test pattern with the verify_mock_vuforia fixture so tests run against all backends (real, mock, docker). Add test classes to the CI matrix in test.yml. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- PNG: Use white background (was black, making text invisible) - SVG: Escape instance_id with xml.sax.saxutils.escape to prevent malformed XML from special characters - PDF: Compute stream length, xref offsets, and startxref dynamically instead of hardcoding them. Escape PDF string literal characters. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

src/mock_vws/_requests_mock_server/mock_web_services_api.py

Return exc.response_text as str (consistent with all other endpoints) instead of encoding to bytes on error paths. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Real Vuforia returns 422 InvalidTargetType because the test targets are regular image targets, not VuMark targets. Use mock_only_vuforia to skip real Vuforia backend. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

src/mock_vws/_services_validators/target_validators.py

tests/mock_vws/fixtures/vuforia_backends.py

adamtheturtle · 2026-02-15T11:49:40Z

tests/mock_vws/test_vumark_generation.py

+    return requests.post(url=url, data=content, headers=headers, timeout=30)
+
+
+@pytest.mark.usefixtures("mock_only_vuforia")


This needs to not be mock-only

adamtheturtle · 2026-02-15T11:50:16Z

tests/mock_vws/test_vumark_generation.py

+    """Tests for successful VuMark instance generation."""
+
+    @pytest.fixture
+    def vuforia_database(  # pylint: disable=no-self-use


Instead, let's have a conftest.py fixture for a vucloud dataabse

adamtheturtle · 2026-02-15T11:50:31Z

pyproject.toml

    "@*APP.route",
    "@*APP.before_request",
    "@*APP.errorhandler",
+    # requests-mock server


Not sure why we need this

adamtheturtle temporarily deployed to development January 28, 2026 08:14 — with GitHub Actions Inactive

adamtheturtle temporarily deployed to development January 28, 2026 08:15 — with GitHub Actions Inactive

cursor bot reviewed Jan 28, 2026

View reviewed changes

src/mock_vws/_vumark_generators.py Show resolved Hide resolved

src/mock_vws/_vumark_generators.py Outdated Show resolved Hide resolved

src/mock_vws/_vumark_generators.py Outdated Show resolved Hide resolved

Fix pylint spelling errors in VuMark implementation

f193a40

Add 'svg' to spelling dictionary and fix 'pdf' to 'PDF' in comments to pass pylint spell checking. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development January 28, 2026 08:36 — with GitHub Actions Inactive

Refactor VuMark tests to use verify_mock_vuforia fixture

dcb8ec3

Use the standard test pattern with the verify_mock_vuforia fixture so tests run against all backends (real, mock, docker). Add test classes to the CI matrix in test.yml. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 15, 2026 07:56 — with GitHub Actions Inactive

adamtheturtle temporarily deployed to development February 15, 2026 09:00 — with GitHub Actions Inactive

cursor bot reviewed Feb 15, 2026

View reviewed changes

src/mock_vws/_requests_mock_server/mock_web_services_api.py Outdated Show resolved Hide resolved

Remove unnecessary .encode() on error paths in VuMark endpoint

e2db9b5

Return exc.response_text as str (consistent with all other endpoints) instead of encoding to bytes on error paths. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 15, 2026 09:13 — with GitHub Actions Inactive

Use mock_only_vuforia for VuMark tests

0edf26a

Real Vuforia returns 422 InvalidTargetType because the test targets are regular image targets, not VuMark targets. Use mock_only_vuforia to skip real Vuforia backend. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 15, 2026 09:31 — with GitHub Actions Inactive

adamtheturtle mentioned this pull request Feb 15, 2026

Add VuMark database support VWS-Python/vws-web-tools#1194

Open

Add VuMark validation and related test updates

3c6ec7b

adamtheturtle temporarily deployed to development February 15, 2026 11:05 — with GitHub Actions Inactive

cursor bot reviewed Feb 15, 2026

View reviewed changes

src/mock_vws/_services_validators/target_validators.py Outdated Show resolved Hide resolved

tests/mock_vws/fixtures/vuforia_backends.py Show resolved Hide resolved

Fix manual CI pylint failures for VuMark generation

99fef3e

adamtheturtle temporarily deployed to development February 15, 2026 11:22 — with GitHub Actions Inactive

adamtheturtle added 3 commits February 15, 2026 11:41

Address PR #2878 Bugbot follow-up findings

37095d4

Fix mypy typing in PR #2878 regression test

7704c8b

Use unittest patch for typed target-id regression test

4ee8d50

adamtheturtle temporarily deployed to development February 15, 2026 11:45 — with GitHub Actions Inactive

adamtheturtle commented Feb 15, 2026

View reviewed changes

Address PR #2878 review comments

b536a1d

adamtheturtle temporarily deployed to development February 15, 2026 12:07 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VuMark Generation API endpoint (#473)#2878

Add VuMark Generation API endpoint (#473)#2878
adamtheturtle wants to merge 13 commits intomainfrom
adamtheturtle/remove-mock-prefix

adamtheturtle commented Jan 28, 2026 •

edited by cursor bot

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

Uh oh!

adamtheturtle Feb 15, 2026

Uh oh!

adamtheturtle Feb 15, 2026

Uh oh!

adamtheturtle Feb 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		return requests.post(url=url, data=content, headers=headers, timeout=30)


		@pytest.mark.usefixtures("mock_only_vuforia")

Conversation

adamtheturtle commented Jan 28, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

adamtheturtle Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

adamtheturtle Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

adamtheturtle Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

adamtheturtle commented Jan 28, 2026 •

edited by cursor bot

Loading