fix spotbugs static analyzer

ben-manes · Oct 15, 2023 · 0749c37 · 0749c37
1 parent 8f161f3
commit 0749c37
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 33 deletions.
diff --git a/gradle/config/pmd/rulesSets.xml b/gradle/config/pmd/rulesSets.xml
@@ -21,13 +21,13 @@
   <rule ref="category/java/bestpractices.xml/LooseCoupling">
     <properties>
       <property name="allowedTypes" value="
-        java.util.Properties
-        ,java.util.concurrent.ConcurrentHashMap
-        ,com.google.common.collect.ImmutableMap
-        ,com.google.common.collect.ImmutableSet
-        ,com.google.common.collect.ImmutableList
-        ,com.github.benmanes.caffeine.cache.BoundedLocalCache
-        ,com.github.benmanes.caffeine.cache.UnboundedLocalCache
+        java.util.Properties,
+        java.util.concurrent.ConcurrentHashMap,
+        com.google.common.collect.ImmutableMap,
+        com.google.common.collect.ImmutableSet,
+        com.google.common.collect.ImmutableList,
+        com.github.benmanes.caffeine.cache.BoundedLocalCache,
+        com.github.benmanes.caffeine.cache.UnboundedLocalCache
       "/>
     </properties>
   </rule>

diff --git a/gradle/config/spotbugs/exclude.xml b/gradle/config/spotbugs/exclude.xml
@@ -13,6 +13,7 @@
       CFS_CONFUSING_FUNCTION_SEMANTICS,
       CLI_CONSTANT_LIST_INDEX,
       CNC_COLLECTION_NAMING_CONFUSION,
+      CT_CONSTRUCTOR_THROW,
       DMI_RANDOM_USED_ONLY_ONCE,
       EI_EXPOSE_REP, EI_EXPOSE_REP2,
       ENMI_EQUALS_ON_ENUM,
@@ -39,6 +40,8 @@
       OI_OPTIONAL_ISSUES_CHECKING_REFERENCE,
       OPM_OVERLY_PERMISSIVE_METHOD,
       PCOA_PARTIALLY_CONSTRUCTED_OBJECT_ACCESS,
+      PI_DO_NOT_REUSE_PUBLIC_IDENTIFIERS_CLASS_NAMES,
+      PI_DO_NOT_REUSE_PUBLIC_IDENTIFIERS_FIELD_NAMES,
       PIS_POSSIBLE_INCOMPLETE_SERIALIZATION,
       PL_PARALLEL_LISTS,
       PMB_INSTANCE_BASED_THREAD_LOCAL,
@@ -54,6 +57,8 @@
       THROWS_METHOD_THROWS_RUNTIMEEXCEPTION,
       THROWS_METHOD_THROWS_CLAUSE_BASIC_EXCEPTION,
       URV_UNRELATED_RETURN_VALUES,
+      UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD,
+      UWF_UNWRITTEN_FIELD,
       USBR_UNNECESSARY_STORE_BEFORE_RETURN,
       UTWR_USE_TRY_WITH_RESOURCES,
       UVA_USE_VAR_ARGS,
@@ -214,10 +219,27 @@
     <Class name="com.github.benmanes.caffeine.cache.WriteThroughEntry"/>
     <Bug pattern="EQ_DOESNT_OVERRIDE_EQUALS"/>
   </Match>
+  <Match>
+    <Or>
+      <Class name="~.*FD.*"/>
+      <Class name="~.*FS.*"/>
+      <Class name="~.*FW.*"/>
+      <Class name="~.*PD.*"/>
+      <Class name="~.*PS.*"/>
+      <Class name="~.*PW.*"/>
+    </Or>
+    <Bug pattern="NP_UNWRITTEN_FIELD"/>
+  </Match>
   <Match>
     <Or>
       <Class name="~.*Mpsc.*"/>
       <Class name="~.*Header.*"/>
+      <Class name="~.*FD.*"/>
+      <Class name="~.*FS.*"/>
+      <Class name="~.*FW.*"/>
+      <Class name="~.*PD.*"/>
+      <Class name="~.*PS.*"/>
+      <Class name="~.*PW.*"/>
     </Or>
     <Bug pattern="UUF_UNUSED_FIELD"/>
   </Match>
@@ -226,6 +248,11 @@
     <Method name="main"/>
     <Bug pattern="PATH_TRAVERSAL_IN"/>
   </Match>
