Refine the consistency check task for defined versions

Author: jjohannes

gradle/plugins/src/main/kotlin/org/example/gradle/tasks/JavaVersionConsistencyCheck.kt

@@ -4,6 +4,7 @@ import org.gradle.api.DefaultTask
 import org.gradle.api.artifacts.component.ModuleComponentIdentifier
 import org.gradle.api.artifacts.result.ResolvedComponentResult
 import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.SetProperty
 import org.gradle.api.tasks.Input
@@ -16,35 +17,35 @@ abstract class JavaVersionConsistencyCheck : DefaultTask() {
 
     @get:Input abstract val aggregatedClasspath: SetProperty<ResolvedComponentResult>
 
+    @get:Input abstract val excludes: ListProperty<String>
+
     @get:OutputFile abstract val reportFile: RegularFileProperty
 
     @TaskAction
     fun compare() {
-        var potentiallyUnusedVersion = ""
-        var wrongVersions = ""
+        var issues = ""
         definedVersions.get().forEach { (id, version) ->
             val resolved =
                 aggregatedClasspath.get().find {
                     val resolvedId = it.id
                     resolvedId is ModuleComponentIdentifier && resolvedId.moduleIdentifier.toString() == id
                 }
             if (resolved == null) {
-                potentiallyUnusedVersion += "Not used in production code: $id:$version\n"
+                if (!excludes.get().contains(id)) {
+                    issues += "Not used: $id:$version\n"
+                }
             } else {
                 val resolvedVersion = resolved.moduleVersion?.version
                 if (resolvedVersion != version) {
-                    wrongVersions += "Wrong version: $id (declared=$version; used=$resolvedVersion)\n"
+                    issues += "Wrong version: $id (declared=$version; used=$resolvedVersion)\n"
                 }
             }
         }
 
-        reportFile.get().asFile.writeText(potentiallyUnusedVersion + wrongVersions)
+        reportFile.get().asFile.writeText(issues)
 
-        if (!potentiallyUnusedVersion.isEmpty()) {
-            println(potentiallyUnusedVersion)
-        }
-        if (!wrongVersions.isEmpty()) {
-            throw RuntimeException(wrongVersions)
+        if (!issues.isEmpty()) {
+            throw RuntimeException(issues)
         }
     }
 }

gradle/versions/build.gradle.kts

@@ -15,3 +15,9 @@ dependencies.constraints {
     api(libs.resteasy.core) { version { reject("[5.0.0.Final,)") } }
     api(libs.solr.solrj) { version { reject("[8.0.0,)") } } // API changes in 8 require production code changes
 }
+
+tasks.checkVersionConsistency {
+    excludes.add("org.junit.jupiter:junit-jupiter-api") // testing only
+    excludes.add("org.assertj:assertj-core") // testing only
+    excludes.add("com.google.code.findbugs:jsr305") // test fixtures only
+}