chore: Fix PMD errorprone rules (#66)

* chore: Fix PMD errorprone rules - AssignmentInOperand * chore: Fix PMD errorprone rules - AvoidDuplicateLiterals * chore: Fix PMD errorprone rules - AvoidFieldNameMatchingTypeName * chore: Fix PMD errorprone rules - CloseResource * chore: minor code enhancement * chore: Fix PMD errorprone rules - TestClassWithoutTestCases * chore: Fix PMD errorprone rules - TestClassWithoutTestCases * chore: Fix PMD errorprone rules - NullAssignment
nordic-institute · Oct 4, 2024 · 71a3be0 · 71a3be0
1 parent 31d4832
commit 71a3be0
Show file tree

Hide file tree

Showing 20 changed files with 42 additions and 22 deletions.
diff --git a/config/pmd/custom-ruleset.xml b/config/pmd/custom-ruleset.xml
@@ -73,15 +73,21 @@
     </rule>
 
     <rule ref="category/java/errorprone.xml">
-        <exclude name="AssignmentInOperand"/>
-        <exclude name="AvoidDuplicateLiterals"/>
-        <exclude name="AvoidFieldNameMatchingTypeName"/>
         <exclude name="AvoidLiteralsInIfCondition"/>
-        <exclude name="CloseResource"/>
         <exclude name="MissingSerialVersionUID"/>
-        <exclude name="NullAssignment"/>
-        <exclude name="TestClassWithoutTestCases"/>
     </rule>
+    <rule ref="category/java/errorprone.xml/AvoidDuplicateLiterals">
+        <properties>
+            <property name="maxDuplicateLiterals" value="10" />
+            <property name="skipAnnotations" value="true" />
+        </properties>
+    </rule>
+    <rule ref="category/java/errorprone.xml/CloseResource">
+        <properties>
+            <property name="allowedResourceTypes" value="java.io.ByteArrayOutputStream,java.io.ByteArrayInputStream,java.io.StringWriter,java.io.CharArrayWriter,java.util.stream.Stream,java.util.stream.IntStream,java.util.stream.LongStream,java.util.stream.DoubleStream,java.util.concurrent.ScheduledExecutorService" />
+        </properties>
+    </rule>
+
 
     <rule ref="category/java/multithreading.xml">
         <exclude name="AvoidSynchronizedAtMethodLevel"/>

diff --git a/...catalog-collector/src/main/java/fi/dvv/xroad/catalog/collector/util/OrganizationUtil.java b/...catalog-collector/src/main/java/fi/dvv/xroad/catalog/collector/util/OrganizationUtil.java
@@ -85,8 +85,6 @@
 import java.security.KeyManagementException;
 import java.security.KeyStoreException;
 import java.security.NoSuchAlgorithmException;
-import java.security.cert.CertificateException;
-import java.security.cert.X509Certificate;
 import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.util.ArrayList;
@@ -610,15 +608,10 @@ private static <T> T getResponseBody(String url, Class<T> returnType) {
         return response.getBody();
     }
 
+    @SuppressWarnings("PMD.CloseResource")
     private static RestTemplate createTemplate() {
         try {
-            TrustStrategy acceptingTrustStrategy = new TrustStrategy() {
-                @Override
-                public boolean isTrusted(X509Certificate[] x509Certificates, String s)
-                        throws CertificateException {
-                    return true;
-                }
-            };
+            TrustStrategy acceptingTrustStrategy = (x509Certificates, s) -> true;
             SSLContext sslContext = SSLContexts.custom()
                     .loadTrustMaterial(null, acceptingTrustStrategy)
                     .build();

diff --git a/xroad-catalog-collector/src/main/java/org/niis/xroad/catalog/collector/util/XRoadClient.java b/xroad-catalog-collector/src/main/java/org/niis/xroad/catalog/collector/util/XRoadClient.java
@@ -204,6 +204,7 @@ public String getWsdl(XRoadServiceIdentifierType service, CatalogService catalog
 
         if (!(wsdl.value instanceof byte[])) {
             DataHandler dh = null;
+            @SuppressWarnings("PMD.CloseResource")
             final Client client = ClientProxy.getClient(metaServicesPort);
             @SuppressWarnings("unchecked") final Collection<Attachment> attachments = (Collection<Attachment>) client.getResponseContext()
                     .get(Message.ATTACHMENTS);

diff --git a/...d-catalog-collector/src/test/java/fi/dvv/xroad/catalog/collector/mock/MockHttpServer.java b/...d-catalog-collector/src/test/java/fi/dvv/xroad/catalog/collector/mock/MockHttpServer.java
@@ -112,19 +112,21 @@ public ResourceToHttpHandler(String fileName) {
             this.fileName = fileName;
         }
 
+        @SuppressWarnings("PMD.AssignmentInOperand")
         @Override
         public void handle(HttpExchange exchange) throws IOException {
             ClassPathResource resource = new ClassPathResource(fileName);
-            InputStream is = resource.getInputStream();
             exchange.getResponseHeaders().add("Content-Type", "application/xml");
             exchange.sendResponseHeaders(200, 0);
-            OutputStream os = exchange.getResponseBody();
-            byte[] buffer = new byte[1024];
-            int len;
-            while ((len = is.read(buffer)) != -1) {
-                os.write(buffer, 0, len);
+            try (InputStream is = resource.getInputStream();
+                 OutputStream os = exchange.getResponseBody()) {
+
+                byte[] buffer = new byte[1024];
+                int len;
+                while ((len = is.read(buffer)) != -1) {
+                    os.write(buffer, 0, len);
+                }
             }
-            os.close();
         }
     }
 }
diff --git a/...og-collector/src/test/java/fi/dvv/xroad/catalog/collector/service/CompanyServiceTest.java b/...og-collector/src/test/java/fi/dvv/xroad/catalog/collector/service/CompanyServiceTest.java
@@ -56,6 +56,7 @@
 @SpringBootTest(classes =  CollectorApplication.class)
 @ActiveProfiles("test")
 @Transactional
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 public class CompanyServiceTest {
 
     @Autowired

diff --git a/...llector/src/test/java/fi/dvv/xroad/catalog/collector/service/OrganizationServiceTest.java b/...llector/src/test/java/fi/dvv/xroad/catalog/collector/service/OrganizationServiceTest.java
@@ -60,6 +60,7 @@
 @SpringBootTest(classes = CollectorApplication.class)
 @ActiveProfiles("test")
 @Transactional
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 public class OrganizationServiceTest {
 
     @Autowired

diff --git a/xroad-catalog-collector/src/test/java/org/niis/xroad/catalog/collector/TestUtil.java b/xroad-catalog-collector/src/test/java/org/niis/xroad/catalog/collector/TestUtil.java
@@ -47,6 +47,7 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 
 @Component
+@SuppressWarnings("PMD.TestClassWithoutTestCases")
 public class TestUtil {
 
     @Autowired

diff --git a/...or/src/test/java/org/niis/xroad/catalog/collector/configuration/TestingConfiguration.java b/...or/src/test/java/org/niis/xroad/catalog/collector/configuration/TestingConfiguration.java
@@ -40,6 +40,7 @@
 
 @Configuration
 @Slf4j
+@SuppressWarnings("PMD.TestClassWithoutTestCases")
 public class TestingConfiguration {
 
     @Bean

diff --git a/...g-collector/src/test/java/org/niis/xroad/catalog/collector/tasks/ListClientsTaskTest.java b/...g-collector/src/test/java/org/niis/xroad/catalog/collector/tasks/ListClientsTaskTest.java
@@ -57,6 +57,7 @@
 
 @SpringBootTest(classes = CollectorApplication.class)
 @ActiveProfiles("test")
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 public class ListClientsTaskTest {
 
     @Autowired

diff --git a/xroad-catalog-lister/src/main/java/org/niis/xroad/catalog/lister/dto/Email.java b/xroad-catalog-lister/src/main/java/org/niis/xroad/catalog/lister/dto/Email.java
@@ -39,6 +39,7 @@
 @EqualsAndHashCode
 @Getter
 @Setter
+@SuppressWarnings("PMD.AvoidFieldNameMatchingTypeName")
 public class Email implements Serializable {
 
     private static final long serialVersionUID = 4049961366368846285L;

diff --git a/xroad-catalog-lister/src/main/java/org/niis/xroad/catalog/lister/dto/MemberDataList.java b/xroad-catalog-lister/src/main/java/org/niis/xroad/catalog/lister/dto/MemberDataList.java
@@ -41,6 +41,7 @@
 @EqualsAndHashCode
 @Getter
 @Setter
+@SuppressWarnings("PMD.AvoidFieldNameMatchingTypeName")
 public class MemberDataList implements Serializable {
 
     private static final long serialVersionUID = 4049561366368846285L;

diff --git a/...atalog-lister/src/main/java/org/niis/xroad/catalog/lister/dto/SecurityServerDataList.java b/...atalog-lister/src/main/java/org/niis/xroad/catalog/lister/dto/SecurityServerDataList.java
@@ -40,6 +40,7 @@
 @EqualsAndHashCode
 @Getter
 @Setter
+@SuppressWarnings("PMD.AvoidFieldNameMatchingTypeName")
 public class SecurityServerDataList implements Serializable {
 
     private static final long serialVersionUID = 4049561366368846285L;

diff --git a/...atalog-lister/src/main/java/org/niis/xroad/catalog/lister/service/CatalogServiceImpl.java b/...atalog-lister/src/main/java/org/niis/xroad/catalog/lister/service/CatalogServiceImpl.java
@@ -64,6 +64,7 @@
  */
 @Component
 @Transactional
+@SuppressWarnings("PMD.AvoidFieldNameMatchingTypeName")
 public class CatalogServiceImpl implements CatalogService {
 
     private static final String MULTIPLE_MATCHES_FOUND_TO = "multiple matches found to ";

diff --git a/xroad-catalog-lister/src/test/java/fi/dvv/xroad/catalog/lister/ApplicationTests.java b/xroad-catalog-lister/src/test/java/fi/dvv/xroad/catalog/lister/ApplicationTests.java
@@ -98,6 +98,7 @@
 @SpringBootTest(classes = ListerApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
 @ActiveProfiles("test")
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 public class ApplicationTests {
 
     private final Jaxb2Marshaller marshaller = new Jaxb2Marshaller();

diff --git a/xroad-catalog-lister/src/test/java/org/niis/xroad/catalog/lister/TestUtil.java b/xroad-catalog-lister/src/test/java/org/niis/xroad/catalog/lister/TestUtil.java
@@ -37,6 +37,7 @@
 import java.util.stream.StreamSupport;
 
 @Component
+@SuppressWarnings("PMD.TestClassWithoutTestCases")
 public final class TestUtil {
 
     @Autowired

diff --git a/...lister/src/test/java/org/niis/xroad/catalog/lister/controller/ServiceControllerTests.java b/...lister/src/test/java/org/niis/xroad/catalog/lister/controller/ServiceControllerTests.java
@@ -69,6 +69,7 @@
 @SpringBootTest(classes = ListerApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
 @TestPropertySource(properties = { "xroad-catalog.shared-params-file=src/test/resources/shared-params.xml" })
 @ActiveProfiles("test")
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 public class ServiceControllerTests {
 
     private static final String XROAD_INSTANCE = "DEV";

diff --git a/...d-catalog-persistence/src/main/java/fi/dvv/xroad/catalog/persistence/entity/Language.java b/...d-catalog-persistence/src/main/java/fi/dvv/xroad/catalog/persistence/entity/Language.java
@@ -53,6 +53,7 @@
 @ToString(exclude = { "company" })
 @EqualsAndHashCode(exclude = { "id", "company", "statusInfo" })
 @Builder
+@SuppressWarnings("PMD.AvoidFieldNameMatchingTypeName")
 public class Language {
 
     @Id

diff --git a/...talog-persistence/src/main/java/org/niis/xroad/catalog/persistence/entity/StatusInfo.java b/...talog-persistence/src/main/java/org/niis/xroad/catalog/persistence/entity/StatusInfo.java
@@ -59,6 +59,7 @@ public StatusInfo() {
         // Empty contructor
     }
 
+    @SuppressWarnings("PMD.NullAssignment")
     public void setTimestampsForSaved(LocalDateTime timestamp, boolean isModified) {
         if (removed != null) {
             changed = timestamp;
@@ -74,6 +75,7 @@ public boolean isRemoved() {
         return removed != null;
     }
 
+    @SuppressWarnings("PMD.NullAssignment")
     public void setTimestampsForFetched(LocalDateTime timestamp) {
         if (isRemoved()) {
             // resurrect this item
@@ -86,6 +88,7 @@ public void setTimestampsForFetched(LocalDateTime timestamp) {
         }
     }
 
+    @SuppressWarnings("PMD.NullAssignment")
     public void setTimestampsForNew(LocalDateTime timestamp) {
         created = timestamp;
         changed = timestamp;

diff --git a/xroad-catalog-persistence/src/test/java/fi/dvv/xroad/catalog/persistence/TestUtil.java b/xroad-catalog-persistence/src/test/java/fi/dvv/xroad/catalog/persistence/TestUtil.java
@@ -36,6 +36,7 @@
 import java.util.stream.StreamSupport;
 
 @Component
+@SuppressWarnings("PMD.TestClassWithoutTestCases")
 public class TestUtil {
 
     @Autowired

diff --git a/...ce/src/test/java/org/niis/xroad/catalog/persistence/repository/ServiceRepositoryTest.java b/...ce/src/test/java/org/niis/xroad/catalog/persistence/repository/ServiceRepositoryTest.java
@@ -40,6 +40,7 @@
 
 @SpringBootTest
 @ActiveProfiles("test")
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 public class ServiceRepositoryTest {
 
     @Autowired
-Original file line number
+Diff line change
@@ Expand Up / @@ -40,6 +40,7 @@ @@
     @Configuration
     @Slf4j
+    @SuppressWarnings("PMD.TestClassWithoutTestCases")
     public class TestingConfiguration {
         @Bean
@@ Expand Down @@