+  <Match>
+    <Class name="com.github.benmanes.caffeine.cache.LocalCacheFactoryGenerator"/>
+    <Method name="reformat"/>
+    <Bug pattern="DM_DEFAULT_ENCODING"/>
+  </Match>
   <Match>
     <Class name="com.github.benmanes.caffeine.cache.LocalCacheFactoryGenerator"/>
     <Method name="reformat"/>
@@ -236,11 +263,21 @@
     <Method name="main"/>
     <Bug pattern="PATH_TRAVERSAL_IN"/>
   </Match>
+  <Match>
+    <Class name="com.github.benmanes.caffeine.cache.NodeFactoryGenerator"/>
+    <Method name="reformat"/>
+    <Bug pattern="DM_DEFAULT_ENCODING"/>
+  </Match>
   <Match>
     <Class name="com.github.benmanes.caffeine.cache.NodeFactoryGenerator"/>
     <Method name="reformat"/>
     <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
   </Match>
+  <Match>
+    <Class name="com.github.benmanes.caffeine.cache.NodeFactoryGenerator"/>
+    <Method name="reformat"/>
+    <Bug pattern="DM_DEFAULT_ENCODING"/>
+  </Match>
   <Match>
     <Class name="~com.github.benmanes.caffeine.*Benchmark.*"/>
     <Bug pattern="PREDICTABLE_RANDOM"/>

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -81,7 +81,7 @@ snakeyaml = "2.2"
 sonarqube = "4.4.1.3373"
 spotbugs-contrib = "7.6.0"
 spotbugs-core = "4.8.0"
-spotbugs-plugin = "6.0.0-beta.4"
+spotbugs-plugin = "6.0.0-beta.5"
 stream = "2.9.8"
 tcache = "2.0.1"
 testng = "7.8.0"

diff --git a/gradle/plugins/src/main/kotlin/quality/spotbugs-caffeine-conventions.gradle.kts b/gradle/plugins/src/main/kotlin/quality/spotbugs-caffeine-conventions.gradle.kts
@@ -20,14 +20,12 @@ spotbugs {
 }
 
 tasks.withType<SpotBugsTask>().configureEach {
+  inputs.property("version", libs.versions.spotbugs.core.get())
   enabled = System.getProperties().containsKey("spotbugs")
   group = "SpotBugs"
   reports {
     create("html") {
       required = true
     }
-    create("sarif") {
-      required = true
-    }
   }
 }
diff --git a/...main/java/com/github/benmanes/caffeine/cache/simulator/admission/tinycache/TinyCache.java b/...main/java/com/github/benmanes/caffeine/cache/simulator/admission/tinycache/TinyCache.java
@@ -52,19 +52,19 @@ public boolean contains(long item) {
     }
     indexing.getChain(hashFunc.fpaux, chainIndex, lastIndex);
     int offset = itemsPerSet * hashFunc.fpaux.set;
-    indexing.chainStart += offset;
-    indexing.chainEnd += offset;
+    indexing.setChainStart(indexing.getChainStart() + offset);
+    indexing.setChainEnd(indexing.getChainEnd() + offset);
 
     // Gil: I will carefully examine this function when I have time.
     // As far as I understand it is working right now.
