|
| 1 | +/* |
| 2 | + * Copyright 2022 The Sigstore Authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + * |
| 16 | + */ |
| 17 | +package dev.sigstore.gradle |
| 18 | + |
| 19 | +import dev.sigstore.testkit.BaseGradleTest |
| 20 | +import dev.sigstore.testkit.TestedGradle |
| 21 | +import dev.sigstore.testkit.TestedSigstoreJava |
| 22 | +import dev.sigstore.testkit.annotations.EnabledIfOidcExists |
| 23 | +import org.assertj.core.api.Assertions.assertThat |
| 24 | +import org.assertj.core.api.SoftAssertions |
| 25 | +import org.gradle.util.GradleVersion |
| 26 | +import org.junit.jupiter.params.ParameterizedTest |
| 27 | +import org.junit.jupiter.params.provider.Arguments |
| 28 | +import org.junit.jupiter.params.provider.Arguments.arguments |
| 29 | +import org.junit.jupiter.params.provider.MethodSource |
| 30 | + |
| 31 | +@EnabledIfOidcExists |
| 32 | +class RemoveSigstoreAscTest : BaseGradleTest() { |
| 33 | + companion object { |
| 34 | + @JvmStatic |
| 35 | + fun signingSupportedGradleAndSigstoreJavaVersions(): Iterable<Arguments> = |
| 36 | + if (isCI) { |
| 37 | + gradleAndSigstoreJavaVersions() |
| 38 | + } else { |
| 39 | + // Find the first version that supports configuration cache for Gradle's signing plugin (8.1+) |
| 40 | + listOf( |
| 41 | + arguments( |
| 42 | + TestedGradle( |
| 43 | + // Signing plugin supports configuration cache since 8.1 |
| 44 | + gradleVersions().first { it >= GradleVersion.version("8.1") }, |
| 45 | + ConfigurationCache.ON |
| 46 | + ), |
| 47 | + SIGSTORE_JAVA_CURRENT_VERSION |
| 48 | + ) |
| 49 | + ) |
| 50 | + } |
| 51 | + |
| 52 | + @JvmStatic |
| 53 | + fun oneSigningSupportedGradleAndSigstoreJavaVersions(): Iterable<Arguments> = |
| 54 | + signingSupportedGradleAndSigstoreJavaVersions().take(1) |
| 55 | + } |
| 56 | + |
| 57 | + @ParameterizedTest |
| 58 | + @MethodSource("signingSupportedGradleAndSigstoreJavaVersions") |
| 59 | + fun `basic configuration avoids signing sigstore with pgp`(gradle: TestedGradle, sigstoreJava: TestedSigstoreJava) { |
| 60 | + prepareBuildScripts(gradle, sigstoreJava) |
| 61 | + |
| 62 | + prepare(gradle.version, "publishAllPublicationsToTmpRepository", "-s") |
| 63 | + .build() |
| 64 | + |
| 65 | + assertSoftly { |
| 66 | + assertSignatures("sigstore-test-1.0.pom") |
| 67 | + assertSignatures("sigstore-test-1.0-sources.jar") |
| 68 | + assertSignatures("sigstore-test-1.0.module") |
| 69 | + assertSignatures("sigstore-test-1.0.pom") |
| 70 | + } |
| 71 | + |
| 72 | + if (gradle.configurationCache == ConfigurationCache.ON) { |
| 73 | + val result = prepare(gradle.version, "publishAllPublicationsToTmpRepository", "-s") |
| 74 | + .build() |
| 75 | + |
| 76 | + assertThat(result.output) |
| 77 | + .contains( |
| 78 | + "Configuration cache entry reused", |
| 79 | + "7 actionable tasks: 4 executed, 3 up-to-date", |
| 80 | + ) |
| 81 | + } |
| 82 | + } |
| 83 | + |
| 84 | + @ParameterizedTest |
| 85 | + @MethodSource("oneSigningSupportedGradleAndSigstoreJavaVersions") |
| 86 | + fun `crossign sigstore with pgp`(gradle: TestedGradle, sigstoreJava: TestedSigstoreJava) { |
| 87 | + prepareBuildScripts(gradle, sigstoreJava) |
| 88 | + projectDir.resolve("gradle.properties").toFile().appendText( |
| 89 | + """ |
| 90 | +
|
| 91 | + # By default, dev.sigstore.sign asks Gradle to avoid signing .sigstore as .sigstore.asc |
| 92 | + # This is an opt-out hatch for those who need .sigstore.asc |
| 93 | + dev.sigstore.sign.remove.sigstore.asc=false |
| 94 | + """.trimIndent() |
| 95 | + ) |
| 96 | + prepare(gradle.version, "publishAllPublicationsToTmpRepository", "-s") |
| 97 | + .build() |
| 98 | + assertSoftly { |
| 99 | + assertSignatures("sigstore-test-1.0.pom", expectSigstoreAsc = true) |
| 100 | + assertSignatures("sigstore-test-1.0-sources.jar", expectSigstoreAsc = true) |
| 101 | + assertSignatures("sigstore-test-1.0.module", expectSigstoreAsc = true) |
| 102 | + assertSignatures("sigstore-test-1.0.pom", expectSigstoreAsc = true) |
| 103 | + } |
| 104 | + } |
| 105 | + |
| 106 | + private fun prepareBuildScripts(gradle: TestedGradle, sigstoreJava: TestedSigstoreJava) { |
| 107 | + writeBuildGradle( |
| 108 | + """ |
| 109 | + plugins { |
| 110 | + id("java") |
| 111 | + id("signing") |
| 112 | + id("maven-publish") |
| 113 | + id("dev.sigstore.sign") |
| 114 | + } |
| 115 | + ${declareRepositoryAndDependency(sigstoreJava)} |
| 116 | +
|
| 117 | + group = "dev.sigstore.test" |
| 118 | + java { |
| 119 | + withSourcesJar() |
| 120 | + } |
| 121 | + publishing { |
| 122 | + publications { |
| 123 | + maven(MavenPublication) { |
| 124 | + groupId = 'dev.sigstore.test' |
| 125 | + artifactId = 'sigstore-test' |
| 126 | + version = '1.0' |
| 127 | + from components.java |
| 128 | + } |
| 129 | + } |
| 130 | + repositories { |
| 131 | + maven { |
| 132 | + name = "tmp" |
| 133 | + url = layout.buildDirectory.dir("tmp-repo") |
| 134 | + } |
| 135 | + } |
| 136 | + } |
| 137 | + signing { |
| 138 | + useInMemoryPgpKeys( |
| 139 | + '''$testOnlySigningKey''', |
| 140 | + "testforsigstorejava" |
| 141 | + ) |
| 142 | + sign(publishing.publications.withType(MavenPublication)) |
| 143 | + } |
| 144 | + """.trimIndent() |
| 145 | + ) |
| 146 | + writeSettingsGradle( |
| 147 | + """ |
| 148 | + rootProject.name = 'sigstore-test' |
| 149 | + """.trimIndent() |
| 150 | + ) |
| 151 | + if (gradle.version >= GradleVersion.version("8.1")) { |
| 152 | + enableConfigurationCache(gradle) |
| 153 | + } |
| 154 | + } |
| 155 | + |
| 156 | + private fun SoftAssertions.assertSignatures(name: String, expectSigstoreAsc: Boolean = false) { |
| 157 | + assertThat(projectDir.resolve("build/tmp-repo/dev/sigstore/test/sigstore-test/1.0/$name.sigstore")) |
| 158 | + .describedAs("$name should be signed with Sigstore") |
| 159 | + .content() |
| 160 | + .basicSigstoreStructure() |
| 161 | + assertThat(projectDir.resolve("build/tmp-repo/dev/sigstore/test/sigstore-test/1.0/$name.asc")) |
| 162 | + .describedAs("$name should be signed with PGP") |
| 163 | + .isNotEmptyFile() |
| 164 | + assertThat(projectDir.resolve("build/tmp-repo/dev/sigstore/test/sigstore-test/1.0/$name.asc.sigstore")) |
| 165 | + .describedAs("$name.asc should NOT be signed with Sigstore") |
| 166 | + .doesNotExist() |
| 167 | + assertThat(projectDir.resolve("build/tmp-repo/dev/sigstore/test/sigstore-test/1.0/$name.sigstore.asc")) |
| 168 | + .apply { |
| 169 | + if (expectSigstoreAsc) { |
| 170 | + describedAs("$name.sigstore should be signed with PGP") |
| 171 | + exists() |
| 172 | + } else { |
| 173 | + // We don't want to sign .sigstore files with PGP |
| 174 | + describedAs("$name.sigstore should NOT be signed with PGP") |
| 175 | + doesNotExist() |
| 176 | + } |
| 177 | + } |
| 178 | + } |
| 179 | + |
| 180 | + private val testOnlySigningKey = """ |
| 181 | + -----BEGIN PGP PRIVATE KEY BLOCK----- |
| 182 | +
|
| 183 | + lIYEZaDRyxYJKwYBBAHaRw8BAQdAjMi3g07livoPo+se6/+wF7LRv2DDJ6UKVBrp |
| 184 | + 9rugpwj+BwMCDZlNm7zWHTP6ny1jqI5sdTFaEkHRjFhm63Il9qeF7QcSibgAnBO5 |
| 185 | + YK0E4vp8MUQxSAwoOV80mO46a2Ci9hA281lXH6fFTP3qyERXl2/ilrQvVGVzdCBL |
| 186 | + ZXkgZm9yIFNpZ3N0b3JlIEphdmEgPHNpZ3N0b3JlQGdpdGh1Yi5pbz6IkwQTFgoA |
| 187 | + OxYhBNejX8GGaAn2Jspav54UgcovliH1BQJloNHLAhsDBQsJCAcCAiICBhUKCQgL |
| 188 | + AgQWAgMBAh4HAheAAAoJEJ4UgcovliH1YDUBAPE1yBo7i4YgHuHKIGLqkOJqEKE5 |
| 189 | + Jbw8ffyZO6tqud2qAP49liajq/HkdEXgUdA6DySpzLYFtd+F6UlpTQE0TeaLAA== |
| 190 | + =6fgq |
| 191 | + -----END PGP PRIVATE KEY BLOCK----- |
| 192 | + """.trimIndent() |
| 193 | +} |
0 commit comments