Update to PMD 7.14 and remove unecessary suppressions

aaime · aaime · commit 067a38cbe001 · 2025-06-07T14:30:18.000+02:00
diff --git a/geowebcache/azureblob/src/test/java/org/geowebcache/azure/tests/online/TemporaryAzureFolder.java b/geowebcache/azureblob/src/test/java/org/geowebcache/azure/tests/online/TemporaryAzureFolder.java
@@ -60,7 +60,6 @@ protected void before() throws Throwable {
     }
 
     @Override
-    @SuppressWarnings("PMD.UseTryWithResources") // client is a field, not created here
     protected void after() {
         if (!isConfigured()) {
             return;
diff --git a/geowebcache/core/src/main/java/org/geowebcache/io/ByteArrayResource.java b/geowebcache/core/src/main/java/org/geowebcache/io/ByteArrayResource.java
@@ -90,7 +90,7 @@ public long getSize() {
 
     /** @see org.geowebcache.io.Resource#transferTo(java.nio.channels.WritableByteChannel) */
     @Override
-    @SuppressWarnings({"PMD.UnusedLocalVariable", "PMD.EmptyControlStatement"})
+    @SuppressWarnings("PMD.EmptyControlStatement")
     public long transferTo(WritableByteChannel channel) throws IOException {
         if (length > 0) {
             ByteBuffer buffer = ByteBuffer.wrap(data, offset, length);
@@ -103,7 +103,7 @@ public long transferTo(WritableByteChannel channel) throws IOException {
 
     /** @see org.geowebcache.io.Resource#transferFrom(java.nio.channels.ReadableByteChannel) */
     @Override
-    @SuppressWarnings({"PMD.UnusedLocalVariable", "PMD.EmptyControlStatement"})
+    @SuppressWarnings("PMD.EmptyControlStatement")
     public long transferFrom(ReadableByteChannel channel) throws IOException {
         if (channel instanceof FileChannel) {
             FileChannel fc = (FileChannel) channel;
diff --git a/geowebcache/core/src/main/java/org/geowebcache/io/FileResource.java b/geowebcache/core/src/main/java/org/geowebcache/io/FileResource.java
@@ -48,7 +48,7 @@ public long getSize() {
     }
 
     @Override
-    @SuppressWarnings({"PMD.UnusedLocalVariable", "PMD.EmptyControlStatement"})
+    @SuppressWarnings("PMD.EmptyControlStatement")
     public long transferTo(WritableByteChannel target) throws IOException {
         // FileLock lock = in.lock();
 
diff --git a/geowebcache/core/src/test/java/org/geowebcache/blobstore/file/FileBlobStoreComformanceTest.java b/geowebcache/core/src/test/java/org/geowebcache/blobstore/file/FileBlobStoreComformanceTest.java
@@ -49,7 +49,6 @@ public void createTestUnit() throws Exception {
 
     private void putLayerMetadataConcurrently(final int srcStoreKey, final FileBlobStore srcStore, int numberOfThreads)
             throws InterruptedException {
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService service = Executors.newFixedThreadPool(numberOfThreads);
         CountDownLatch latch = new CountDownLatch(numberOfThreads);
         for (int i = 0; i < numberOfThreads; i++) {
@@ -72,7 +71,6 @@ private void putLayerMetadataConcurrently(final int srcStoreKey, final FileBlobS
     }
 
     private void executeStoresConcurrently(int numberOfStores, int numberOfThreads) throws InterruptedException {
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService service = Executors.newFixedThreadPool(numberOfStores);
         CountDownLatch latch = new CountDownLatch(numberOfStores);
         for (int i = 0; i < numberOfStores; i++) {
@@ -102,7 +100,6 @@ public void testMetadataWithPointInKey() throws Exception {
     public void testConcurrentMetadataWithPointInKey() throws InterruptedException {
         assertThat(store.getLayerMetadata("testLayer", "test.Key"), nullValue());
         int numberOfThreads = 2;
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService service = Executors.newFixedThreadPool(numberOfThreads);
         CountDownLatch latch = new CountDownLatch(numberOfThreads);
         for (int i = 0; i < numberOfThreads; i++) {
diff --git a/geowebcache/core/src/test/java/org/geowebcache/config/ConfigurationTest.java b/geowebcache/core/src/test/java/org/geowebcache/config/ConfigurationTest.java
@@ -217,7 +217,7 @@ public void testGetExisting() throws Exception {
         assertThat(retrieved, isPresent());
     }
 
-    @SuppressWarnings({"unchecked", "PMD.UnnecessaryCast"})
+    @SuppressWarnings("unchecked")
     @Test
     public void testCantModifyReturnedCollection() throws Exception {
         I info = getGoodInfo("test", 1);
@@ -322,7 +322,6 @@ public void testConcurrentAdds() throws Exception {
                 defaultCount + 10,
                 getInfoNames(config).size());
         // get a thread pool
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService pool =
                 Executors.newFixedThreadPool(16, (Runnable r) -> new Thread(r, "Info Concurrency Test for ADD"));
         // create a bunch of concurrent adds
@@ -364,7 +363,6 @@ public void testConcurrentDeletes() throws Exception {
                 defaultCount + 100,
                 getInfoNames(config).size());
         // get a thread pool
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService pool =
                 Executors.newFixedThreadPool(16, (Runnable r) -> new Thread(r, "Info Concurrency Test for DELETE"));
         // create a bunch of concurrent deletes
@@ -404,7 +402,6 @@ public void testConcurrentModifies() throws Exception {
                 defaultCount + 100,
                 getInfoNames(config).size());
         // get a thread pool
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService pool =
                 Executors.newFixedThreadPool(16, (Runnable r) -> new Thread(r, "Info Concurrency Test for MODIFY"));
         // create a bunch of concurrent modifies
diff --git a/geowebcache/core/src/test/java/org/geowebcache/layer/wms/WMSLayerTest.java b/geowebcache/core/src/test/java/org/geowebcache/layer/wms/WMSLayerTest.java
@@ -546,7 +546,6 @@ private List<ConveyorTile> getTiles(StorageBroker storageBroker, TileRange tr, f
         long[] gridLoc = trIter.nextMetaGridLocation(new long[3]);
 
         // six concurrent requests max
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService requests = Executors.newFixedThreadPool(6);
         ExecutorCompletionService<ConveyorTile> completer = new ExecutorCompletionService<>(requests);
 
diff --git a/geowebcache/core/src/test/java/org/geowebcache/storage/TileRangeIteratorTest.java b/geowebcache/core/src/test/java/org/geowebcache/storage/TileRangeIteratorTest.java
@@ -188,7 +188,6 @@ private long traverseTileRangeIter(
             final int[] metaTilingFactors)
             throws Exception {
 
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         final ExecutorService executorService = Executors.newFixedThreadPool(nThreads);
 
         final TileRange tileRange;
diff --git a/geowebcache/georss/src/main/java/org/geowebcache/georss/GeoRSSReaderFactory.java b/geowebcache/georss/src/main/java/org/geowebcache/georss/GeoRSSReaderFactory.java
@@ -59,7 +59,6 @@ public GeoRSSReader createReader(final URL url, final String username, final Str
             contentEncoding = "UTF-8";
         }
 
-        @SuppressWarnings("PMD.CloseResource") // The stream will be kept open to get new events
         Reader reader =
                 new BufferedReader(new InputStreamReader(response.getEntity().getContent(), contentEncoding));
         if (log.isLoggable(Level.FINE)) {
diff --git a/geowebcache/pmd-ruleset.xml b/geowebcache/pmd-ruleset.xml
@@ -19,13 +19,18 @@ under the License.
 -->
 <ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Default Maven PMD Plugin Ruleset" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
   <description>
-GeoTools ruleset. See https://pmd.github.io/latest/pmd_userdocs_understanding_rulesets.html
+GeoWebCache ruleset. See https://pmd.github.io/pmd/pmd_userdocs_making_rulesets.html
 </description>
   <rule ref="category/java/bestpractices.xml/AvoidUsingHardCodedIP"/>
   <rule ref="category/java/bestpractices.xml/CheckResultSet"/>
   <!--rule ref="category/java/bestpractices.xml/UnusedFormalParameter" /-->
   <rule ref="category/java/bestpractices.xml/UnusedLocalVariable"/>
-  <rule ref="category/java/bestpractices.xml/UnusedPrivateField"/>
+  <rule ref="category/java/bestpractices.xml/UnusedPrivateField">
+    <properties>
+      <!-- The rule ignores fields that are annotated, but we want to check those annotated only with @SuppressWarnings -->
+      <property name="reportForAnnotations" value="java.lang.SuppressWarnings" />
+    </properties>
+  </rule>
   <rule ref="category/java/bestpractices.xml/UnusedPrivateMethod"/>
   <rule ref="category/java/bestpractices.xml/SystemPrintln"/>
   <rule ref="category/java/bestpractices.xml/ForLoopCanBeForeach" />
@@ -45,6 +50,7 @@ GeoTools ruleset. See https://pmd.github.io/latest/pmd_userdocs_understanding_ru
   <rule ref="category/java/bestpractices.xml/UseStandardCharsets" />
   <rule ref="category/java/bestpractices.xml/PrimitiveWrapperInstantiation" /> 
   <rule ref="category/java/bestpractices.xml/UseCollectionIsEmpty" /> 
+  <rule ref="category/java/bestpractices.xml/UnnecessaryWarningSuppression" />
 
   <rule ref="category/java/codestyle.xml/EmptyControlStatement"/>
   <rule ref="category/java/codestyle.xml/UnnecessarySemicolon"/>
diff --git a/geowebcache/pom.xml b/geowebcache/pom.xml
@@ -89,7 +89,7 @@
     <errorProneFlags></errorProneFlags>
     <errorProne.version>2.31.0</errorProne.version>
     <javac.version>9+181-r4173-1</javac.version>
-    <pmd.version>7.13.0</pmd.version>
+    <pmd.version>7.14.0</pmd.version>
     <checkstyle.skip>false</checkstyle.skip>
     <qa>false</qa>
     <lint>deprecation,unchecked</lint>
diff --git a/geowebcache/sqlite/src/test/java/org/geowebcache/sqlite/SqliteConnectionManagerTest.java b/geowebcache/sqlite/src/test/java/org/geowebcache/sqlite/SqliteConnectionManagerTest.java
@@ -146,7 +146,6 @@ private void genericMultiThreadsTest(int threadsNumber, int workersNumber, long
             throws Exception {
         SqliteConnectionManager connectionManager = new SqliteConnectionManager(poolSize, 10);
         connectionManagersToClean.add(connectionManager);
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService executor = Executors.newFixedThreadPool(threadsNumber);
         Random random = new Random();
         List<Future<Tuple<File, String>>> results = new ArrayList<>();
diff --git a/geowebcache/sqlite/src/test/java/org/geowebcache/sqlite/SqlitlePerf.java b/geowebcache/sqlite/src/test/java/org/geowebcache/sqlite/SqlitlePerf.java
@@ -78,7 +78,6 @@ private static void rawSqlitle(File rootDirectory, File seedFile, long[][] tiles
         }
         FileUtils.copyFile(seedFile, databaseFile);
         // submitting the select tasks
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService executor = Executors.newFixedThreadPool(WORKERS);
         long startTime = System.currentTimeMillis();
         try (Connection connection = DriverManager.getConnection("jdbc:sqlite:" + seedFile.getPath())) {
@@ -119,7 +118,6 @@ private static void pooledSqlitle(File rootDirectory, File seedFile, long[][] ti
         }
         FileUtils.copyFile(seedFile, databaseFile);
         // submitting the select tasks
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService executor = Executors.newFixedThreadPool(WORKERS);
         SqliteConnectionManager connectionManager = new SqliteConnectionManager(10, 2000);
         long startTime = System.currentTimeMillis();
@@ -165,7 +163,6 @@ private static void mbtilesStore(File rootDirectory, File seedFile, long[][] til
         }
         FileUtils.copyFile(seedFile, databaseFile);
         // submitting the select tasks
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService executor = Executors.newFixedThreadPool(WORKERS);
         long startTime = System.currentTimeMillis();
         // mbtiles store configuration
@@ -219,7 +216,6 @@ private static void fileStore(File seedDirectory, long[][] tiles) throws Excepti
             LOGGER.info(String.format("Start reading from directory'%s'.", seedDirectory));
         }
         // submitting the read tasks
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ExecutorService executor = Executors.newFixedThreadPool(WORKERS);
         long startTime = System.currentTimeMillis();
         // instantiate the file blobstore
diff --git a/geowebcache/swiftblob/src/test/java/org/geowebcache/swift/SwiftBlobStoreTest.java b/geowebcache/swiftblob/src/test/java/org/geowebcache/swift/SwiftBlobStoreTest.java
@@ -680,7 +680,6 @@ public void deleteByParametersId() {
     @Ignore // unreliable test timing
     public void deleteWhenUploadExists() throws Exception {
         BlockingQueue<Runnable> taskQueue = spy(new LinkedBlockingQueue<>(1000));
-        @SuppressWarnings("PMD.CloseResource") // implements AutoCloseable in Java 21
         ThreadPoolExecutor executor = spy(new ThreadPoolExecutor(
                 1, 1, 60L, TimeUnit.SECONDS, taskQueue, new ThreadPoolExecutor.CallerRunsPolicy()));
 
diff --git a/geowebcache/web/src/test/java/org/geowebcache/jetty/RestIntegrationTest.java b/geowebcache/web/src/test/java/org/geowebcache/jetty/RestIntegrationTest.java
@@ -585,7 +585,7 @@ client, equalTo(401), doc -> {
      * Check that the given request gives a 401 Forbidden when not authenticated, and otherwise has a response matching
      * the given matcher
      */
-    @SuppressWarnings({"PMD.CloseResource", "PMD.UnusedLocalVariable"})
+    @SuppressWarnings("PMD.UnusedLocalVariable")
     protected void testSecured(HttpUriRequest request, Matcher<Integer> authenticatedStatus) throws Exception {
         {
             CloseableHttpClient client = admin.getClient();
diff --git a/geowebcache/wms/src/main/java/org/geowebcache/service/wms/WMSService.java b/geowebcache/wms/src/main/java/org/geowebcache/service/wms/WMSService.java
@@ -491,7 +491,6 @@ protected Collection<String> getDefaultProxyRequestWhitelist() {
         }
     }
 
-    @SuppressWarnings("PMD.UnnecessaryCast")
     protected Collection<String> getProxyRequestWhitelist() {
         return Optional.ofNullable(GeoWebCacheExtensions.getProperty(GEOWEBCACHE_WMS_PROXY_REQUEST_WHITELIST))
                 .map(list -> list.split(";"))

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,6 @@ protected void before() throws Throwable {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`@Override`
`63`		`- @SuppressWarnings("PMD.UseTryWithResources") // client is a field, not created here`
`64`	`63`	`protected void after() {`
`65`	`64`	`if (!isConfigured()) {`
`66`	`65`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public long getSize() {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`@Override`
`51`		`- @SuppressWarnings({"PMD.UnusedLocalVariable", "PMD.EmptyControlStatement"})`
	`51`	`+ @SuppressWarnings("PMD.EmptyControlStatement")`
`52`	`52`	`public long transferTo(WritableByteChannel target) throws IOException {`
`53`	`53`	`// FileLock lock = in.lock();`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,6 @@ public GeoRSSReader createReader(final URL url, final String username, final Str`
`59`	`59`	`contentEncoding = "UTF-8";`
`60`	`60`	`}`
`61`	`61`
`62`		`- @SuppressWarnings("PMD.CloseResource") // The stream will be kept open to get new events`
`63`	`62`	`Reader reader =`
`64`	`63`	`new BufferedReader(new InputStreamReader(response.getEntity().getContent(), contentEncoding));`
`65`	`64`	`if (log.isLoggable(Level.FINE)) {`