Adopt new Roseau features

* Exclude internal APIs from check
* Ignore accepted changes
* Fail on unignored breaking change
* Generate HTML report

(cherry picked from commit 4a249e2)

Author: marcphilipp

gradle/config/roseau/config.yaml

@@ -0,0 +1,5 @@
+common:
+  excludes:
+    annotations:
+      - name: org.apiguardian.api.API
+        args: { status: org.apiguardian.api.API$Status.INTERNAL }

gradle/plugins/backward-compatibility/build.gradle.kts

@@ -9,6 +9,7 @@ dependencies {
 	implementation("junitbuild.base:dsl-extensions")
 	implementation(libs.plugins.download.markerCoordinates)
 	implementation(libs.plugins.japicmp.markerCoordinates)
+	implementation(libs.jackson.dataformat.yaml)
 }
 
 tasks.compileJava {

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

@@ -81,7 +81,13 @@ val roseau by tasks.registering(RoseauDiff::class) {
 	libraryClasspath.from(configurations.compileClasspath)
 	v1 = downloadPreviousReleaseJar.map { it.outputFiles.single() }
 	v2 = tasks.jar.flatMap { it.archiveFile }.map { it.asFile }
-	csvReport = layout.buildDirectory.file("reports/roseau/breaking-changes.csv")
+	configFile = rootProject.layout.projectDirectory.file("gradle/config/roseau/config.yaml")
+	rootProject.layout.projectDirectory.file("gradle/config/roseau/accepted-breaking-changes.csv").asFile.let {
+		if (it.exists()) {
+			acceptedChangesCsvFile = it
+		}
+	}
+	reportDir = layout.buildDirectory.dir("reports/roseau")
 }
 
 val japicmp by tasks.registering(JapicmpTask::class) {

gradle/plugins/backward-compatibility/src/main/kotlin/junitbuild/compatibility/roseau/RoseauDiff.kt

@@ -1,16 +1,27 @@
 package junitbuild.compatibility.roseau
 
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
+import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature.WRITE_DOC_START_MARKER
 import org.gradle.api.DefaultTask
+import org.gradle.api.GradleException
 import org.gradle.api.file.ConfigurableFileCollection
+import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.tasks.CacheableTask
 import org.gradle.api.tasks.Classpath
 import org.gradle.api.tasks.CompileClasspath
-import org.gradle.api.tasks.OutputFile
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.Optional
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskAction
 import org.gradle.kotlin.dsl.assign
 import org.gradle.process.ExecOperations
 import java.io.ByteArrayOutputStream
+import java.io.File
+import java.io.FileOutputStream
 import javax.inject.Inject
 
 @CacheableTask
@@ -31,12 +42,29 @@ abstract class RoseauDiff : DefaultTask() {
     @get:CompileClasspath
     abstract val v2: RegularFileProperty
 
-    @get:OutputFile
-    abstract val csvReport: RegularFileProperty
+    @get:InputFile
+    @get:PathSensitive(PathSensitivity.NONE)
+    abstract val configFile: RegularFileProperty
+
+    @get:InputFile
+    @get:PathSensitive(PathSensitivity.NONE)
+    @get:Optional
+    abstract val acceptedChangesCsvFile: RegularFileProperty
+
+    @get:OutputDirectory
+    abstract val reportDir: DirectoryProperty
 
     @TaskAction
     fun run() {
-        csvReport.get().asFile.parentFile.mkdirs()
+        val reportDir = reportDir.get().asFile.absoluteFile
+        val reports = listOf(
+            Report(reportDir.resolve("breaking-changes.html"), Report.Format.HTML),
+            Report(reportDir.resolve("breaking-changes.csv"), Report.Format.CSV)
+        )
+        reports.forEach { report -> report.file.delete() }
+
+        val effectiveConfigFile = writeEffectiveConfigFile(reports)
+
         val output = ByteArrayOutputStream()
         val result = execOperations.javaexec {
             mainClass = "io.github.alien.roseau.cli.RoseauCLI"
@@ -46,16 +74,53 @@ abstract class RoseauDiff : DefaultTask() {
                 "--v1", v1.get().asFile.absolutePath,
                 "--v2", v2.get().asFile.absolutePath,
                 "--diff",
-                "--report", csvReport.get().asFile.absolutePath,
-                "--fail",
+                "--fail-on-bc",
+                "--config", effectiveConfigFile.absolutePath,
             )
+            if (acceptedChangesCsvFile.isPresent) {
+                args("--ignored", acceptedChangesCsvFile.get().asFile.absolutePath)
+            }
             standardOutput = output
             errorOutput = output
             isIgnoreExitValue = true
         }
         if (result.exitValue != 0) {
             System.out.write(output.toByteArray())
             System.out.flush()
+            reports.filter { it.file.exists() }.let { writtenReports ->
+                if (writtenReports.isNotEmpty()) {
+                    println("Reports:")
+                    writtenReports.forEach {
+                        println("- ${it.format.name}: ${it.file.toURI()}")
+                    }
+                }
+            }
+            if (result.exitValue == 1) {
+                throw GradleException("Breaking API changes detected")
+            }
+            result.assertNormalExitValue()
+        }
+    }
+
+    private fun writeEffectiveConfigFile(reports: List<Report>): File {
+        val effectiveConfigFile = temporaryDir.resolve("roseau.yaml")
+        configFile.get().asFile.copyTo(effectiveConfigFile, overwrite = true)
+        FileOutputStream(effectiveConfigFile, true).bufferedWriter().use { writer ->
+            val yamlFactory = YAMLFactory.builder().disable(WRITE_DOC_START_MARKER).build()
+            val mapper = ObjectMapper(yamlFactory)
+            mapper.writeValue(
+                writer, mapOf(
+                    "reports" to reports
+                )
+            )
+        }
+        return effectiveConfigFile
+    }
+
+    private data class Report(val file: File, val format: Format) {
+        enum class Format {
+            HTML, CSV
         }
     }
+
 }