Skip to content

use an extraction task instead of an artifact transform for protokt g… #432

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

use an extraction task instead of an artifact transform for protokt g… #432

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 35 additions & 65 deletions protokt-gradle-plugin/src/main/kotlin/protokt/v1/gradle/BinaryInstaller.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,55 +16,42 @@
package protokt.v1.gradle

import com.google.protobuf.gradle.GenerateProtoTask
import org.gradle.api.NamedDomainObjectContainer
import org.gradle.api.DefaultTask
import org.gradle.api.Project
import org.gradle.api.artifacts.transform.InputArtifact
import org.gradle.api.artifacts.transform.TransformAction
import org.gradle.api.artifacts.transform.TransformOutputs
import org.gradle.api.artifacts.transform.TransformParameters
import org.gradle.api.artifacts.type.ArtifactTypeDefinition
import org.gradle.api.attributes.Attribute
import org.gradle.api.file.FileSystemLocation
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction
import org.gradle.internal.file.PathTraversalChecker
import org.gradle.kotlin.dsl.dependencies
import org.gradle.kotlin.dsl.registerTransform
import org.gradle.kotlin.dsl.register
import org.gradle.kotlin.dsl.withType
import org.gradle.work.DisableCachingByDefault
import java.io.BufferedInputStream
import java.io.File
import java.io.FileInputStream
import java.util.zip.ZipInputStream

private const val CODEGEN_CONFIGURATION = "_protokt_codegen_"
private val ARTIFACT_TYPE_ATTRIBUTE = Attribute.of("artifactType", String::class.java)
private val UNPACKED_CODEGEN_ATTRIBUTE = Attribute.of("unpackedCodegen", Boolean::class.javaObjectType)
abstract class ExtractCodegenTask : DefaultTask() {
@get:InputFile
abstract val zipFile: RegularFileProperty

/**
* Unzip an application distribution and chmox +x the launchers.
*/
@DisableCachingByDefault(because = "Not worth caching")
abstract class UnzipDistTransform : TransformAction<TransformParameters.None> {
@get:InputArtifact
@get:PathSensitive(PathSensitivity.NAME_ONLY)
abstract val zippedFile: Provider<FileSystemLocation>
@get:OutputDirectory
abstract val outputDirectory: DirectoryProperty

@TaskAction
fun extract() {
val zip = zipFile.get().asFile
val outputDir = outputDirectory.get().asFile

override fun transform(outputs: TransformOutputs) {
val zippedFile = zippedFile.get().asFile
val unzippedDirName = zippedFile.name.substringAfter('.')
val unzipDir = outputs.dir(unzippedDirName)
outputDir.deleteRecursively()
outputDir.mkdirs()

ZipInputStream(BufferedInputStream(FileInputStream(zippedFile))).use { inputStream ->
ZipInputStream(BufferedInputStream(FileInputStream(zip))).use { inputStream ->
generateSequence { inputStream.nextEntry }.filter { !it.isDirectory }.forEach {
val file = File(unzipDir, PathTraversalChecker.safePathName(it.name))
val file = File(outputDir, PathTraversalChecker.safePathName(it.name))

file.parentFile.mkdirs()

file.outputStream().buffered().use {
inputStream.copyTo(it)
}
file.outputStream().buffered().use(inputStream::copyTo)

if (it.name.contains("/bin/")) {
file.setExecutable(true)
Expand All @@ -75,39 +62,22 @@ abstract class UnzipDistTransform : TransformAction<TransformParameters.None> {
}

internal fun binaryFromArtifact(project: Project): String {
val configuration = project.configurations.create(CODEGEN_CONFIGURATION) {
attributes.attribute(UNPACKED_CODEGEN_ATTRIBUTE, true)
}

project.dependencies {
attributesSchema {
attribute(UNPACKED_CODEGEN_ATTRIBUTE)
}

artifactTypes.createIfNecessary("zip") {
attributes.attribute(UNPACKED_CODEGEN_ATTRIBUTE, false)
val dependency = project.dependencies.create("$BASE_GROUP_NAME:protokt-codegen:$PROTOKT_VERSION:dist@zip")
val configuration = project.configurations.detachedConfiguration(dependency)
val targetDir = project.layout.buildDirectory.dir("protokt-codegen/$CODEGEN_NAME-$PROTOKT_VERSION")

val extractTask =
project.tasks.register<ExtractCodegenTask>("extractProtoktCodegen") {
zipFile.fileProvider(project.provider { configuration.singleFile })
outputDirectory.set(targetDir)
}

registerTransform(UnzipDistTransform::class) {
from.attribute(UNPACKED_CODEGEN_ATTRIBUTE, false).attribute(ARTIFACT_TYPE_ATTRIBUTE, "zip")
to.attribute(UNPACKED_CODEGEN_ATTRIBUTE, true).attribute(ARTIFACT_TYPE_ATTRIBUTE, ArtifactTypeDefinition.DIRECTORY_TYPE)
}

add(
CODEGEN_CONFIGURATION,
"$BASE_GROUP_NAME:protokt-codegen:$PROTOKT_VERSION:dist@zip"
)

project.afterEvaluate {
tasks.withType<GenerateProtoTask> {
inputs.files(project.configurations.getByName(CODEGEN_CONFIGURATION))
}
project.afterEvaluate {
tasks.withType<GenerateProtoTask> {
dependsOn(extractTask)
inputs.files(configuration)
}
}

return configuration.singleFile.absolutePath + "/$CODEGEN_NAME-$PROTOKT_VERSION/bin/$CODEGEN_NAME"
}

private fun <T> NamedDomainObjectContainer<T>.createIfNecessary(name: String, configure: T.() -> Unit) {
(findByName(name) ?: create(name)).configure()
return targetDir.get().asFile.resolve("$CODEGEN_NAME-$PROTOKT_VERSION/bin/$CODEGEN_NAME").absolutePath
}