Skip to content

docs: remove false "parallel: tests" claim from docs (fixes #35) - #36

Merged
shossain786 merged 1 commit into
masterfrom
docs/fix-issue-35-parallel-tests-mode
Jul 27, 2026
Merged

shossain786 merged 1 commit into
masterfrom
docs/fix-issue-35-parallel-tests-mode

Conversation

@shossain786

Copy link
Copy Markdown
Contributor

Summary

docs-site/docs/guides/parallel.md advertised TestNG's tests parallel mode, but ExecutionValidator.validate() (called unconditionally at every suite start by FrameworkBootstrap.initialize()) only accepts none/methods/classes. A user who copied parallel: tests from the guide got a suite that aborted at bootstrap with IllegalStateException: Parallel execution configuration missing — a message that sends them hunting for absent config rather than telling them the value was rejected.

This is a docs-only fix, per the roadmap's conditional gate: parallel: tests was slated to become the v3.3.0 code fix (add tests support to ExecutionValidator) if a Marketplace download-lift signal held on re-measurement; it did not hold as of 2026-07-27, so the docs are corrected to match current code behavior instead. No .java files are touched.

Changes

  • docs-site/docs/guides/parallel.md
    • line 20 — inline config comment: none (default) | methods | classes | tests → none (default) | methods | classes
    • line 88 — replaced "TestNG supports several parallel modes. Selenium Boot works with all of them:" (false) with a sentence naming the three validated values and stating that anything else, including tests, is rejected at bootstrap
    • line 94 (now removed) — dropped the tests table row
  • docs-site/docs/configuration.md — found in the same sweep, not in the original three known lines:
    • line 48 — inline config comment: none | methods | classes | tests → none | methods | classes
    • ### parallel section — dropped the tests value row from the behaviour table and added a sentence stating the value is validated at bootstrap and tests is not currently accepted

Rather than silently deleting the tests rows, each spot now says plainly which values are supported and that others are rejected at startup — a TestNG-literate reader who goes looking for tests finds an explanation instead of an unexplained gap, and the error, if someone still hits it, is findable from the docs.

Known-remaining (deliberately out of scope)

The error message itself — "Parallel execution configuration missing" thrown for an unsupported value rather than a missing one — is misleading and called out in #35 as Bug 2. Fixing it means touching ExecutionValidator, which is the code change deferred by the roadmap gate mentioned above. Not addressed in this PR.

Also out of scope: #35's Bug 3 (the maxActiveSessions comment implying an enforced relationship to threadCount that the code doesn't actually check) — separate wording issue, not part of the tests-mode defect this PR fixes.

Sweep

Grepped all of docs-site/docs, docs-site/src, and README.md (excluding the gitignored docs-site/build output and node_modules) for any other advertisement of parallel: tests or an "all TestNG modes work" claim. Found and fixed one additional instance beyond the three known lines (configuration.md, two spots, listed above). No other occurrences remain — confirmed by a final grep pass after the edits.

Verification

cd docs-site && npm run build — succeeds (Docusaurus 3.5.2, client + server compiled, static files generated).

Fixes #35

🤖 Generated with Claude Code

ExecutionValidator only accepts none/methods/classes at suite
bootstrap; docs advertised TestNG's `tests` mode too, sending users
who copied it into an IllegalStateException before any test runs.

Fixes three lines in guides/parallel.md (inline config comment, the
"works with all of them" claim, and the `tests` table row) plus two
more instances found in the same sweep in configuration.md (the
inline comment and the `parallel` value table). Each spot now states
plainly which values are validated and that others are rejected at
bootstrap, instead of silently dropping the row — so a TestNG user
looking for `tests` finds the explanation, not a gap.

The error message itself ("Parallel execution configuration missing"
for an unsupported value, not a missing one) is a known follow-up,
deliberately out of scope here per the current roadmap gate.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@shossain786
shossain786 merged commit fdd2b63 into master Jul 27, 2026
2 checks passed
@shossain786
shossain786 deleted the docs/fix-issue-35-parallel-tests-mode branch July 27, 2026 02:28
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.

docs: parallel.md advertises unsupported "tests" mode; ExecutionValidator rejects it with a misleading error

1 participant