From c582b7fc1f5909e13d5bc4e2a1d398239f53665e Mon Sep 17 00:00:00 2001
From: mahfouz72 <mohamadmahfouz39@gmail.com>
Date: Thu, 9 May 2024 15:43:55 +0300
Subject: [PATCH] supplemental: suppress PMD violations

---
 config/pmd-test.xml                           |  31 ++++-
 config/pmd.xml                                | 125 +++++++++++++++++-
 .../checks/imports/ImportOrderCheckTest.java  |   2 +-
 3 files changed, 153 insertions(+), 5 deletions(-)

diff --git a/config/pmd-test.xml b/config/pmd-test.xml
index 772ed4208aa..e0d61b18740 100644
--- a/config/pmd-test.xml
+++ b/config/pmd-test.xml
@@ -95,10 +95,20 @@
            assertion calls are not required as they are called by the library.
            In MainTest PMD does not find asserts in lambdas called in the method
              invokeAndWait. -->
+      <!-- For AllCheckTest.testAllModulesAreReferencedInConfigFile,
+           testAllCheckTokensAreReferencedInCheckstyleConfigFile,
+           testAllCheckTokensAreReferencedInGoogleConfigFile,
+           testAllCheckstyleModulesHaveXdocDocumentation
+           until https://github.com/checkstyle/checkstyle/issues/14870 -->
       <property name="violationSuppressXPath"
                value="//ClassDeclaration[@SimpleName='AllChecksTest'
                      or @SimpleName='AstRegressionTest'
                      or @SimpleName='ImportControlCheckTest']//PrimaryPrefix/Name[@Name='verify']
+                   | //ClassDeclaration[@SimpleName='AllChecksTest']
+                       //MethodDeclaration[@Name='testAllModulesAreReferencedInConfigFile'
+                        or @Name='testAllCheckTokensAreReferencedInCheckstyleConfigFile'
+                        or @Name='testAllCheckTokensAreReferencedInGoogleConfigFile'
+                        or @Name='testAllCheckstyleModulesHaveXdocDocumentation']
                    | //ClassDeclaration[@SimpleName='MainTest']
                        //PrimaryPrefix//Name[starts-with(@SimpleName, 'assert')]
                    | //ClassDeclaration[@SimpleName='XdocsPagesTest']
@@ -137,6 +147,8 @@
           as they check each token and each rule explicitly.
          JavadocTokenTypes.testTokenValues contains several asserts as it checks each
           token explicitly. -->
+      <!-- For ClassImportRuleTest and all the below suppressions
+          until https://github.com/checkstyle/checkstyle/issues/14870 -->
       <property name="violationSuppressXPath"
                value="//ClassDeclaration[@SimpleName='JavadocTokenTypesTest']
                         //MethodDeclaration[@Name='testTokenValues']
@@ -145,7 +157,15 @@
                     | //ClassDeclaration[@SimpleName='GeneratedJavadocTokenTypesTest']
                         //MethodDeclaration[@Name='testTokenNumbers']
                     | //ClassDeclaration[@SimpleName='ParseTreeTablePresentationTest']
-                        //MethodDeclaration[@Name='testGetValueAtDetailNode']"/>
+                        //MethodDeclaration[@Name='testGetValueAtDetailNode']
+                    | //ClassDeclaration[@SimpleName='ClassImportRuleTest']
+                    | //ClassDeclaration[@SimpleName='PkgImportRuleTest']
+                    | //ClassDeclaration[@SimpleName='PkgImportControlTest']
+                       //MethodDeclaration[ends-with(@Name, 'CheckAccess')]
+                    | //ClassDeclaration[@SimpleName='JavadocTagInfoTest']
+                       //MethodDeclaration[@Name='testCoverage']
+                    | //ClassDeclaration[@SimpleName='AstRegressionTest']
+                       //MethodDeclaration[@Name='testCustomAstTree']"/>
     </properties>
   </rule>
 
@@ -198,9 +218,16 @@
   <rule ref="category/java/multithreading.xml/DoNotUseThreads">
     <properties>
       <!-- We use thread to limit the stack size for a test method. -->
+      <!-- For SuppressionFilterTest.isConnectionAvailableAndStable and
+           SuppressionsLoaderTest.loadFilterSet
+           https://github.com/checkstyle/checkstyle/issues/14870 -->
       <property name="violationSuppressXPath"
                value="//ClassDeclaration[@SimpleName='TestUtil']
