Merge pull request #486 from cloudant/jenkins-spotbugs

Jenkins spotbugs

Author: ricellis

Jenkinsfile

@@ -57,15 +57,15 @@ stage('QA') {
 
     // Standard builds do Findbugs and test against Cloudant
     def axes = [
-            Findbugs:
+            Spotbugs:
                     {
                         node {
                             unstash name: 'built'
-                            // findBugs
+                            // Spotbugs
                             try {
-                                sh './gradlew -Dfindbugs.xml.report=true findbugsMain'
+                                sh './gradlew -Dspotbugs.xml.report=true spotbugsMain'
                             } finally {
-                                step([$class: 'FindBugsPublisher', pattern: '**/build/reports/findbugs/*.xml'])
+                                recordIssues enabledForFailure: true, tool: spotBugs(pattern: '**/build/reports/spotbugs/*.xml')
                             }
                         }
                     },

build.gradle

@@ -12,6 +12,10 @@
  * and limitations under the License.
  */
 
+plugins {
+    id "com.github.spotbugs" version "2.0.0" apply false
+}
+
 subprojects {
     apply plugin: 'java'
     apply plugin: 'maven'
@@ -175,24 +179,24 @@ subprojects {
     }
 
     // Findbugs
-    apply plugin: 'findbugs'
-    findbugs {
-        toolVersion = "3.0.1"
+    apply plugin: 'com.github.spotbugs'
+    spotbugs {
+        toolVersion = "3.1.12"
         // Report only high severity bugs for now
         reportLevel = "low"
         // The code base is pretty small so use max effort
         effort = "max"
         // We don't want to run findbugs on the test code yet
         sourceSets = [sourceSets.main]
         // Exclude a couple of known bugs until we get the chance to fix them
-        if (file("findbugs_excludes.xml").exists()) {
-            excludeFilter = file("findbugs_excludes.xml")
+        if (file("spotbugs_excludes.xml").exists()) {
+            excludeFilter = file("spotbugs_excludes.xml")
         }
     }
 
-    tasks.withType(FindBugs) {
+    tasks.withType(com.github.spotbugs.SpotBugsTask) {
         // Currently only one report type can be used toggle which with a property
-        boolean generateXML = Boolean.getBoolean("findbugs.xml.report")
+        boolean generateXML = Boolean.getBoolean("spotbugs.xml.report")
         reports {
             xml.enabled = generateXML
             html.enabled = !generateXML

cloudant-client/build.gradle

@@ -12,18 +12,10 @@
  * and limitations under the License.
  */
 
-// Additional configurations for javadoc
-configurations {
-    linkableJavadoc {
-        transitive false
-    }
-}
-
 dependencies {
     compile group: 'com.google.code.gson', name: 'gson', version: '2.8.2'
     compile group: 'commons-codec', name: 'commons-codec', version: '1.6'
     compile project(':cloudant-http')
-    linkableJavadoc project(':cloudant-http')
     //test dependencies
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.0'
@@ -37,25 +29,15 @@ javadoc {
     options.overview = "overview.html"
     include("**/lightcouch/*Exception.java",
             "**/client/api/**")
+    // Resolve the links to the cloudant-http project javadoc
+    options.linksOffline("http://static.javadoc.io/com.cloudant/cloudant-http/${project.version}","${project.rootProject.rootDir}/cloudant-http/build/docs/javadoc");
 }
 
 javadocJar {
     // Include the logging.properties example
     from rootProject.rootDir.path + '/logging.properties'
 }
 
-gradle.projectsEvaluated {
-    javadoc {
-        // Add the offline link options for the client API pointing to javadoc.io using the resolved
-        // java-cloudant version. Use the package-list from the javadoc zip file.
-        configurations.linkableJavadoc.each {
-            String moduleName = configurations.linkableJavadoc.resolvedConfiguration.firstLevelModuleDependencies.first().moduleName;
-            String moduleVers = configurations.linkableJavadoc.resolvedConfiguration.firstLevelModuleDependencies.first().moduleVersion;
-            options.linksOffline("http://static.javadoc.io/com.cloudant/$moduleName/$moduleVers","../$moduleName/build/docs/javadoc");
-        }
-    }
-}
-
 // we need Java 1.8 features for JUnit 5 features, but our production code is 1.6
 compileTestJava {
     sourceCompatibility = 1.8

cloudant-client/findbugs_excludes.xml cloudant-client/spotbugs_excludes.xmlcloudant-client/findbugs_excludes.xml renamed to cloudant-client/spotbugs_excludes.xml

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