Skip to content

feat(reqstool): add build config conventions for JUnit5 parameterized test names#29

Merged
jimisola merged 1 commit into
mainfrom
docs/gradle-junit5-parameterized-test-names
Jun 13, 2026
Merged

feat(reqstool): add build config conventions for JUnit5 parameterized test names#29
jimisola merged 1 commit into
mainfrom
docs/gradle-junit5-parameterized-test-names

Conversation

@jimisola

@jimisola jimisola commented Jun 12, 2026

Copy link
Copy Markdown
Member

Summary

  • Add a new reqstool-build-config-conventions.md reference doc to the reqstool-conventions skill, documenting the Gradle/JUnit5 systemProperty fix for parameterized test display names (Kotlin & Groovy DSL), scoped to Gradle/JUnit5 with notes on the explicit @ParameterizedTest(name=...) override and Maven Surefire being unaffected
  • Link the new doc from SKILL.md, reqstool-conventions.md, docs/modules/ROOT/pages/skills.adoc, and README.md
  • Bump plugins/reqstool plugin version 0.3.0 → 0.4.0 and marketplace version 0.4.1 → 0.5.0 per CLAUDE.md versioning rules — this adds new guidance/behavior to the auto-applied reqstool-conventions skill, so it's a feat, not a docs/typo fix

This addresses #28: without this configuration, reqstool emits "Skipping parameterized test case with display-name-only format (method name not recoverable)" warnings for Gradle/JUnit5 projects and the corresponding @SVCs IDs never get marked as verified.

Closes #28

Test plan

  • Reviewed new reference doc for consistency with existing reqstool-conventions reference docs
  • Verified plugin.json / marketplace.json remain valid JSON with bumped versions
  • Confirmed cross-links from SKILL.md, reqstool-conventions.md, skills.adoc, and README.md point to the new file
  • Verified the documented warning message format and CLI command against the reqstool-client source, and the @ParameterizedTest(name=...) caveat against reqstool-java-gradle-plugin PR #63

… test names

Document the Gradle/JUnit5 systemProperty fix for parameterized test
display names so reqstool can map JUnit XML test results back to
@SVCs-annotated methods, avoiding "Skipping parameterized test case"
warnings.

Adds reqstool-build-config-conventions.md (scoped to Gradle/JUnit5,
with notes on the explicit @ParameterizedTest(name=...) override and
Maven Surefire being unaffected), and links it from SKILL.md,
reqstool-conventions.md, skills.adoc, and README.md.

Closes #28

Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
@jimisola jimisola force-pushed the docs/gradle-junit5-parameterized-test-names branch from 1716804 to e47040c Compare June 13, 2026 16:16
@jimisola jimisola changed the title docs(reqstool): add build config conventions for JUnit5 parameterized test names feat(reqstool): add build config conventions for JUnit5 parameterized test names Jun 13, 2026

@jimisola jimisola left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Full PR Review — Consolidated Findings (fixed)

Ran 7 parallel checks (review, code-review, smells, advanced-smells, security, cruft, testing) against the original diff. Security and cruft checks passed clean. All actionable findings below have been addressed in this push:

# Prio Finding Resolution
1 Medium Doc's own example looked like a custom @ParameterizedTest(name=...) case, which the systemProperty default doesn't fix Added an explicit caveat block + rewrote examples to match upstream PR #63's [1] ACTIVEcheckStatus(StatusType)[1]
2 Medium README.md has a third, pre-existing listing of reqstool-conventions reference docs that wasn't updated Added a bullet for the new doc
3 Medium New doc is Gradle/Java-specific but unscoped in a multi-language skill Added a scope note (Gradle + JUnit 5 only; Maven Surefire unaffected)
4 Medium No CI check that reference docs are listed everywhere they should be (this PR illustrates the gap) Filed follow-up issue #30 (non-blocking)
5 Low "During reqstool validate" — verified against reqstool-client source: validate is a real subcommand, but the warning fires during any test-result processing (e.g. reqstool status) Reworded to "When reqstool processes the JUnit XML test results (e.g. via reqstool status)"
6 Low reqstool-java-gradle-plugin#63 is an open/unmerged PR cited as settled guidance; reqstool-client#405 linked/labeled as an issue Confirmed via gh pr view: #63 is OPEN, #405 is a MERGED PR. Updated links/labels accordingly, noted #63 is open
7 Low Example warning text didn't match the actual reqstool-client log format; inconsistent example values across sections Replaced with the real log message format and a single consistent example ([1] ACTIVE / checkStatus(StatusType)[1], matching upstream PR #63)
8 Low Redundant sentence repeating what the code blocks already show Removed
9 Low ### References (H3, nested) vs sibling docs' top-level ## References Promoted to ## References
10 Info Commit/PR were typed docs(reqstool): but this adds new skill guidance/behavior (a feat), consistent with the minor version bumps already applied Amended commit + retitled PR to feat(reqstool): ...

Automated — /x:full-pr-review

Comment thread README.md
@jimisola jimisola merged commit 2de8684 into main Jun 13, 2026
5 checks passed
@jimisola jimisola deleted the docs/gradle-junit5-parameterized-test-names branch June 13, 2026 16:49
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.

Add junit5 parameterized test display name system property

1 participant