Skip to content

Build/Release: Add digest for Quarkus distributables #1271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,6 @@ constructor(objectFactory: ObjectFactory, project: Project) {
objectFactory
.fileProperty()
.convention(project.provider { distributionDir.get().file("${baseName.get()}.tar.gz") })
val sourceTarballDigest =
objectFactory
.fileProperty()
.convention(
project.provider { distributionDir.get().file("${baseName.get()}.tar.gz.sha512") }
)

val mailingLists = objectFactory.listProperty(String::class.java).convention(emptyList())

Expand Down
66 changes: 66 additions & 0 deletions build-logic/src/main/kotlin/publishing/digest-task.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package publishing

import java.security.MessageDigest
import javax.inject.Inject
import org.gradle.api.DefaultTask
import org.gradle.api.model.ObjectFactory
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.TaskAction
import org.gradle.work.DisableCachingByDefault

@DisableCachingByDefault
abstract class GenerateDigest @Inject constructor(objectFactory: ObjectFactory) : DefaultTask() {

@get:InputFile val file = objectFactory.fileProperty()
@get:Input val algorithm = objectFactory.property(String::class.java).convention("SHA-512")
@get:OutputFile
val outputFile =
objectFactory.fileProperty().convention {
val input = file.get().asFile
val algo = algorithm.get()
input.parentFile.resolve("${input.name}-${algo.replace("-", "").lowercase()}")
}

@TaskAction
fun generate() {
val input = file.get().asFile
val digestFile = outputFile.get().asFile
val md = MessageDigest.getInstance(algorithm.get())
input.inputStream().use {
val buffered = it.buffered(8192)
val buf = ByteArray(8192)
var rd: Int
while (true) {
rd = buffered.read(buf)
if (rd == -1) break
md.update(buf, 0, rd)
}

digestFile.writeText(
md.digest().joinToString(separator = "") { eachByte -> "%02x".format(eachByte) } +
" ${input.name}"
)
}
}
}
31 changes: 16 additions & 15 deletions build-logic/src/main/kotlin/publishing/rootProject.kt
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,28 @@ internal fun configureOnRootProject(project: Project) =
workingDir(project.projectDir)
}

