Skip to content

SONARJAVA-6212 Document and rename sonarRules property for ruling tests#5534

Merged
asya-vorobeva merged 1 commit intomasterfrom
asya/fix-ruling-test-property
Mar 26, 2026
Merged

SONARJAVA-6212 Document and rename sonarRules property for ruling tests#5534
asya-vorobeva merged 1 commit intomasterfrom
asya/fix-ruling-test-property

Conversation

@asya-vorobeva
Copy link
Copy Markdown
Contributor

@asya-vorobeva asya-vorobeva commented Mar 26, 2026

Part of SONARJAVA-6212

@hashicorp-vault-sonar-prod
Copy link
Copy Markdown
Contributor

hashicorp-vault-sonar-prod bot commented Mar 26, 2026

SONARJAVA-6212

@sonar-review-alpha
Copy link
Copy Markdown

sonar-review-alpha bot commented Mar 26, 2026

Summary

This PR renames the rules property to sonarRules for filtering which rules run in the ruling tests, making the property name more explicit and consistent with SonarQube conventions. The change includes updated documentation in the README with usage examples, improved JavaDoc comments in the code, and a new Maven profile (only-jboss-project) for convenience testing of individual projects.

What reviewers should know

Key changes to review:

  1. Property rename (JavaRulingTest.java): The property being read changed from System.getProperty("rules", "") to System.getProperty("sonarRules", ""). This is the functional core of the change.

  2. Documentation updates (README.md): A new section explains how to use the sonarRules property with a concrete example (mvn clean install -Pit-ruling -DsonarRules=S100,S101).

  3. New Maven profile (pom.xml): The only-jboss-project profile was added for convenience, though it's independent of the main property rename.

  4. Comment improvements (JavaRulingTest.java): The inline comment was converted to a proper JavaDoc block with formatted code example, making it more discoverable and professional.

Watch for: Any tests or documentation outside these files that might still reference the old rules property name.


  • Generate Walkthrough
  • Generate Diagram

🗣️ Give feedback

@asya-vorobeva asya-vorobeva force-pushed the asya/fix-ruling-test-property branch from a450fc8 to fabb7ad Compare March 26, 2026 10:54
@asya-vorobeva asya-vorobeva enabled auto-merge (squash) March 26, 2026 10:55
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@asya-vorobeva asya-vorobeva force-pushed the asya/fix-ruling-test-property branch from fabb7ad to 1558f09 Compare March 26, 2026 11:01
@sonarqube-next
Copy link
Copy Markdown

@asya-vorobeva asya-vorobeva merged commit 9f24cce into master Mar 26, 2026
14 of 15 checks passed
@asya-vorobeva asya-vorobeva deleted the asya/fix-ruling-test-property branch March 26, 2026 11:16
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.

2 participants