{{ message }}
Adds ArchUnit tests for naming conventions#2077
Merged
bitwiseman merged 8 commits intoMar 30, 2025
Merged
Conversation
Signed-off-by: solonovamax <solonovamax@12oclockpoint.com>
Signed-off-by: solonovamax <solonovamax@12oclockpoint.com>
Contributor
Author
bitwiseman
approved these changes
Mar 29, 2025
bitwiseman
left a comment
Member
There was a problem hiding this comment.
Great!
Comments are observations that you can change or not, up to you. I'm fine taking this PR and then tuning later.
Please add the exception for methods you changed in the other PR. Then we can merge this immediately. The. The other PR can modify the tests as needed.
|
|
||
| @SuppressWarnings("AccessStaticViaInstance") | ||
| final ArchRule methodsNotFollowingConvention = noMethods().that() | ||
| .arePublic() |
Member
There was a problem hiding this comment.
All methods should follow the convention regardless of visibility.
bitwiseman
reviewed
Mar 29, 2025
bitwiseman
reviewed
Mar 29, 2025
bitwiseman
reviewed
Mar 29, 2025
bitwiseman
reviewed
Mar 29, 2025
bitwiseman
reviewed
Mar 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Description
Adds ArchUnit tests to validate naming conventions.
kind of jank, and could probably be improved, as I don't have experience with ArchUnit.
Based on the discussion in #2074
There are several different places where the test fails, so those places are special-cased to be ignored (per the discussion). Many of those places, however, could (and should) be package-private. (specifically, the instances where a method either starts with or ends with an underscore)
Before submitting a PR:
@linkJavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .mvn -D enable-ci clean install site "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"locally. If this command doesn't succeed, your change will not pass CI.main. You will create your PR from that branch.When creating a PR: