Support Gradle Plugin testing with locally-built sigstore-java

vlsi · vlsi · commit 60b0b7a82a1a · 2023-01-04T08:03:53.000+03:00
The plugin runs with a separate build, so by default it uses mavenCentral only. However, we need to ensure the plugin is compatible with the main branch, so we publish sigstore-java to a temp folder, and use it as a repository in tests. Fixes #204 Signed-off-by: Vladimir Sitnikov <sitnikov.vladimir@gmail.com>
diff --git a/build-logic/publishing/src/main/kotlin/build-logic.kotlin-dsl-published-gradle-plugin.gradle.kts b/build-logic/publishing/src/main/kotlin/build-logic.kotlin-dsl-published-gradle-plugin.gradle.kts
@@ -7,3 +7,39 @@ plugins {
     id("build-logic.dokka-javadoc")
     id("build-logic.publish-to-central")
 }
+
+val sigstoreJavaRuntime by configurations.creating {
+    description = "declares dependencies that will be useful for testing purposes"
+    isCanBeConsumed = false
+    isCanBeResolved = false
+}
+
+val sigstoreJavaTestClasspath by configurations.creating {
+    description = "sigstore-java in local repository for testing purposes"
+    isCanBeConsumed = false
+    isCanBeResolved = true
+    extendsFrom(sigstoreJavaRuntime)
+    attributes {
+        attribute(Category.CATEGORY_ATTRIBUTE, objects.named("maven-repository"))
+        attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.EXTERNAL))
+    }
+}
+
+tasks.test {
+    dependsOn(sigstoreJavaTestClasspath)
+    systemProperty("sigstore.test.current.version", version)
+    val projectDir = layout.projectDirectory.asFile
+    // This adds paths to the local repositories that contain currently-built sigstore-java
+    // It enables testing both "sigstore-java from Central" and "sigstore-java build locally" in the plugin tests
+    jvmArgumentProviders.add(
+        // Gradle does not support Provider for systemProperties yet, see https://github.com/gradle/gradle/issues/12247
+        CommandLineArgumentProvider {
+            listOf(
+                "-Dsigstore.test.local.maven.repo=" +
+                        sigstoreJavaTestClasspath.joinToString(File.pathSeparator) {
+                            it.toRelativeString(projectDir)
+                        }
+            )
+        }
+    )
+}
diff --git a/build-logic/publishing/src/main/kotlin/build-logic.publish-to-central.gradle.kts b/build-logic/publishing/src/main/kotlin/build-logic.publish-to-central.gradle.kts
@@ -3,6 +3,7 @@ import org.gradle.api.publish.internal.PublicationInternal
 plugins {
     id("java-library")
     id("maven-publish")
+    id("build-logic.publish-to-tmp-maven-repo")
 }
 
 val repoUrl = "https://github.com/sigstore/sigstore-java"
diff --git a/build-logic/publishing/src/main/kotlin/build-logic.publish-to-tmp-maven-repo.gradle.kts b/build-logic/publishing/src/main/kotlin/build-logic.publish-to-tmp-maven-repo.gradle.kts
@@ -0,0 +1,41 @@
+plugins {
+    id("java-library")
+    id("maven-publish")
+}
+
+val localRepoElements by configurations.creating {
+    isCanBeConsumed = true
+    isCanBeResolved = false
+    description =
+        "Shares local maven repository directory that contains the artifacts produced by the current project"
+    attributes {
+        attribute(Category.CATEGORY_ATTRIBUTE, objects.named("maven-repository"))
+        attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.EXTERNAL))
+    }
+}
+
+val localRepoDir = layout.buildDirectory.dir("local-maven-repo")
+
+publishing {
+    repositories {
+        maven {
+            name = "tmp-maven"
+            url = uri(localRepoDir)
+        }
+    }
+}
+
+localRepoElements.outgoing.artifact(localRepoDir) {
+    builtBy(tasks.named("publishAllPublicationsToTmp-mavenRepository"))
+}
+
+val cleanLocalRepository by tasks.registering(Delete::class) {
+    description = "Clears local-maven-repo so timestamp-based snapshot artifacts do not consume space"
+    delete(localRepoDir)
+}
+
+tasks.withType<PublishToMavenRepository>()
+    .matching { it.name.endsWith("PublicationToTmp-mavenRepository") }
+    .configureEach {
+        dependsOn(cleanLocalRepository)
+    }
diff --git a/sigstore-gradle/sigstore-gradle-sign-base-plugin/build.gradle.kts b/sigstore-gradle/sigstore-gradle-sign-base-plugin/build.gradle.kts
@@ -9,6 +9,9 @@ dependencies {
     compileOnly(project(":sigstore-java"))
     implementation("com.fasterxml.jackson.core:jackson-databind:2.14.1")
 
+    sigstoreJavaRuntime(project(":sigstore-java")) {
+        because("Test code needs access locally-built sigstore-java as a Maven repository")
+    }
     testImplementation(project(":sigstore-testkit"))
 }
 
