Skip to content

Update pmd config to make it pmd 7 compatible #13168

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.

Sign up for GitHub

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

Open
vishesh92 wants to merge 2 commits into
base: 4.20
Choose a base branch
from
+74 −44
Open

Update pmd config to make it pmd 7 compatible #13168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be6b50c
Update pmd config to make it pmd 7 compatible
vishesh92 May 15, 2026
6b6c3f6
comment new excludes
vishesh92 May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/linters/codespell.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ environmnet
equivalant
erro
erronous
errorprone
everthing
everytime
excetion
Expand Down
117 changes: 73 additions & 44 deletions tools/checkstyle/src/main/resources/cloud-pmd.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,59 +23,88 @@
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0">

<description>
Ruleset that brings all the rulesets we want from the pmd jar, because
the maven-pmd-plugin doesn't find them otherwise. This is also the place
to add our own future rulesets, if any.
CloudStack PMD ruleset. Enables all PMD 7 categories with
project-specific exclusions for rules that are too noisy
or incompatible with CloudStack conventions.
</description>

<rule ref="category/java/basic.xml"/>
<rule ref="category/java/braces.xml"/>
<rule ref="category/java/clone.xml"/>
<rule ref="category/java/codesize.xml"/>
<rule ref="category/java/comments.xml">
<!-- We shouldn't limit the number of lines in the header of a class -->
<exclude name="CommentSize"/>
<exclude name="CommentRequired" />
<rule ref="category/java/bestpractices.xml">
<exclude name="AbstractClassWithoutAbstractMethod" />
<exclude name="GuardLogStatement" />
<!-- <exclude name="LiteralsFirstInComparisons" /> -->
Copy link
Copy Markdown
Contributor

@Pearl1594 Pearl1594 May 19, 2026

Choose a reason for hiding this comment

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

Can we remove these commented excludes?

Copy link
Copy Markdown
Member Author

@vishesh92 vishesh92 May 19, 2026

Choose a reason for hiding this comment

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

I discussed this with @DaanHoogland offline. And he suggested to comment these for now and enable as per requirement going forward.

<!-- <exclude name="PreserveStackTrace" /> -->
<!-- <exclude name="AvoidReassigningParameters" /> -->
<!-- <exclude name="LooseCoupling" /> -->
<!-- <exclude name="UseCollectionIsEmpty" /> -->
<!-- <exclude name="MissingOverride" /> -->
<!-- <exclude name="UnusedAssignment" /> -->
</rule>
<rule ref="category/java/controversial.xml">
<!-- The rule is good, but is not properly applied. It forces you to statically declare it as ConcurrentHashMap -->
<exclude name="UseConcurrentHashMap"/>
<exclude name="CallSuperInConstructor"/>
<exclude name="AtLeastOneConstructor"/>
<exclude name="AssignmentInOperand"/>
<exclude name="NullAssignment"/>
<exclude name="DataflowAnomalyAnalysis" />
<exclude name="UseObjectForClearerAPI" />

<rule ref="category/java/codestyle.xml">
<exclude name="ShortVariable" />
<exclude name="AtLeastOneConstructor" />
<exclude name="CallSuperInConstructor" />
<!-- <exclude name="LocalVariableCouldBeFinal" />
<exclude name="MethodArgumentCouldBeFinal" /> -->
<!-- <exclude name="OnlyOneReturn" /> -->
<!-- <exclude name="CommentDefaultAccessModifier" /> -->
<!-- <exclude name="FieldNamingConventions" /> -->
<!-- <exclude name="UseDiamondOperator" /> -->
<!-- <exclude name="UselessParentheses" /> -->
<!-- <exclude name="PrematureDeclaration" /> -->
<!-- <exclude name="UnnecessaryBoxing" /> -->
<!-- <exclude name="ControlStatementBraces" /> -->
<!-- <exclude name="FieldDeclarationsShouldBeAtStartOfClass" /> -->
<!-- <exclude name="ConfusingTernary" /> -->
<!-- <exclude name="UnnecessaryFullyQualifiedName" /> -->
<!-- <exclude name="LocalVariableNamingConventions" /> -->
<!-- <exclude name="UnnecessaryModifier" /> -->
<exclude name="LongVariable" />
</rule>
<rule ref="category/java/coupling.xml">

