Add tests with 100% branch and mutant coverage

Author: Vampire

build.gradle.kts

@@ -21,6 +21,8 @@ plugins {
     net.kautler.jars
     net.kautler.antlr
     net.kautler.osgi
+    net.kautler.tests
+    net.kautler.codenarc
     net.kautler.pmd
     net.kautler.spotbugs
     net.kautler.java9

buildSrc/build.gradle.kts

@@ -20,7 +20,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
     `kotlin-dsl`
-    id("com.github.ben-manes.versions") version "0.22.0"
+    id("com.github.ben-manes.versions") version "0.25.0"
 }
 
 buildscript {
@@ -30,7 +30,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath("com.fasterxml.jackson.core:jackson-databind:2.9.9.3")
+        classpath("com.fasterxml.jackson.core:jackson-databind:2.10.0")
     }
 }
 
@@ -43,18 +43,20 @@ repositories {
 }
 
 dependencies {
-    implementation(gradlePlugin("com.github.ben-manes.versions:0.22.0"))
+    implementation(gradlePlugin("com.github.ben-manes.versions:0.25.0"))
     implementation(gradlePlugin("org.ajoberstar.grgit:3.1.1"))
     implementation(gradlePlugin("com.github.spotbugs:2.0.0"))
     implementation(gradlePlugin("biz.aQute.bnd.builder:4.2.0"))
-    implementation(gradlePlugin("de.marcphilipp.nexus-publish:0.3.1"))
-    implementation(gradlePlugin("io.codearte.nexus-staging:0.21.0"))
+    implementation(gradlePlugin("de.marcphilipp.nexus-publish:0.4.0"))
+    implementation(gradlePlugin("io.codearte.nexus-staging:0.21.1"))
     implementation(gradlePlugin("net.researchgate.release:2.8.1"))
     implementation(gradlePlugin("net.wooga.github:1.4.0"))
-    implementation("com.fasterxml.jackson.core:jackson-databind:2.9.9.3")
-    implementation("com.github.javaparser:javaparser-core:3.14.11")
+    implementation(gradlePlugin("info.solidsoft.pitest:1.4.5"))
+    implementation("com.fasterxml.jackson.core:jackson-databind:2.10.0")
+    implementation("com.github.javaparser:javaparser-core:3.14.159265359")
     implementation("org.kohsuke:github-api:1.95")
-    implementation("net.sf.saxon:Saxon-HE:9.9.1-4")
+    implementation("net.sf.saxon:Saxon-HE:9.9.1-5")
+    implementation("org.pitest:pitest:1.4.10")
 }
 
 kotlinDslPluginOptions {
@@ -70,26 +72,22 @@ tasks.withType<KotlinCompile>().configureEach {
 tasks.dependencyUpdates {
     checkForGradleUpdate = false
 
-    resolutionStrategy {
-        componentSelection {
-            all {
-                if (Regex("""(?i)[.-](?:${listOf(
-                                "alpha",
-                                "beta",
-                                "rc",
-                                "cr",
-                                "m",
-                                "preview",
-                                "test",
-                                "pr",
-                                "pre",
-                                "b",
-                                "ea"
-                        ).joinToString("|")})[.\d-]*""").containsMatchIn(candidate.version)) {
-                    reject("preliminary release")
-                }
-            }
-        }
+    rejectVersionIf {
+        val preliminaryReleaseRegex = Regex("""(?i)[.-](?:${listOf(
+                "alpha",
+                "beta",
+                "rc",
+                "cr",
+                "m",
+                "preview",
+                "test",
+                "pr",
+                "pre",
+                "b",
+                "ea"
+        ).joinToString("|")})[.\d-]*""")
+        preliminaryReleaseRegex.containsMatchIn(candidate.version)
+                && !preliminaryReleaseRegex.containsMatchIn(currentVersion)
     }
 
     outputFormatter = closureOf<Result> {

buildSrc/src/main/kotlin/net/kautler/PropertyExtension.kt

@@ -16,7 +16,25 @@
 
 package net.kautler
 
+import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
+import org.gradle.api.provider.Provider
+import org.gradle.api.provider.SetProperty
 
 @Suppress("UnstableApiUsage")
 operator fun <T> Property<T>.invoke(value: T) = set(value)
+
+@Suppress("UnstableApiUsage")
+operator fun <T> Property<T>.invoke(valueProvider: Provider<out T>) = set(valueProvider)
+
+@Suppress("UnstableApiUsage")
+operator fun <T> ListProperty<T>.invoke(value: Iterable<T>) = set(value)
+
+@Suppress("UnstableApiUsage")
+operator fun <T> ListProperty<T>.invoke(valueProvider: Provider<out Iterable<T>>) = set(valueProvider)
+
+@Suppress("UnstableApiUsage")
+operator fun <T> SetProperty<T>.invoke(value: Iterable<T>) = set(value)
+
+@Suppress("UnstableApiUsage")
+operator fun <T> SetProperty<T>.invoke(valueProvider: Provider<out Iterable<T>>) = set(valueProvider)

buildSrc/src/main/kotlin/net/kautler/codenarc.gradle.kts

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 Bjoern Kautler
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.kautler
+
+plugins {
+    java
+    codenarc
+}
+
+val versions: Map<String, String> by project
+
+codenarc {
+    toolVersion = versions["codenarc"] ?: error("codenarc version is missing")
+    // customized copy from http://codenarc.sourceforge.net/StarterRuleSet-AllRulesByCategory.groovy.txt
+    // update with new rules when version is updated (previous version: 1.4)
+    config = resources.text.fromFile("config/codenarc/codenarc.groovy")
+}
+
+tasks.withType<CodeNarc>().configureEach {
+    val sourceSetName = name.replaceFirst("^codenarc".toRegex(), "").decapitalize()
+    @Suppress("UnstableApiUsage")
+    compilationClasspath = sourceSets[sourceSetName].let {
+        it.runtimeClasspath + it.compileClasspath + project.configurations[it.compileOnlyConfigurationName]
+    }
+
+    @Suppress("UnstableApiUsage")
+    reports.xml.isEnabled = true
+}

buildSrc/src/main/kotlin/net/kautler/java.gradle.kts

@@ -54,7 +54,9 @@ tasks.withType<JavaCompile>().configureEach {
 // delay this action to get the correct version for later configured compile tasks
 afterEvaluate {
     tasks.withType<JavaCompile>().configureEach {
-        if (JavaVersion.current().isJava9Compatible) {
+        // there is a bug in Java 9 that prevents usage of --release
+        // https://bugs.openjdk.java.net/browse/JDK-8139607
+        if (JavaVersion.current().isJava10Compatible) {
             options.compilerArgs.apply {
                 add("--release")
                 add(toVersion(targetCompatibility).majorVersion)

buildSrc/src/main/kotlin/net/kautler/javadoc.gradle.kts

@@ -51,12 +51,12 @@ tasks.withType<Javadoc>().configureEach {
         links!!.apply {
             val versions: Map<String, String> by project
             if (java.targetCompatibility != VERSION_1_8) {
-                throw ConfigurationException("JavaDoc URL for JRE needs to be adapted to new target  compatibility ${java.targetCompatibility}")
+                throw ConfigurationException("JavaDoc URL for JRE needs to be adapted to new target compatibility ${java.targetCompatibility}")
             }
             add("https://docs.oracle.com/javase/8/docs/api/")
-            add("https://www.javadoc.io/page/javax.enterprise/cdi-api/${versions["cdi"]}/")
-            add("https://www.javadoc.io/page/javax.inject/javax.inject/${versions["javax.inject"]}/")
-            add("https://www.javadoc.io/page/org.javacord/javacord-api/${versions["javacord"]}/")
+            add("https://static.javadoc.io/javax.enterprise/cdi-api/${versions["cdi"]}/")
+            add("https://static.javadoc.io/javax.inject/javax.inject/${versions["javax.inject"]}/")
+            add("https://static.javadoc.io/org.javacord/javacord-api/${versions["javacord"]}/")
         }
         isUse = true
         isVersion = true
@@ -67,7 +67,8 @@ tasks.withType<Javadoc>().configureEach {
         if (javaToolChain.isJava9Compatible) {
             addBooleanOption("html5", true)
             addStringOption("-release", java.targetCompatibility.majorVersion)
-            if (javaToolChain.isJava11Compatible) {
+            //TODO: Replace second part with !javaToolChain.isJava13Compatible when supported by Gradle
+            if (javaToolChain.isJava11Compatible && (javaToolChain.ordinal < 12)) {
                 addBooleanOption("-no-module-directories", true)
             }
         } else {

buildSrc/src/main/kotlin/net/kautler/pmd.gradle.kts

@@ -27,9 +27,10 @@ pmd {
     // necessary due to https://github.com/gradle/gradle/issues/8514
     ruleSets.clear()
     ruleSetConfig = resources.text.fromFile("config/pmd/pmd.xml")
+    incrementalAnalysis(true)
 }
 
-tasks.withType<Pmd>().configureEach {
+tasks.named<Pmd>("pmdMain") {
     exclude("net/kautler/command/usage/UsageBaseListener.java")
     exclude("net/kautler/command/usage/UsageBaseVisitor.java")
     exclude("net/kautler/command/usage/UsageLexer.java")

buildSrc/src/main/kotlin/net/kautler/publishing.gradle.kts

@@ -293,6 +293,10 @@ val finishMilestone by tasks.registering {
     }
 }
 
+tasks.beforeReleaseBuild {
+    dependsOn(tasks.named("pitest"))
+}
+
 tasks.publish {
     dependsOn(tasks.closeRepository)
 }

buildSrc/src/main/kotlin/net/kautler/spotbugs.gradle.kts

@@ -24,6 +24,7 @@ import javax.xml.transform.stream.StreamResult
 import javax.xml.transform.stream.StreamSource
 
 plugins {
+    `java-base`
     id("com.github.spotbugs")
 }
 
@@ -41,15 +42,12 @@ spotbugs {
 val spotbugsStylesheets by configurations.registering { isTransitive = false }
 
 dependencies {
-    "spotbugsStylesheets"("com.github.spotbugs:spotbugs:4.0.0-beta3")
+    "spotbugsStylesheets"("com.github.spotbugs:spotbugs:4.0.0-beta4")
     spotbugsPlugins("com.h3xstream.findsecbugs:findsecbugs-plugin:${versions["findsecbugs"]}")
     spotbugsPlugins("com.mebigfatguy.sb-contrib:sb-contrib:${versions["sb-contrib"]}")
 }
 
-//TODO: tasks.register cannot be used within configureEach
-//      replace the following after the task supports multiple output formats natively
-//tasks.withType<SpotBugsTask>().configureEach {
-tasks.withType<SpotBugsTask> spotBugsTask@{
+tasks.named<SpotBugsTask>("spotbugsMain") {
     val excludedClasses = listOf(
             "UsageBaseListener",
             "UsageBaseVisitor",
@@ -65,6 +63,18 @@ tasks.withType<SpotBugsTask> spotBugsTask@{
             }
         }
     }
+}
+
+//TODO: replace the HTML report task after the task supports multiple output formats natively
+//      and change "all" to "configureEach"
+tasks.withType<SpotBugsTask>().all {
+    //TODO: Remove this after upgrading Spotbugs to 4.0.0+ which supports Java 13
+    enabled = JavaVersion.current().ordinal < 12
+
+    val sourceSetName = name.removePrefix("spotbugs").decapitalize()
+    classpath += sourceSets[sourceSetName].let {
+        it.compileClasspath + project.configurations[it.compileOnlyConfigurationName]
+    }
 
     reports {
         xml.isWithMessages = true
@@ -73,8 +83,6 @@ tasks.withType<SpotBugsTask> spotBugsTask@{
     }
 
     finalizedBy(tasks.register("${name}HtmlReport") {
-        dependsOn(this@spotBugsTask)
-
         val stylesheet = reports.html.let { it as CustomizableHtmlReport }.stylesheet!!
         // work-around for https://github.com/gradle/gradle/issues/9648
         //inputs.file(stylesheet.asFile()).withPropertyName("spotbugsStylesheet").withPathSensitivity(NONE)