diff --git a/sigstore-gradle/sigstore-gradle-sign-base-plugin/src/main/kotlin/dev.sigstore.sign-base.gradle.kts b/sigstore-gradle/sigstore-gradle-sign-base-plugin/src/main/kotlin/dev.sigstore.sign-base.gradle.kts
@@ -43,5 +43,6 @@ val sigstoreClientClasspath by configurations.creating {
         attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, LibraryElements.JAR)
         attribute(Usage.USAGE_ATTRIBUTE, Usage.JAVA_RUNTIME)
         attribute(Bundling.BUNDLING_ATTRIBUTE, Bundling.EXTERNAL)
+        attribute(TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE, JavaVersion.current().majorVersion.toInt())
     }
 }
diff --git a/sigstore-gradle/sigstore-gradle-sign-base-plugin/src/test/kotlin/dev/sigstore/gradle/OidcDslTest.kt b/sigstore-gradle/sigstore-gradle-sign-base-plugin/src/test/kotlin/dev/sigstore/gradle/OidcDslTest.kt
@@ -17,13 +17,14 @@
 package dev.sigstore.gradle
 
 import dev.sigstore.testkit.BaseGradleTest
+import dev.sigstore.testkit.TestedGradle
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.MethodSource
 
 class OidcDslTest: BaseGradleTest() {
     @ParameterizedTest
     @MethodSource("gradleVersionAndSettings")
-    fun `configure GitHub OIDC client explicitly`(gradleVersion: String, configurationCache: ConfigurationCache) {
+    fun `configure GitHub OIDC client explicitly`(gradle: TestedGradle) {
         writeBuildGradle(
             """
             plugins {
@@ -44,8 +45,8 @@ class OidcDslTest: BaseGradleTest() {
             }
             """.trimIndent()
         )
-        enableConfigurationCache(gradleVersion, configurationCache)
-        prepare(gradleVersion, "printConfig", "-s")
+        enableConfigurationCache(gradle)
+        prepare(gradle.version, "printConfig", "-s")
             .build()
     }
 }
diff --git a/sigstore-gradle/sigstore-gradle-sign-base-plugin/src/test/kotlin/dev/sigstore/gradle/SigstoreSignTest.kt b/sigstore-gradle/sigstore-gradle-sign-base-plugin/src/test/kotlin/dev/sigstore/gradle/SigstoreSignTest.kt
@@ -17,27 +17,26 @@
 package dev.sigstore.gradle
 
 import dev.sigstore.testkit.BaseGradleTest
+import dev.sigstore.testkit.TestedGradle
+import dev.sigstore.testkit.TestedSigstoreJava
 import dev.sigstore.testkit.annotations.EnabledIfOidcExists
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.MethodSource
 
 @EnabledIfOidcExists
 class SigstoreSignTest: BaseGradleTest() {
     @ParameterizedTest
-    @MethodSource("gradleVersionAndSettings")
-    fun `sign file`(gradleVersion: String, configurationCache: ConfigurationCache) {
+    @MethodSource("gradleAndSigstoreJavaVersions")
+    fun `sign file`(gradle: TestedGradle, sigstoreJava: TestedSigstoreJava) {
         writeBuildGradle(
             """
             import dev.sigstore.sign.tasks.SigstoreSignFilesTask
             plugins {
                 id("java")
                 id("dev.sigstore.sign-base")
             }
-            repositories {
-                mavenCentral()
-            }
+            ${declareRepositoryAndDependency(sigstoreJava)}
             group = "dev.sigstore.test"
             def helloProps = tasks.register("helloProps", WriteProperties) {
                 outputFile = file("build/helloProps.txt")
@@ -54,15 +53,15 @@ class SigstoreSignTest: BaseGradleTest() {
             rootProject.name = 'sigstore-test'
             """.trimIndent()
         )
-        enableConfigurationCache(gradleVersion, configurationCache)
-        prepare(gradleVersion, "signFile", "-s")
+        enableConfigurationCache(gradle)
+        prepare(gradle.version, "signFile", "-s")
             .build()
         assertThat(projectDir.resolve("build/helloProps.txt.sigstore"))
             .content()
             .basicSigstoreStructure()
 
-        if (configurationCache == ConfigurationCache.ON) {
-            val result = prepare(gradleVersion, "signFile", "-s")
+        if (gradle.configurationCache == ConfigurationCache.ON) {
+            val result = prepare(gradle.version, "signFile", "-s")
                 .build()
 
             assertThat(result.output)
diff --git a/sigstore-gradle/sigstore-gradle-sign-plugin/build.gradle.kts b/sigstore-gradle/sigstore-gradle-sign-plugin/build.gradle.kts
@@ -8,6 +8,10 @@ description = "Gradle plugin to that automatically signs all Publications in Sig
 dependencies {
     api(project(":sigstore-gradle:sigstore-gradle-sign-base-plugin"))
 
+    sigstoreJavaRuntime(project(":sigstore-java")) {
+        because("Test code needs access locally-built sigstore-java as a Maven repository")
+    }
+
     testImplementation(project(":sigstore-testkit"))
 }
 
diff --git a/sigstore-gradle/sigstore-gradle-sign-plugin/src/test/kotlin/dev/sigstore/gradle/SigstorePublishSignTest.kt b/sigstore-gradle/sigstore-gradle-sign-plugin/src/test/kotlin/dev/sigstore/gradle/SigstorePublishSignTest.kt
@@ -17,27 +17,26 @@
 package dev.sigstore.gradle
 
 import dev.sigstore.testkit.BaseGradleTest
+import dev.sigstore.testkit.TestedGradle
+import dev.sigstore.testkit.TestedSigstoreJava
 import dev.sigstore.testkit.annotations.EnabledIfOidcExists
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.MethodSource
 
 @EnabledIfOidcExists
 class SigstorePublishSignTest : BaseGradleTest() {
     @ParameterizedTest
-    @MethodSource("gradleVersionAndSettings")
-    fun `sign file`(gradleVersion: String, configurationCache: ConfigurationCache) {
+    @MethodSource("gradleAndSigstoreJavaVersions")
+    fun `sign file`(gradle: TestedGradle, sigstoreJava: TestedSigstoreJava) {
         writeBuildGradle(
             """
             plugins {
                 id("java")
                 id("maven-publish")
                 id("dev.sigstore.sign")
             }
-            repositories {
-                mavenCentral()
-            }
+            ${declareRepositoryAndDependency(sigstoreJava)}
 
             group = "dev.sigstore.test"
             java {
@@ -66,8 +65,8 @@ class SigstorePublishSignTest : BaseGradleTest() {
             rootProject.name = 'sigstore-test'
             """.trimIndent()
         )
-        enableConfigurationCache(gradleVersion, configurationCache)
-        prepare(gradleVersion, "publishAllPublicationsToTmpRepository", "-s")
+        enableConfigurationCache(gradle)
+        prepare(gradle.version, "publishAllPublicationsToTmpRepository", "-s")
             .build()
 
         assertThat(projectDir.resolve("build/tmp-repo/dev/sigstore/test/sigstore-test/1.0/sigstore-test-1.0.pom.sigstore"))
@@ -83,8 +82,8 @@ class SigstorePublishSignTest : BaseGradleTest() {
             .content()
             .basicSigstoreStructure()
 
-        if (configurationCache == ConfigurationCache.ON) {
-            val result = prepare(gradleVersion, "publishAllPublicationsToTmpRepository", "-s")
+        if (gradle.configurationCache == ConfigurationCache.ON) {
+            val result = prepare(gradle.version, "publishAllPublicationsToTmpRepository", "-s")
                 .build()
 
             assertThat(result.output)
diff --git a/sigstore-java/build.gradle.kts b/sigstore-java/build.gradle.kts
@@ -20,6 +20,13 @@ dependencies {
 
     implementation("io.github.erdtman:java-json-canonicalization:1.1")
 
+    implementation("dev.sigstore:protobuf-specs:0.0.1") {
+        because("It generates Sigstore Bundle file")
+    }
+    implementation("com.google.protobuf:protobuf-java-util:3.13.0") {
+        because("It converts protobuf to json")
+    }
+
     // grpc deps
     implementation(platform("io.grpc:grpc-bom:1.51.1"))
     implementation("io.grpc:grpc-protobuf")
diff --git a/sigstore-testkit/src/main/kotlin/dev/sigstore/testkit/BaseGradleTest.kt b/sigstore-testkit/src/main/kotlin/dev/sigstore/testkit/BaseGradleTest.kt
@@ -26,6 +26,7 @@ import org.junit.jupiter.api.io.CleanupMode
 import org.junit.jupiter.api.io.TempDir
 import org.junit.jupiter.params.provider.Arguments
 import org.junit.jupiter.params.provider.Arguments.arguments
+import java.io.File
 import java.nio.file.Path
 
 open class BaseGradleTest {
@@ -38,17 +39,44 @@ open class BaseGradleTest {
     companion object {
         val isCI = System.getenv().containsKey("CI") || System.getProperties().containsKey("CI")
 
+        val EXTRA_LOCAL_REPOS  = System.getProperty("sigstore.test.local.maven.repo").split(File.pathSeparatorChar)
+
+        val SIGSTORE_JAVA_CURRENT_VERSION =
+            TestedSigstoreJava.Version(
+                System.getProperty("sigstore.test.current.version")
+            )
+
         @JvmStatic
         fun gradleVersionAndSettings(): Iterable<Arguments> {
             if (!isCI) {
                 // Make the test faster, and skip extra tests with the configuration cache to reduce OIDC flows
                 // Gradle 7.2 fails with "No service of type ObjectFactory available in default services"
-                return listOf(arguments("7.3", ConfigurationCache.OFF))
+                return listOf(arguments(TestedGradle("7.3", ConfigurationCache.ON)))
             }
             return mutableListOf<Arguments>().apply {
-                add(arguments("7.3", ConfigurationCache.ON))
-                add(arguments("7.5.1", ConfigurationCache.ON))
-                add(arguments("7.5.1", ConfigurationCache.OFF))
+                add(arguments(TestedGradle("7.3", ConfigurationCache.ON)))
+                add(arguments(TestedGradle("7.5.1", ConfigurationCache.ON)))
+                add(arguments(TestedGradle("7.5.1", ConfigurationCache.OFF)))
+            }
+        }
+
+        @JvmStatic
+        fun sigstoreJavaVersions(): Iterable<Arguments> {
+            return mutableListOf<Arguments>().apply {
+                add(arguments(SIGSTORE_JAVA_CURRENT_VERSION))
+                if (isCI) {
+                    add(arguments(TestedSigstoreJava.Default))
+                    add(arguments(TestedSigstoreJava.Version("0.2.0")))
+                }
+            }
+        }
+
+        @JvmStatic
+        fun gradleAndSigstoreJavaVersions(): Iterable<Arguments> {
+            val gradle = gradleVersionAndSettings()
+            val sigstore = sigstoreJavaVersions()
+            return gradle.flatMap { gradleVersion ->
+                sigstore.map { arguments(*gradleVersion.get(), *it.get()) }
             }
         }
     }
@@ -64,6 +92,48 @@ open class BaseGradleTest {
 
     protected fun String.normalizeEol() = replace(Regex("[\r\n]+"), "\n")
 
+    protected fun declareRepositories(sigstoreJava: TestedSigstoreJava) =
+        """
+        repositories {${
+            if (sigstoreJava == SIGSTORE_JAVA_CURRENT_VERSION || sigstoreJava is TestedSigstoreJava.Default) {
+                EXTRA_LOCAL_REPOS.joinToString("\n") {
+                    """
+
+                maven {
+                   url = uri("${
+                        File(it).toURI().toASCIIString().replace(Regex("""[\\"$]""")) { "\\" + it.value }
+                   }")
+                }
+                """.trimIndent().prependIndent("            ")
+                }
+            } else {
+                ""
+            }
+        }
+            mavenCentral()
+        }
+        """.trimIndent()
+
+    protected fun declareDependency(sigstoreJava: TestedSigstoreJava) =
+        """
+        dependencies {
+            ${
+                when (sigstoreJava) {
+                    TestedSigstoreJava.Default -> ""
+                    is TestedSigstoreJava.Version ->
+                        "sigstoreClient(\"dev.sigstore:sigstore-java:${sigstoreJava.version}\")"
+                }
+            }
+        }
+        """.trimIndent()
+
+    protected fun declareRepositoryAndDependency(sigstoreJava: TestedSigstoreJava) =
+        """
+        ${declareRepositories(sigstoreJava)}
+        ${declareDependency(sigstoreJava)}
+        """.trimIndent()
+
+
     protected fun createSettings(extra: String = "") {
         projectDir.resolve("settings.gradle").write(
             """
@@ -95,14 +165,13 @@ open class BaseGradleTest {
             .forwardOutput()
 
     protected fun enableConfigurationCache(
-        gradleVersion: String,
-        configurationCache: ConfigurationCache
+        gradle: TestedGradle,
     ) {
-        if (configurationCache != ConfigurationCache.ON) {
+        if (gradle.configurationCache != ConfigurationCache.ON) {
             return
         }
-        if (GradleVersion.version(gradleVersion) < GradleVersion.version("7.0")) {
-            Assertions.fail<Unit>("Gradle version $gradleVersion does not support configuration cache")
+        if (GradleVersion.version(gradle.version) < GradleVersion.version("7.0")) {
+            Assertions.fail<Unit>("Gradle version $gradle does not support configuration cache")
         }
         // Gradle 6.5 expects values ON, OFF, WARN, so we add the option for 7.0 only
         projectDir.resolve("gradle.properties").toFile().appendText(
diff --git a/sigstore-testkit/src/main/kotlin/dev/sigstore/testkit/TestedGradle.kt b/sigstore-testkit/src/main/kotlin/dev/sigstore/testkit/TestedGradle.kt
diff --git a/sigstore-testkit/src/main/kotlin/dev/sigstore/testkit/TestedSigstoreJava.kt b/sigstore-testkit/src/main/kotlin/dev/sigstore/testkit/TestedSigstoreJava.kt

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import org.gradle.api.publish.internal.PublicationInternal`
`3`	`3`	`plugins {`
`4`	`4`	`id("java-library")`
`5`	`5`	`id("maven-publish")`
	`6`	`+ id("build-logic.publish-to-tmp-maven-repo")`
`6`	`7`	`}`
`7`	`8`
`8`	`9`	`val repoUrl = "https://github.com/sigstore/sigstore-java"`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@ dependencies {`
`9`	`9`	`compileOnly(project(":sigstore-java"))`
`10`	`10`	`implementation("com.fasterxml.jackson.core:jackson-databind:2.14.1")`
`11`	`11`
	`12`	`+ sigstoreJavaRuntime(project(":sigstore-java")) {`
	`13`	`+ because("Test code needs access locally-built sigstore-java as a Maven repository")`
	`14`	`+ }`
`12`	`15`	`testImplementation(project(":sigstore-testkit"))`
`13`	`16`	`}`
`14`	`17`
Original file line number	Diff line number	Diff line change
`@@ -43,5 +43,6 @@ val sigstoreClientClasspath by configurations.creating {`
`43`	`43`	`attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, LibraryElements.JAR)`
`44`	`44`	`attribute(Usage.USAGE_ATTRIBUTE, Usage.JAVA_RUNTIME)`
`45`	`45`	`attribute(Bundling.BUNDLING_ATTRIBUTE, Bundling.EXTERNAL)`
	`46`	`+ attribute(TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE, JavaVersion.current().majorVersion.toInt())`
`46`	`47`	`}`
`47`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,14 @@`
`17`	`17`	`package dev.sigstore.gradle`
`18`	`18`
`19`	`19`	`import dev.sigstore.testkit.BaseGradleTest`
	`20`	`+import dev.sigstore.testkit.TestedGradle`
`20`	`21`	`import org.junit.jupiter.params.ParameterizedTest`
`21`	`22`	`import org.junit.jupiter.params.provider.MethodSource`
`22`	`23`
`23`	`24`	`class OidcDslTest: BaseGradleTest() {`
`24`	`25`	`@ParameterizedTest`
`25`	`26`	`@MethodSource("gradleVersionAndSettings")`
`26`		- fun `configure GitHub OIDC client explicitly`(gradleVersion: String, configurationCache: ConfigurationCache) {
	`27`	+ fun `configure GitHub OIDC client explicitly`(gradle: TestedGradle) {
`27`	`28`	`writeBuildGradle(`
`28`	`29`	`"""`
`29`	`30`	`plugins {`
`@@ -44,8 +45,8 @@ class OidcDslTest: BaseGradleTest() {`
`44`	`45`	`}`
`45`	`46`	`""".trimIndent()`
`46`	`47`	`)`
`47`		`- enableConfigurationCache(gradleVersion, configurationCache)`
`48`		`- prepare(gradleVersion, "printConfig", "-s")`
	`48`	`+ enableConfigurationCache(gradle)`
	`49`	`+ prepare(gradle.version, "printConfig", "-s")`
`49`	`50`	`.build()`
`50`	`51`	`}`
`51`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,10 @@ description = "Gradle plugin to that automatically signs all Publications in Sig`
`8`	`8`	`dependencies {`
`9`	`9`	`api(project(":sigstore-gradle:sigstore-gradle-sign-base-plugin"))`
`10`	`10`
	`11`	`+ sigstoreJavaRuntime(project(":sigstore-java")) {`
	`12`	`+ because("Test code needs access locally-built sigstore-java as a Maven repository")`
	`13`	`+ }`
	`14`	`+`
`11`	`15`	`testImplementation(project(":sigstore-testkit"))`
`12`	`16`	`}`
`13`	`17`