-                        //MethodDeclaration[@Name='getResultWithLimitedResources']"/>
+                        //MethodDeclaration[@Name='getResultWithLimitedResources']
+               | //ClassDeclaration[@SimpleName='SuppressionFilterTest']
+                        //MethodDeclaration[@Name='isConnectionAvailableAndStable']
+               | //ClassDeclaration[@SimpleName='SuppressionsLoaderTest']
+                    //MethodDeclaration[@Name='loadFilterSet']"/>
     </properties>
   </rule>
 </ruleset>
diff --git a/config/pmd.xml b/config/pmd.xml
index 87aea4c347b..46e62a6d1b8 100644
--- a/config/pmd.xml
+++ b/config/pmd.xml
@@ -14,6 +14,28 @@
     <!-- too much false-positives from 6.18.0 -->
     <exclude name="UnusedPrivateMethod"/>
   </rule>
+  <rule ref="category/java/bestpractices.xml/UnusedLocalVariable">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='FilterUtil']
+                        //MethodDeclaration[@Name='isFileExists']
+                | //ClassDeclaration[@SimpleName='TreeWalkerTest']
+                        //MethodDeclaration[@Name='testNoAuditEventsWithoutFilters']
+                | //ClassDeclaration[@SimpleName='OrderedPropertiesCheckTest']
+                        //MethodDeclaration[@Name='getFileNotFoundDetail']
+                | //ClassDeclaration[@SimpleName='UniquePropertiesCheckTest']
+                        //MethodDeclaration[@Name='getFileNotFoundDetail']
+                | //ClassDeclaration[@SimpleName='HeaderCheckTest']
+                        //MethodDeclaration[@Name='testIoExceptionWhenLoadingHeader']
+                | //ClassDeclaration[@SimpleName='CustomImportOrderCheckTest']
+                        //MethodDeclaration[@Name='testGetFullImportIdent']
+               | //ClassDeclaration[@SimpleName='MainFrameTest']
+                        //MethodDeclaration[@Name='testOpenFileButton']
+               | //ClassDeclaration[@SimpleName='ConfigurationLoaderTest']
+                        //MethodDeclaration[@Name='testConfigWithIgnoreExceptionalAttributes']"/>
+    </properties>
+  </rule>
   <rule ref="category/java/bestpractices.xml/AvoidPrintStackTrace">
     <properties>
       <!-- It is ok to use print stack trace in CLI class. -->
@@ -39,6 +61,42 @@
                        or @SimpleName='JavadocPropertiesGenerator']"/>
     </properties>
   </rule>
+  <rule ref="category/java/bestpractices.xml/LiteralsFirstInComparisons">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath" value="//ClassDeclaration[
+        @SimpleName='XdocsUrlTest']//MethodDeclaration[@Name='characters' or @Name='endElement']"/>
+    </properties>
+  </rule>
+  <rule ref="category/java/bestpractices.xml/LooseCoupling">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='CodeSelectorPresentationTest']
+                     //FieldDeclaration//VariableDeclarator[@Name='linesToPosition']
+                | //ClassDeclaration[@SimpleName='FileText']
+                     //ConstructorDeclaration
+                | //ClassDeclaration[@SimpleName='ArchUnitSuperClassTest']
+                  //MethodDeclaration[@Name=
+                  'testChecksShouldHaveAllowedAbstractClassAsSuperclass']
+                | //ClassDeclaration[@SimpleName='ArchUnitTest']
+                  //MethodDeclaration[@Name='nonProtectedCheckMethodsTest'
+                      or @Name='testClassesInApiDoNotDependOnClassesInUtil']
+               | //ClassDeclaration[@SimpleName='ImmutabilityTest']
+                    //FieldDeclaration//VariableDeclarator[@Name='CHECKSTYLE_CHECKS']
+               | //ClassDeclaration[@SimpleName='ImmutabilityTest']
+                    //MethodDeclaration[@Name='testUtilClassesImmutability']"/>
+    </properties>
+  </rule>
+  <rule ref="category/java/bestpractices.xml/UnnecessaryVarargsArrayCreation">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='CustomImportOrderCheckTest']
+                    //MethodDeclaration[@Name='testGetFullImportIdent']"/>
+    </properties>
+  </rule>
+
 
   <rule ref="category/java/documentation.xml">
     <!-- We use class comments as source for xdoc files,
@@ -153,6 +211,22 @@
       <property name="checkTopLevelTypes" value="false" />
     </properties>
   </rule>
