Skip to content

feat(testing): visual-regression public docs + dogfood + APPROVE_PROPERTY (Track N N2-N4)#127

Merged
DemchaAV merged 1 commit into
developfrom
feat/visual-regression-public-docs
Jun 3, 2026
Merged

feat(testing): visual-regression public docs + dogfood + APPROVE_PROPERTY (Track N N2-N4)#127
DemchaAV merged 1 commit into
developfrom
feat/visual-regression-public-docs

Conversation

@DemchaAV
Copy link
Copy Markdown
Owner

@DemchaAV DemchaAV commented Jun 3, 2026

Track N / N2–N4 — complete the public visual-regression surface (cycle 1.6.9)

Follow-up to #126 (which promoted PdfVisualRegression + ImageDiff to public API). This PR adds the docs, the consumer dogfood test, and the approve-mode property constant so the surface is cut-ready.

What changed

  • PdfVisualRegression.APPROVE_PROPERTY (@since 1.6.9) — exposes the graphcompose.visual.approve system-property name so consumers toggle approve mode without hard-coding the string (mirrors LayoutSnapshotAssertions.UPDATE_PROPERTY); approveMode() + the failure message now reference it.
  • N2docs/operations/visual-regression-testing.md: pixel-vs-semantic guidance, the PdfVisualRegression API + immutable-setter table, approve mode, baseline/sidecar layout, and cross-platform tolerance calibration (defaults tolerance 6 / budget 0; repo CV-parity uses 8 / 50_000 for Windows-baseline ↔ Linux-CI drift).
  • N3 — README "Which API should I use?" gains a pixel-level visual-regression row; the "Regression-tested layouts" bullet notes the pixel layer as complementary.
  • N4PublicVisualApiDogfoodTest: composes a document via the public DSL and pixel-tests it end-to-end through the public com.demcha.compose.testing.visual surface (approve → match → assert baseline + no sidecar), using the new APPROVE_PROPERTY. Sibling to LayoutSnapshotPublicApiDogfoodTest.

Verification

  • Full suite 1060/1060 green (incl. the new dogfood test; PdfVisualRegressionTest unaffected by the APPROVE_PROPERTY rename).
  • Docs links resolve; CHANGELOG updated under ## v1.6.9 — Planned (### Public API + ### Documentation).

Deferred

  • N5 (separate build-lane PR): widen the CI javadoc-validation <subpackages> to include com.demcha.compose.testing so the public testing helpers (layout + visual) get strict doclint coverage.

…ERTY (Track N N2-N4, @SInCE 1.6.9)

Completes the public visual-regression surface introduced in #126:

- expose PdfVisualRegression.APPROVE_PROPERTY (@SInCE 1.6.9) so consumers toggle approve mode without hard-coding the system-property string (mirrors LayoutSnapshotAssertions.UPDATE_PROPERTY)
- add docs/operations/visual-regression-testing.md (pixel vs semantic, API, approve mode, cross-platform tolerance calibration)
- README 'Which API should I use?' gains a pixel-level visual-regression row
- add PublicVisualApiDogfoodTest: composes a document and pixel-tests it end-to-end through the public testing.visual surface

Full suite 1060/1060 green.
@DemchaAV DemchaAV merged commit 36ad2b8 into develop Jun 3, 2026
11 checks passed
@DemchaAV DemchaAV deleted the feat/visual-regression-public-docs branch June 3, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant