Merge pull request #587 from tamird/annotations

Add spotbugs and correct found problems

.github/workflows/test.yml

@@ -16,4 +16,4 @@ jobs:
           java-version: '17'
           distribution: 'temurin'
       - name: Test with Gradle
-        run: ./gradlew build
+        run: ./gradlew check

build.gradle

@@ -1,25 +1,26 @@
 plugins {
     id "application"
     id "checkstyle"
+    id "com.github.spotbugs" version "5.0.6"
     id "idea"
     id "java-library"
-    id "org.openjfx.javafxplugin" version "0.0.11"
     id "org.beryx.jlink" version "2.20.0"
+    id "org.openjfx.javafxplugin" version "0.0.11"
 }
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    implementation "org.apache.commons:commons-csv:1.8"
-    implementation "org.apache.poi:poi-ooxml:4.1.2"
-    implementation "com.fasterxml.jackson.core:jackson-core:2.11.1"
-    implementation "com.fasterxml.jackson.core:jackson-annotations:2.11.1"
-    implementation "com.fasterxml.jackson.core:jackson-databind:2.11.1"
-    implementation "com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.11.1"
-    testImplementation "org.junit.jupiter:junit-jupiter-api:5.6.2"
-    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.6.2"
+    implementation 'org.apache.commons:commons-csv:1.9.0'
+    implementation 'org.apache.poi:poi-ooxml:5.2.2'
+    implementation 'com.fasterxml.jackson.core:jackson-core:2.13.2'
+    implementation 'com.fasterxml.jackson.core:jackson-annotations:2.13.2'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.2.2'
+    implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.13.2'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.2'
 }
 
 // ### Application plugin settings
@@ -35,15 +36,22 @@ application {
 
 // ### Checkstyle plugin settings
 checkstyle {
-    toolVersion = "8.36.2"
+    toolVersion = '10.2'
     // Keep the below file updated along with subsequent versions of Checkstyle (make sure to choose
     // the tag matching the toolVersion above):
-    // https://github.com/checkstyle/checkstyle/blob/checkstyle-8.36.2/src/main/resources/google_checks.xml
+    // https://github.com/checkstyle/checkstyle/blob/checkstyle-10.2/src/main/resources/google_checks.xml
     configFile = file("$projectDir/config/checkstyle/google_checks.xml")
+    maxWarnings = 0
+    ignoreFailures = false
 }
-System.setProperty( "org.checkstyle.google.suppressionfilter.config",
+System.setProperty("org.checkstyle.google.suppressionfilter.config",
         "$projectDir/config/checkstyle/checkstyle-suppressions.xml")
 
+spotbugs {
+    toolVersion = '4.6.0'
+    excludeFilter = file("config/spotbugs/exclude.xml")
+}
+
 // ### Idea plugin settings
 idea {
     module {
@@ -52,11 +60,10 @@ idea {
 }
 
 // ### Java plugin settings
-sourceCompatibility = JavaVersion.VERSION_17
-
-compileJava.dependsOn(clean)
-compileJava {
-    options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation"
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
 }
 
 test {

config/spotbugs/exclude.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<FindBugsFilter
+    xmlns="https://github.com/spotbugs/filter/4.6.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  xsi:schemaLocation="https://raw.githubusercontent.com/spotbugs/spotbugs/4.6.0/spotbugs/etc/findbugsfilter.xsd">
+  <Match>
+    <Class name="~network\.brightspots\.rcv\.(HartCvrReader\$(Contest|Option|PrecinctSplit)|RawContestConfig\$ContestRules)"/>
+    <Bug code="UwF"/>
+  </Match>
+  <Match>
+    <Class name="~network\.brightspots\.rcv\.HartCvrReader\$(Party|Contest|WriteInData|Option)"/>
+    <Bug code="UuF"/>
+  </Match>
+  <Match>
+    <Class name="network.brightspots.rcv.HartCvrReader"/>
+    <Method name="readCastVoteRecord"/>
+    <Bug code="NP"/>
+  </Match>
+</FindBugsFilter>

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists