Skip to content

Adds ArchUnit tests for naming conventions #2077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 30, 2025

Conversation

solonovamax
Copy link
Contributor

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:

  • Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • Add JavaDocs and other comments explaining the behavior.
  • When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • Run 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.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • Enable "Allow edits from maintainers".

Signed-off-by: solonovamax <solonovamax@12oclockpoint.com>
Signed-off-by: solonovamax <solonovamax@12oclockpoint.com>
@solonovamax
Copy link
Contributor Author

the tests are currently failing, but this is only because I originally wrote the code against my other PR, which changed the signature of one of the methods.
If my other PR gets merged first, then all the tests pass.

Copy link
Member

@bitwiseman bitwiseman left a comment

Choose a reason for hiding this comment

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

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()
Copy link
Member

Choose a reason for hiding this comment

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

All methods should follow the convention regardless of visibility.

Copy link

codecov bot commented Mar 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.84%. Comparing base (1225510) to head (b4687f9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #2077   +/-   ##
=========================================
  Coverage     83.84%   83.84%           
  Complexity     2414     2414           
=========================================
  Files           236      236           
  Lines          7330     7330           
  Branches        389      389           
=========================================
  Hits           6146     6146           
  Misses          952      952           
  Partials        232      232           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bitwiseman bitwiseman merged commit aec09b9 into hub4j:main Mar 30, 2025
12 checks passed
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