val digestSourceTarball = tasks.register("digestSourceTarball")
digestSourceTarball.configure {
mustRunAfter(sourceTarball)

doFirst {
val e = project.extensions.getByType(PublishingHelperExtension::class.java)
generateDigest(e.sourceTarball.get().asFile, e.sourceTarballDigest.get().asFile, "SHA-512")
val digestSourceTarball =
tasks.register<GenerateDigest>("digestSourceTarball") {
description = "Generate the source tarball digest"
mustRunAfter(sourceTarball)
file.set {
val e = project.extensions.getByType(PublishingHelperExtension::class.java)
e.sourceTarball.get().asFile
}
}
}

sourceTarball.configure { finalizedBy(digestSourceTarball) }

if (isSigning) {
val signSourceTarball = tasks.register<Sign>("signSourceTarball")
signSourceTarball.configure {
mustRunAfter(sourceTarball)
doFirst {
val e = project.extensions.getByType(PublishingHelperExtension::class.java)
sign(e.sourceTarball.get().asFile)
val signSourceTarball =
tasks.register<Sign>("signSourceTarball") {
description = "Sign the source tarball"
mustRunAfter(sourceTarball)
doFirst {
val e = project.extensions.getByType(PublishingHelperExtension::class.java)
sign(e.sourceTarball.get().asFile)
}
}
}
sourceTarball.configure { finalizedBy(signSourceTarball) }
}

Expand Down
21 changes: 0 additions & 21 deletions build-logic/src/main/kotlin/publishing/util.kt
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,8 @@ import groovy.json.JsonException
import groovy.json.JsonSlurper
import groovy.util.Node
import groovy.util.NodeList
import java.io.File
import java.io.FileNotFoundException
import java.net.URI
import java.security.MessageDigest
import org.gradle.api.artifacts.Configuration
import org.gradle.api.artifacts.component.ModuleComponentSelector
import org.gradle.api.artifacts.result.DependencyResult
Expand Down Expand Up @@ -58,25 +56,6 @@ internal fun xmlNode(node: Node?, child: String): Node? {
return null
}

internal fun generateDigest(input: File, output: File, algorithm: String) {
val md = MessageDigest.getInstance(algorithm)
input.inputStream().use {
val buffered = it.buffered(8192)
val buf = ByteArray(8192)
var rd: Int
while (true) {
rd = buffered.read(buf)
if (rd == -1) break
md.update(buf, 0, rd)
}

output.writeText(
md.digest().joinToString(separator = "") { eachByte -> "%02x".format(eachByte) } +
" ${input.name}"
)
}
}

internal fun <T : Any> unsafeCast(o: Any?): T {
@Suppress("UNCHECKED_CAST")
return o as T
Expand Down
28 changes: 28 additions & 0 deletions quarkus/admin/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
*/

import io.quarkus.gradle.tasks.QuarkusBuild
import publishing.GenerateDigest

plugins {
alias(libs.plugins.quarkus)
Expand Down Expand Up @@ -110,11 +111,38 @@ val distZip =
inputs.files(runScript)
}

val digestDistTar =
tasks.register<GenerateDigest>("digestDistTar") {
description = "Generate the distribution tar digest"
mustRunAfter(distTar)
file.set { distTar.get().archiveFile.get().asFile }
}

val digestDistZip =
tasks.register<GenerateDigest>("digestDistZip") {
description = "Generate the distribution zip digest"
mustRunAfter(distZip)
file.set { distZip.get().archiveFile.get().asFile }
}

distTar.configure { finalizedBy(digestDistTar) }

distZip.configure { finalizedBy(digestDistZip) }

if (project.hasProperty("release") || project.hasProperty("signArtifacts")) {
signing {
sign(distTar.get())
sign(distZip.get())
}
}

// Expose runnable jar via quarkusRunner configuration for integration-tests that require the
// server.
artifacts {
add(distributionTar.name, provider { distTar.get().archiveFile }) { builtBy(distTar) }
add(distributionTar.name, provider { digestDistTar.get().outputFile }) { builtBy(digestDistTar) }
add(distributionZip.name, provider { distZip.get().archiveFile }) { builtBy(distZip) }
add(distributionZip.name, provider { digestDistZip.get().outputFile }) { builtBy(digestDistZip) }
}

afterEvaluate {
Expand Down
28 changes: 28 additions & 0 deletions quarkus/server/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import io.quarkus.gradle.tasks.QuarkusBuild
import io.quarkus.gradle.tasks.QuarkusRun
import publishing.GenerateDigest

plugins {
alias(libs.plugins.quarkus)
Expand Down Expand Up @@ -109,14 +110,41 @@ val distZip =
inputs.files(runScript)
}

val digestDistTar =
tasks.register<GenerateDigest>("digestDistTar") {
description = "Generate the distribution tar digest"
mustRunAfter(distTar)
file.set { distTar.get().archiveFile.get().asFile }
}

val digestDistZip =
tasks.register<GenerateDigest>("digestDistZip") {
description = "Generate the distribution zip digest"
mustRunAfter(distZip)
file.set { distZip.get().archiveFile.get().asFile }
}

distTar.configure { finalizedBy(digestDistTar) }

distZip.configure { finalizedBy(digestDistZip) }

if (project.hasProperty("release") || project.hasProperty("signArtifacts")) {
signing {
sign(distTar.get())
sign(distZip.get())
}
}

// Expose runnable jar via quarkusRunner configuration for integration-tests that require the
// server.
artifacts {
add(quarkusRunner.name, provider { quarkusBuild.get().fastJar.resolve("quarkus-run.jar") }) {
builtBy(quarkusBuild)
}
add(distributionTar.name, provider { distTar.get().archiveFile }) { builtBy(distTar) }
add(distributionTar.name, provider { digestDistTar.get().outputFile }) { builtBy(digestDistTar) }
add(distributionZip.name, provider { distZip.get().archiveFile }) { builtBy(distZip) }
add(distributionZip.name, provider { digestDistZip.get().outputFile }) { builtBy(digestDistZip) }
}

afterEvaluate {
Expand Down