Skip to content
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
43 changes: 43 additions & 0 deletions build-logic/src/main/kotlin/Utilities.kt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
* limitations under the License.
*/

import java.io.File
import java.io.FileOutputStream
import java.nio.file.attribute.FileTime
import java.util.zip.ZipFile
import java.util.zip.ZipOutputStream
import org.gradle.api.Project
import org.gradle.process.JavaForkOptions

Expand Down Expand Up @@ -61,3 +66,41 @@ fun JavaForkOptions.addSparkJvmOptions() {
"-Djdk.reflect.useDirectMethodHandle=false",
)
}

/**
* Rewrites the given ZIP file.
*
* The timestamps of all entries are set to `1980-02-01 00:00`, zip entries appear in a
* deterministic order.
*/
fun makeZipReproducible(source: File) {
val t = FileTime.fromMillis(318211200_000) // 1980-02-01 00:00 GMT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not 0 😉

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gradle uses the same timestamp. IIRC it's got something to do with ZIP file format specialties...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, ok 👍


val outFile = File(source.absolutePath + ".tmp.out")

val names = mutableListOf<String>()
ZipFile(source).use { zip -> zip.stream().forEach { e -> names.add(e.name) } }
names.sort()

ZipOutputStream(FileOutputStream(outFile)).use { dst ->
ZipFile(source).use { zip ->
names.forEach { n ->
val e = zip.getEntry(n)
zip.getInputStream(e).use { src ->
e.setCreationTime(t)
e.setLastAccessTime(t)
e.setLastModifiedTime(t)
dst.putNextEntry(e)
src.copyTo(dst)
dst.closeEntry()
src.close()
}
}
}
}

val origFile = File(source.absolutePath + ".tmp.orig")
source.renameTo(origFile)
outFile.renameTo(source)
origFile.delete()
}
22 changes: 17 additions & 5 deletions build-logic/src/main/kotlin/polaris-java.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ plugins {
`jvm-test-suite`
checkstyle
id("polaris-spotless")
id("polaris-reproducible")
id("jacoco-report-aggregation")
id("net.ltgt.errorprone")
}
Expand Down Expand Up @@ -237,9 +238,20 @@ configurations.all {
}
}

// ensure jars conform to reproducible builds
// (https://docs.gradle.org/current/userguide/working_with_files.html#sec:reproducible_archives)
tasks.withType<AbstractArchiveTask>().configureEach {
isPreserveFileTimestamps = false
isReproducibleFileOrder = true
if (plugins.hasPlugin("io.quarkus")) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be worth moving it to polaris-server.gradle.kts?.. or perhaps make a separate plugin dedicated to quarkus?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a dedicated build-plugin for the "distributed" Quarkus builds, but also other projects that use/build with Quarkus.... So I put it into the non-java version specific one.

tasks.named("quarkusBuild") {
actions.addLast {
listOf(
"quarkus-app/quarkus-run.jar",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does Quarkus not respect isReproducibleFileOrder, etc.?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ehm - nope. That's a Gradle thing.

"quarkus-app/quarkus/generated-bytecode.jar",
"quarkus-app/quarkus/transformed-bytecode.jar",
)
.forEach { name ->
val file = project.layout.buildDirectory.get().file(name).asFile
if (file.exists()) {
makeZipReproducible(file)
}
}
}
}
}
25 changes: 25 additions & 0 deletions build-logic/src/main/kotlin/polaris-reproducible.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* 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.
*/

// ensure jars conform to reproducible builds
// (https://docs.gradle.org/current/userguide/working_with_files.html#sec:reproducible_archives)
tasks.withType<AbstractArchiveTask>().configureEach {
isPreserveFileTimestamps = false
isReproducibleFileOrder = true
}
1 change: 1 addition & 0 deletions runtime/distribution/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import publishing.PublishingHelperPlugin
plugins {
id("distribution")
id("signing")
id("polaris-reproducible")
}

description = "Apache Polaris Binary Distribution"
Expand Down
1 change: 1 addition & 0 deletions tools/config-docs/site/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

plugins {
`java-library`
id("polaris-reproducible")
}

description = "Polaris site - reference docs"
Expand Down