<rule ref="category/java/design.xml">
<exclude name="ExcessiveImports" />
<exclude name="LawOfDemeter"/>
<!-- <exclude name="CyclomaticComplexity" /> -->
<!-- <exclude name="CognitiveComplexity" /> -->
<!-- <exclude name="NPathComplexity" /> -->
<!-- <exclude name="AvoidCatchingGenericException" /> -->
<!-- <exclude name="AvoidUncheckedExceptionsInSignatures" /> -->
<!-- <exclude name="ImmutableField" /> -->
<!-- <exclude name="NcssCount" /> -->
<!-- <exclude name="CollapsibleIfStatements" /> -->
<!-- <exclude name="MutableStaticState" />
<exclude name="CouplingBetweenObjects" />
<exclude name="TooManyMethods" />
<exclude name="GodClass" /> -->
</rule>
<rule ref="category/java/design.xml">

<rule ref="category/java/documentation.xml">
<exclude name="CommentSize" />
<exclude name="CommentRequired" />
</rule>

<rule ref="category/java/errorprone.xml">
Copy link
Copy Markdown
Contributor

@Pearl1594 Pearl1594 May 19, 2026

Choose a reason for hiding this comment

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

I'm guessing this wouldn't clash with the errorprone work which depends on google-errorprone plugin (mvn)

Copy link
Copy Markdown
Member Author

@vishesh92 vishesh92 May 19, 2026

Choose a reason for hiding this comment

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

pmd checks are manual as of now, so it shouldn't break anything.

<exclude name="AssignmentInOperand" />
<exclude name="NullAssignment" />
<exclude name="ConstructorCallsOverridableMethod"/>
<exclude name="AbstractClassWithoutAbstractMethod"/>
<exclude name="AvoidSynchronizedAtMethodLevel"/>
<!-- <exclude name="AvoidDuplicateLiterals" />
<exclude name="ReplaceJavaUtilDate" />
<exclude name="AvoidLiteralsInIfCondition" />
<exclude name="UseLocaleWithCaseConversions" />
<exclude name="CompareObjectsWithEquals" /> -->
</rule>
<rule ref="category/java/empty.xml"/>
<rule ref="category/java/finalizers.xml"/>
<rule ref="category/java/imports.xml"/>
<rule ref="category/java/j2ee.xml"/>
<rule ref="category/java/junit.xml"/>
<rule ref="category/java/logging-java.xml"/>
<rule ref="category/java/naming.xml">
<exclude name="ShortVariable"/>
<exclude name="AbstractNaming"/>

<rule ref="category/java/multithreading.xml">
<exclude name="UseConcurrentHashMap" />
<exclude name="AvoidSynchronizedAtMethodLevel"/>
<!-- <exclude name="DoNotUseThreads" /> -->
</rule>
<rule ref="category/java/naming.xml/LongVariable">
<properties>
<property name="minimum" value="32"/>
</properties>

<rule ref="category/java/performance.xml">
<!-- <exclude name="AvoidInstantiatingObjectsInLoops" />
<exclude name="RedundantFieldInitializer" /> -->
</rule>
<rule ref="category/java/optimizations.xml"/>
<rule ref="category/java/strictexception.xml"/>
<rule ref="category/java/strings.xml"/>
<rule ref="category/java/sunsecure.xml"/>
<rule ref="category/java/typeresolution.xml"/>
<rule ref="category/java/unnecessary.xml"/>
<rule ref="category/java/unusedcode.xml"/>
<rule ref="category/java/security.xml" />

</ruleset>
Loading