-    while (indexing.chainStart <= indexing.chainEnd) {
+    while (indexing.getChainStart() <= indexing.getChainEnd()) {
       try {
-        if (cache[indexing.chainStart % cache.length] == hashFunc.fpaux.value) {
+        if (cache[indexing.getChainStart() % cache.length] == hashFunc.fpaux.value) {
           return true;
         }
-        indexing.chainStart++;
+        indexing.setChainStart(indexing.getChainStart() + 1);
       } catch (RuntimeException e) {
-        System.out.println("length: " + cache.length + " Access: " + indexing.chainStart);
+        System.out.println("length: " + cache.length + " Access: " + indexing.getChainStart());
       }
     }
     return false;

diff --git a/...ava/com/github/benmanes/caffeine/cache/simulator/admission/tinycache/TinyCacheSketch.java b/...ava/com/github/benmanes/caffeine/cache/simulator/admission/tinycache/TinyCacheSketch.java
@@ -52,21 +52,21 @@ public int countItem(long item) {
     }
     indexing.getChain(hashFunc.fpaux, chainIndex, lastIndex);
     int offset = itemsPerSet * hashFunc.fpaux.set;
-    indexing.chainStart += offset;
-    indexing.chainEnd += offset;
+    indexing.setChainStart(indexing.getChainStart() + offset);
+    indexing.setChainEnd(indexing.getChainEnd() + offset);
 
     // Gil : I think some of these tests are, I till carefully examine this function when I have
     // time. As far as I understand it is working right now.
     int count = 0;
-    while (indexing.chainStart <= indexing.chainEnd) {
+    while (indexing.getChainStart() <= indexing.getChainEnd()) {
       try {
-        if (cache[indexing.chainStart % cache.length] == hashFunc.fpaux.fingerprint) {
+        if (cache[indexing.getChainStart() % cache.length] == hashFunc.fpaux.fingerprint) {
           count++;
         }
-        indexing.chainStart++;
+        indexing.setChainStart(indexing.getChainStart() + 1);
 
       } catch (RuntimeException e) {
-        System.out.println("length: " + cache.length + " Access: " + indexing.chainStart);
+        System.out.println("length: " + cache.length + " Access: " + indexing.getChainStart());
       }
     }
     return count;

diff --git a/...github/benmanes/caffeine/cache/simulator/admission/tinycache/TinyCacheWithGhostCache.java b/...github/benmanes/caffeine/cache/simulator/admission/tinycache/TinyCacheWithGhostCache.java
@@ -56,19 +56,19 @@ public boolean contains(long item) {
     }
     indexing.getChain(hashFunc.fpaux, chainIndex, lastIndex);
     int offset = itemsPerSet * hashFunc.fpaux.set;
-    indexing.chainStart += offset;
-    indexing.chainEnd += offset;
+    indexing.setChainStart(indexing.getChainStart() + offset);
+    indexing.setChainEnd(indexing.getChainEnd() + offset);
 
     // Gil : I think some of these tests are, I till carefully examine this function when I have
     // time. As far as I understand it is working right now.
-    while (indexing.chainStart <= indexing.chainEnd) {
+    while (indexing.getChainStart() <= indexing.getChainEnd()) {
       try {
-        if (cache[indexing.chainStart % cache.length] == hashFunc.fpaux.value) {
+        if (cache[indexing.getChainStart() % cache.length] == hashFunc.fpaux.value) {
           return true;
         }
-        indexing.chainStart++;
+        indexing.setChainStart(indexing.getChainStart() + 1);
       } catch (RuntimeException e) {
-        System.out.println("length: " + cache.length + " Access: " + indexing.chainStart);
+        System.out.println("length: " + cache.length + " Access: " + indexing.getChainStart());
       }
     }
     return false;

diff --git a/...ava/com/github/benmanes/caffeine/cache/simulator/admission/tinycache/TinySetIndexing.java b/...ava/com/github/benmanes/caffeine/cache/simulator/admission/tinycache/TinySetIndexing.java
@@ -34,8 +34,8 @@
  */
 final class TinySetIndexing {
   // for performance - for functions that need to know both the start and the end of the chain.
-  public int chainStart;
-  public int chainEnd;
+  private int chainStart;
+  private int chainEnd;
 
   public int getChainStart(HashedItem fpaux, long[] chainIndex, long[] isLastIndex) {
     int requiredChainNumber = rank(chainIndex[fpaux.set], fpaux.chainId);
@@ -66,13 +66,13 @@ public int getChain(HashedItem fpaux, long[] chainIndex, long[] isLastIndex) {
       currentOffset++;
       tempisLastIndex >>>= 1;
     }
-    chainStart = currentOffset;
+    setChainStart(currentOffset);
 
     while ((tempisLastIndex & 1L) == 0) {
       currentOffset++;
       tempisLastIndex >>>= 1;
     }
-    chainEnd = currentOffset;
+    setChainEnd(currentOffset);
     return currentOffset;
   }
 
@@ -136,4 +136,20 @@ public void removeItem(HashedItem fpaux, long[] chainIndex, long[] isLastIndex)
     // update isLastIndex.
     isLastIndex[fpaux.set] = shrinkOffset(isLastIndex[fpaux.set], chainStart);
   }
+
+  public int getChainStart() {
+    return chainStart;
+  }
+
+  public void setChainStart(int chainStart) {
+    this.chainStart = chainStart;
+  }
+
+  public int getChainEnd() {
+    return chainEnd;
+  }
+
+  public void setChainEnd(int chainEnd) {
+    this.chainEnd = chainEnd;
+  }
 }