Add roseau tasks for comparison with japicmp

Author: marcphilipp

gradle/libs.versions.toml

@@ -63,6 +63,7 @@ openTestReporting-events = { module = "org.opentest4j.reporting:open-test-report
 openTestReporting-tooling-core = { module = "org.opentest4j.reporting:open-test-reporting-tooling-core", version.ref = "openTestReporting" }
 openTestReporting-tooling-spi = { module = "org.opentest4j.reporting:open-test-reporting-tooling-spi", version.ref = "openTestReporting" }
 picocli = { module = "info.picocli:picocli", version = "4.7.7" }
+roseau-cli = { module = "io.github.alien-tools:roseau-cli", version = "0.3.0" }
 slf4j-julBinding = { module = "org.slf4j:slf4j-jdk14", version = "2.0.17" }
 snapshotTests-junit5 = { module = "de.skuzzle.test:snapshot-tests-junit5", version.ref = "snapshotTests" }
 snapshotTests-xml = { module = "de.skuzzle.test:snapshot-tests-xml", version.ref = "snapshotTests" }

gradle/plugins/backward-compatibility/src/main/kotlin/junitbuild.backward-compatibility.gradle.kts

@@ -6,6 +6,7 @@ import junitbuild.compatibility.japicmp.AcceptedViolationsPostProcessRule
 import junitbuild.compatibility.japicmp.BreakingSuperClassChangeRule
 import junitbuild.compatibility.japicmp.InternalApiFilter
 import junitbuild.compatibility.japicmp.SourceIncompatibleRule
+import junitbuild.extensions.dependencyFromLibs
 import junitbuild.extensions.javaModuleName
 import me.champeau.gradle.japicmp.JapicmpTask
 import me.champeau.gradle.japicmp.report.stdrules.BinaryIncompatibleRule
@@ -17,6 +18,14 @@ plugins {
 	id("me.champeau.gradle.japicmp")
 }
 
+val roseauDependencies = configurations.dependencyScope("roseau")
+val roseauClasspath = configurations.resolvable("roseauClasspath") {
+	extendsFrom(roseauDependencies.get())
+}
+dependencies {
+	roseauDependencies(dependencyFromLibs("roseau-cli"))
+}
+
 val extension = extensions.create<BackwardCompatibilityChecksExtension>("backwardCompatibilityChecks").apply {
 	enabled.convention(true)
 	acceptedIncompatibilities.apply {
@@ -49,11 +58,49 @@ val downloadPreviousReleaseJar by tasks.registering(Download::class) {
 	outputs.cacheIf { true }
 }
 
-val checkBackwardCompatibility by tasks.registering(JapicmpTask::class) {
+val roseauCsvFile = layout.buildDirectory.file("reports/roseau/breaking-changes.csv")
+
+val roseau by tasks.registering(JavaExec::class) {
 	if (gradle.startParameter.isOffline) {
 		enabled = false
 	}
 	onlyIf { extension.enabled.get() }
+
+	mainClass = "io.github.alien.roseau.cli.RoseauCLI"
+	classpath = files(roseauClasspath)
+
+	inputs.files(configurations.compileClasspath).withNormalizer(CompileClasspathNormalizer::class).withPropertyName("apiClasspath")
+
+	val v1Jar = downloadPreviousReleaseJar.map { it.outputFiles.single() }
+	inputs.file(v1Jar).withNormalizer(CompileClasspathNormalizer::class).withPropertyName("v1")
+
+	val v2Jar = tasks.jar.flatMap { it.archiveFile}.map { it.asFile }
+	inputs.file(v2Jar).withNormalizer(CompileClasspathNormalizer::class).withPropertyName("v2")
+
+	outputs.file(roseauCsvFile).withPropertyName("report")
+
+	argumentProviders.add(CommandLineArgumentProvider {
+		listOf(
+			"--classpath", configurations.compileClasspath.get().files.joinToString(":") { file -> file.absolutePath },
+			"--v1", v1Jar.get().absolutePath,
+			"--v2", v2Jar.get().absolutePath,
+			"--diff",
+			"--report", roseauCsvFile.get().asFile.absolutePath,
+		)
+	})
+
+	doFirst {
+		roseauCsvFile.get().asFile.parentFile.mkdirs()
+	}
+}
+
+val japicmp by tasks.registering(JapicmpTask::class) {
+	if (gradle.startParameter.isOffline) {
+		enabled = false
+	}
+	onlyIf { extension.enabled.get() }
+	shouldRunAfter(roseau)
+
 	oldClasspath.from(downloadPreviousReleaseJar.map { it.outputFiles })
 	newClasspath.from(tasks.jar)
 	onlyModified = true
@@ -73,6 +120,10 @@ val checkBackwardCompatibility by tasks.registering(JapicmpTask::class) {
 	}
 }
 
+val checkBackwardCompatibility by tasks.registering {
+	dependsOn(roseau, japicmp)
+}
+
 tasks.check {
 	dependsOn(checkBackwardCompatibility)
 }
@@ -81,7 +132,7 @@ afterEvaluate {
 	val params = mapOf(
 		"acceptedIncompatibilities" to extension.acceptedIncompatibilities.get().joinToString(",")
 	)
-	checkBackwardCompatibility {
+	japicmp {
 		richReport {
 			addViolationTransformer(AcceptedViolationSuppressor::class.java, params)
 			addPostProcessRule(AcceptedViolationsPostProcessRule::class.java, params)

junit-jupiter-api/junit-jupiter-api.gradle.kts

@@ -36,7 +36,7 @@ tasks {
 	compileJava {
 		options.compilerArgs.add("-Xlint:-module") // due to qualified exports
 	}
-	checkBackwardCompatibility {
+	japicmp {
 		classExcludes.addAll($$"*.AssertionsKt$assert*", $$"*.AssertionsKt$evaluate*")
 	}
 	jar {