Add settings plugin test

Author: aSemy

modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/SettingsPluginDslTest.kt

@@ -0,0 +1,235 @@
+package kotlinx.validation.test
+
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.GradleProjectTest
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.build
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.buildGradleKts
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.dir
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.gradleKtsProjectTest
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.invariantNewlines
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.settingsGradleKts
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.shouldHaveOutcome
+import dev.adamko.kotlin.binary_compatibility_validator.test.utils.shouldNotHaveRunTask
+import io.kotest.assertions.asClue
+import io.kotest.assertions.withClue
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.matchers.paths.shouldBeAFile
+import io.kotest.matchers.paths.shouldExist
+import io.kotest.matchers.shouldBe
+import io.kotest.matchers.string.shouldContain
+import kotlin.io.path.readText
+import org.gradle.testkit.runner.TaskOutcome
+import org.intellij.lang.annotations.Language
+
+internal class SettingsPluginDslTest : FunSpec({
+
+  context("when BCV-MU is applied as a settings plugin") {
+
+    val kotlinJvmTest = TestCase(
+      projectType = "Kotlin/JVM",
+      project = kotlinJvmProjectWithBcvSettingsPlugin(),
+      expectedPrintedBCVTargets = """
+        |name: kotlinJvm
+        |platformType: kotlinJvm
+        |enabled: true
+        |ignoredClasses: [com.package.MyIgnoredClass]
+        |ignoredMarkers: [com.package.MyInternalApiAnnotationMarker]
+        |ignoredPackages: [com.package.my_ignored_package]
+        |inputClasses: [main, main]
+        |inputJar: null
+        |------------------------------
+        |
+      """.trimMargin()
+    )
+
+    val kotlinMultiplatformTest = TestCase(
+      projectType = "Kotlin/Multiplatform",
+      project = kotlinMultiplatformProjectWithBcvSettingsPlugin(),
+      expectedPrintedBCVTargets = """
+        |name: jvm
+        |platformType: jvm
+        |enabled: true
+        |ignoredClasses: [com.package.MyIgnoredClass]
+        |ignoredMarkers: [com.package.MyInternalApiAnnotationMarker]
+        |ignoredPackages: [com.package.my_ignored_package]
+        |inputClasses: [main]
+        |inputJar: null
+        |------------------------------
+        |
+      """.trimMargin()
+    )
+
+    listOf(
+      kotlinJvmTest,
+      kotlinMultiplatformTest,
+    ).forEach { testCase ->
+      context("in a ${testCase.projectType} project") {
+
+        test("apiDump should be generated in all non-excluded subprojects") {
+          testCase.project.projectDir.toFile()
+            .walk()
+            .filter { it.isDirectory && it.name == "api" }
+            .forEach { it.deleteRecursively() }
+
+          testCase.project.runner
+            .withArguments("apiDump", "--stacktrace")
+            .build {
+              output shouldContain "SUCCESSFUL"
+
+              withClue("root project is excluded from BCV") {
+                shouldNotHaveRunTask(":apiDump")
+              }
+
+              task(":sub1:apiDump") shouldHaveOutcome TaskOutcome.SUCCESS
+              task(":sub2:apiDump") shouldHaveOutcome TaskOutcome.SUCCESS
+            }
+
+          testCase.project.projectDir.resolve("sub1/api/sub1.api").asClue { apiDump ->
+            apiDump.shouldExist()
+            apiDump.shouldBeAFile()
+            apiDump.readText().invariantNewlines() shouldBe /* language=TEXT */ """
+            |
+          """.trimMargin()
+          }
+
+          testCase.project.projectDir.resolve("sub2/api/sub2.api").asClue { apiDump ->
+            apiDump.shouldExist()
+            apiDump.shouldBeAFile()
+            apiDump.readText().invariantNewlines() shouldBe /* language=TEXT */ """
+            |
+          """.trimMargin()
+          }
+        }
+
+        test("expect the conventions set in the settings plugin are used in the subprojects") {
+          testCase.project.runner.withArguments("printBCVTargets", "-q", "--stacktrace").build {
+            output.invariantNewlines() shouldBe testCase.expectedPrintedBCVTargets
+          }
+        }
+      }
+    }
+  }
+})
+
+private data class TestCase(
+  val projectType: String,
+  val project: GradleProjectTest,
+  @Language("TEXT")
+  val expectedPrintedBCVTargets: String,
+)
+
+private fun kotlinJvmProjectWithBcvSettingsPlugin() =
+  gradleKtsProjectTest("settings-plugin-dsl-test/kotlin-jvm") {
+
+    settingsGradleKts += settingsGradleKtsWithBcvPlugin
+
+    buildGradleKts = "\n"
+
+    dir("sub1") {
+      buildGradleKts = buildGradleKtsWithKotlinJvmAndBcvConfig
+    }
+
+    dir("sub2") {
+      buildGradleKts = buildGradleKtsWithKotlinJvmAndBcvConfig
+      buildGradleKts += printBcvTargetsTask
+    }
+  }
+
+
+private fun kotlinMultiplatformProjectWithBcvSettingsPlugin() =
+  gradleKtsProjectTest("settings-plugin-dsl-test/kotlin-multiplatform-jvm") {
+
+    settingsGradleKts += settingsGradleKtsWithBcvPlugin
+
+    buildGradleKts = "\n"
+
+    dir("sub1") {
+      buildGradleKts = buildGradleKtsWithKotlinMultiplatformJvmAndBcvConfig
+    }
+
+    dir("sub2") {
+      buildGradleKts = buildGradleKtsWithKotlinMultiplatformJvmAndBcvConfig
+      buildGradleKts += printBcvTargetsTask
+    }
+  }
+
+@Language("kts")
+private val settingsGradleKtsWithBcvPlugin = """
+buildscript {
+  dependencies {
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin-api:1.7.20")
+  }
+}
+
+
+plugins {
+  id("dev.adamko.kotlin.binary-compatibility-validator") version "0.0.3-SNAPSHOT"
+}
+
+include(
+  ":sub1",
+  ":sub2",
+)
+
+binaryCompatibilityValidator { 
+  ignoredProjects.add(":")
+  defaultTargetValues {
+    enabled.convention(true)
+    ignoredClasses.set(listOf("com.package.MyIgnoredClass"))
+    ignoredMarkers.set(listOf("com.package.MyInternalApiAnnotationMarker"))
+    ignoredPackages.set(listOf("com.package.my_ignored_package"))
+  }
+}
+
+"""
+
+@Language("kts")
+private val buildGradleKtsWithKotlinJvmAndBcvConfig = """
+plugins {
+  kotlin("jvm") version "1.7.20"
+}
+
+// check that the DSL is available:
+binaryCompatibilityValidator { }
+
+"""
+
+/**
+ * Note: the `kotlin("multiplatform")` version should be set in [settingsGradleKtsWithBcvPlugin].
+ */
+@Language("kts")
+private val buildGradleKtsWithKotlinMultiplatformJvmAndBcvConfig = """
+plugins {
+  kotlin("multiplatform") version "1.7.20"
+}
+
+kotlin {
+  jvm()
+}
+
+// check that the DSL is available:
+binaryCompatibilityValidator { }
+
+"""
+
+@Language("kts")
+private val printBcvTargetsTask = """
+val printBCVTargets by tasks.registering {
+   
+  val bcvTargets = binaryCompatibilityValidator.targets
+
+  doLast {
+    bcvTargets.forEach {
+      println("name: " + it.name)
+      println("platformType: " + it.platformType)
+      println("enabled: " + it.enabled.get())
+      println("ignoredClasses: " + it.ignoredClasses.get())
+      println("ignoredMarkers: " + it.ignoredMarkers.get())
+      println("ignoredPackages: " + it.ignoredPackages.get())
+      println("inputClasses: " + it.inputClasses.files.map { f -> f.name })
+      println("inputJar: " + it.inputJar.orNull)
+      println("------------------------------")
+    }
+  }
+}
+ 
+"""