Skip to content

Move testing guides to Building Apps and add CDI coverage - #6119

Draft
peholmst wants to merge 5 commits into
mainfrom
docs/building-apps-testing
Draft

peholmst wants to merge 5 commits into
mainfrom
docs/building-apps-testing

Conversation

@peholmst

@peholmst peholmst commented Sep 22, 2026

Copy link
Copy Markdown
Member

Browserless testing documentation currently mixes practical workflows with API reference material, while Building Apps has no testing section. This draft moves setup, worked scenarios, debugging, optimization, and migration instructions into Building Apps and retains technical contracts in the Flow reference.

The new landing page asks readers to choose Spring Boot, Java EE/CDI, Quarkus, or plain Java. Each framework has a separate setup guide. Shared task guides identify their example framework and explain which initialization to retain when adapting examples. A shared view snippet avoids sending plain Java and Quarkus readers through Spring Boot instructions.

The Java EE/CDI guide adapts the Bookstore CDI testing guide, with complete examples for injected services and CDI alternatives. The reference explains Weld discovery, scope activation, CDI servlet integration, and lifecycle ordering, replacing the obsolete claim that Java EE browserless tests are unsupported. The custom setup explicitly initializes signal support and registers routes; it does not rely on an empty ViewPackages annotation to disable scanning.

The configuration guide covers per-test properties and feature flags, with precedence and builder contracts in the reference. Spring session-scoped bean lookup and late-authentication examples live in the Spring guides. The reference retains the new tester capabilities, slot and renderer query rules, session ID rotation, and navigation behavior. Interaction examples open menus before using them, and the custom CDI setup explicitly documents its configuration boundary.

Cross-links connect tasks to the reference. The moved getting-started, plain Java setup, optimization, and migration reference pages are deleted; internal links point directly to their replacements.

Validation:

  • Extracted all seven Java sources from the CDI guide into a standalone Maven project. Both the injected-service test and the selected-alternative test passed with Vaadin 25.2.7, Browserless Test 1.1.2, Weld JUnit 5.0.3.Final, and JUnit 6.0.3.
  • Rendered the guides and reference with Asciidoctor without diagnostics, including shared view snippets.
  • Checked cross-references and code fences across the 36 remaining changed pages. Vale 3.22.0 with the PR configuration reported no warnings or errors in the testing guides and browserless reference, and none on PR-added lines. Git whitespace checks passed.
  • Merged main through ba7b831 and verified it is an ancestor of the branch; no unresolved merge conflicts remain.
  • Full site build and compilation of the remaining Java examples were not run.

The worktree's Husky bootstrap script was missing, so its frontend-only pre-commit hook was disabled for the documentation commits and reconciliation merge.

@github-actions

github-actions Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Preview Deployment

This PR has been deployed for preview.

URL: https://docs-preview-pr-6119.fly.dev

Changed pages

Added content is highlighted in green; removed content is marked in red on each page.

Other changed files

  • articles/flow/testing/browserless/getting-started.adoc (deleted)
  • articles/flow/testing/browserless/non-spring.adoc (deleted)
  • articles/flow/testing/browserless/optimizing-tests.adoc (deleted)

Built from ba2327e

@peholmst peholmst changed the title Move browserless testing tutorials to Building Apps Move testing guides to Building Apps and add CDI coverage Sep 22, 2026
@peholmst

Copy link
Copy Markdown
Member Author

Need to synch this PR with the changes from #6120 once they land.

@peholmst peholmst added the target/v25.3 Automatically cherry-pick to the v25.3 branch label Sep 22, 2026
@peholmst

Copy link
Copy Markdown
Member Author

Also need to wait for #6089 and #6101 before re-writing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

target/v25.3 Automatically cherry-pick to the v25.3 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant