[UserStory] Integrate SpotBugs into the build.

User Story

Essential components

• Title describes the story
• Stakeholder type is identified
• Outcome is described
• Rationale is explicit
• Acceptance criteria are verifiable and from the perspective of the stakeholder

Story

As a Developer
I want SpotBugs to be integrated into the build
so that I can perform static analysis quality checks to look for bugs in my code.

Acceptance Criteria

• SpotBugs is integrated using the existing build.gradle file.

Supporting Information

Additional information on integrating SpotBugs in Gradle can be found here at gradle.org.

Dependencies

Depends On

Dependents

User story #104

Please assign this issue to @Bitked

[alexrknowles]

Please assign this issue to @alexrknowles

[jody]

Here's an example of a working gradle+SpotBugs implementation:
https://github.com/daggerok/spotbugs-example
It is using older versions of the tools, but may provide useful insights. I note that it works fine for me using Java 8 but that it failed with Java 11.

I just added Spotbugs to another project and it works under Java 11. That build.gradle file has this line added to plugins

id 'com.github.spotbugs' version '4.0.2'

a spotbugs configuration

spotbugs {
  toolVersion = '4.0.2'
  effort = 'max'
  reportLevel = 'low'
  reportsDir = file("$buildDir/reports/spotbugs")
  ignoreFailures = true
}

and a spotbugsMain configuration.

spotbugsMain {
    reports {
        html {
            enabled = true
            destination = file("$buildDir/reports/spotbugs/main.html")
            stylesheet = 'fancy-hist.xsl'
        }
    }
}

This seemed simple enough to be worth trying out for this project as well, so I tossed it into a build.xml and it seemed to work fine at first blush. Please check into this simple implementation and let me know if it's working for you as well.

It turns out that 4.0.2 is the most current version of SpotBugs!

[alexrknowles]

Thank you for the helpful info. I believe my spotbugs configuration was set up wrong. After making adjustments and including the spotbugsMain configuration, using "gradlew check" returns "build successful" after SpotBugs does its check. SpotBugs is also producing reports of any bugs found now.