+  <rule ref="category/java/codestyle.xml/UnnecessaryBoxing">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='IntMatchFilterElement']
+                        //MethodDeclaration[@Name='hashCode']"/>
+    </properties>
+  </rule>
+  <rule ref="category/java/codestyle.xml/CommentDefaultAccessModifier">
+    <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+    <properties>
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='Main']
+                        //EnumDeclaration[@SimpleName='OutputFormat']"/>
+    </properties>
+  </rule>
 
   <rule ref="category/java/errorprone.xml">
     <!-- That rule is not practical, no options to allow some magic numbers,
@@ -192,8 +266,20 @@
     <properties>
       <!-- There is no alternative to using System.exit in the CLI class
            to report the return code. -->
+      <!-- For MainTest.assertMainReturnCode
+            until https://github.com/checkstyle/checkstyle/issues/14870 -->
       <property name="violationSuppressXPath"
-                value="//ClassDeclaration[@SimpleName='ExitHelper']"/>
+                value="//ClassDeclaration[@SimpleName='ExitHelper']
+                 | //ClassDeclaration[@SimpleName='MainTest']
+                    //MethodDeclaration[@Name='assertMainReturnCode'] "/>
+    </properties>
+  </rule>
+  <rule ref="category/java/errorprone.xml/ConstructorCallsOverridableMethod">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='MainFrame']
+                        //ConstructorDeclaration"/>
     </properties>
   </rule>
 
@@ -252,9 +338,13 @@
     <properties>
       <!-- I do not see any problem, looks like a false positive.
            SiteUtil is a utility class providing different functionality. -->
+      <!-- For all Except SiteUtil and HandlerFactory
+          until https://github.com/checkstyle/checkstyle/issues/14870 -->
       <property name="violationSuppressXPath"
                 value="//ClassDeclaration[@SimpleName='HandlerFactory'
-                or @SimpleName='SiteUtil']"/>
+                or @SimpleName='SiteUtil' or @SimpleName='Checker' or @SimpleName='JavaAstVisitor'
+                or @SimpleName='Main' or @SimpleName='TreeWalker' or @SimpleName='CheckstyleAntTask'
+                or @SimpleName='TranslationCheck' or @SimpleName='JavadocMethodCheck']"/>
     </properties>
   </rule>
   <rule ref="category/java/design.xml/NcssCount">
@@ -372,6 +462,13 @@
                     //MethodDeclaration[@Name='getDescriptionFromJavadoc']"/>
     </properties>
   </rule>
+  <rule ref="category/java/design.xml/ClassWithOnlyPrivateConstructorsShouldBeFinal">
+    <properties>
+       <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='AbstractInvalidClass']"/>
+    </properties>
+  </rule>
 
   <rule ref="category/java/multithreading.xml">
     <!-- Checkstyle is not thread safe till https://github.com/checkstyle/checkstyle/projects/5. -->
@@ -395,6 +492,30 @@
     <exclude name="UseStringBufferForStringAppends"/>
   </rule>
 
+  <rule ref="category/java/performance.xml/ConsecutiveAppendsShouldReuse">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='XMLLogger']
+                        //MethodDeclaration[@Name='encode']
+                | //ClassDeclaration[@SimpleName='InlineTagUtil']
+                      //MethodDeclaration[@Name='convertLinesToString']
+                | //ClassDeclaration[@SimpleName='XdocsPagesTest']
+                      //MethodDeclaration[@Name='validateViolationSection']
+                | //ClassDeclaration[@SimpleName='XdocsJavaDocsTest']
+                     //MethodDeclaration[@Name='createPropertiesText'
+                        or @Name='appendNodeText' or @Name='getAttributeText']"/>
+    </properties>
+  </rule>
+  <rule ref="category/java/performance.xml/UseArraysAsList">
+    <properties>
+      <!-- until https://github.com/checkstyle/checkstyle/issues/14870 -->
+      <property name="violationSuppressXPath"
+                value="//ClassDeclaration[@SimpleName='DescriptionExtractor']
+                        //MethodDeclaration[@Name='getDescriptionNodes']"/>
+    </properties>
+  </rule>
+
   <rule ref="category/java/design.xml/ExcessivePublicCount">
     <properties>
       <property name="violationSuppressXPath"
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheckTest.java
index 6c72ae0ecc4..bdadfc7a9bb 100644
--- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheckTest.java
+++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheckTest.java
@@ -818,7 +818,7 @@ public void testClearState() throws Exception {
         assertWithMessage("State is not cleared on beginTree")
                 .that(TestUtil.isStatefulFieldClearedDuringBeginTree(check,
                         staticImport.orElseThrow(), "lastImportStatic",
-                        lastImportStatic -> !((boolean) lastImportStatic)))
+                        lastImportStatic -> !(boolean) lastImportStatic))
                 .isTrue();
 
     }