Skip to content

Exclude manifest and module-info when creating an uber-jar #317

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Exclude manifest and module-info when creating an uber-jar #317

Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions integration/src/test/kotlin/kotlinx/benchmark/integration/JarFileTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package kotlinx.benchmark.integration

import kotlin.test.Test

class JarFileTest : GradleTest() {
@Test
fun testFilesFiltration() {
val runner = project("jar-test", true) {}
runner.runAndSucceed("jvmBenchmarkJar") {
assertOutputDoesNotContain("Encountered duplicate path")
}
}
}
18 changes: 18 additions & 0 deletions integration/src/test/resources/templates/jar-test/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
kotlin {
jvm { }

sourceSets {
commonMain {
dependencies {
implementation("org.jetbrains.kotlin:kotlin-test")
implementation("org.jetbrains.kotlin:kotlin-reflect")
}
}
}
}

benchmark {
targets {
register("jvm")
}
}
1 change: 1 addition & 0 deletions integration/src/test/resources/templates/jar-test/gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
org.gradle.jvmargs=-Xmx2g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
16 changes: 16 additions & 0 deletions integration/src/test/resources/templates/jar-test/src/commonMain/kotlin/CommonBenchmark.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package test

import kotlinx.benchmark.*
import kotlin.math.*

@State(Scope.Benchmark)
@Measurement(iterations = 1, time = 1, timeUnit = BenchmarkTimeUnit.MILLISECONDS)
@Warmup(iterations = 1, time = 1, timeUnit = BenchmarkTimeUnit.MILLISECONDS)
@OutputTimeUnit(BenchmarkTimeUnit.MILLISECONDS)
@BenchmarkMode(Mode.Throughput)
open class CommonBenchmark {
@Benchmark
open fun mathBenchmark(): Double {
return log(sqrt(3.0) * cos(3.0), 2.0)
}
}
12 changes: 2 additions & 10 deletions plugin/main/src/kotlinx/benchmark/gradle/JvmTasks.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,14 @@ fun Project.createJvmBenchmarkCompileTask(target: JvmBenchmarkTarget, compileCla
dependsOn("${target.name}${BenchmarksPlugin.BENCHMARK_COMPILE_SUFFIX}")
archiveClassifier.set("JMH")
manifest.attributes["Main-Class"] = "org.openjdk.jmh.Main"

exclude("META-INF/**/module-info.class", "META-INF/**/MANIFEST.MF")
Copy link

@viluon viluon Jun 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This PR is set to close #314. However, these paths don't seem to cover the conflicts reported in the issue, namely LICENSE.txt files in dependencies and *.kotlin_module files. Perhaps I'm misunderstanding something but − as it stands − I don't see how this fixes the original problem.

Copy link
Collaborator Author

@fzhinkin fzhinkin Jun 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yep, sorry, let me elaborate.

There are a few files that should be skipped when packing an uber-jar - neither module-info, nor manifests make sense for the resulting jar.
Currently, the plugin doesn't skip them effectively, and that could be fixed.

For other files, in general, it's not a good idea to exclude them from jar, and I don't think the plugin can make that choice for a user here. For example, .kotlin_module files removal may result in reflection-related issues in runtime.

If there are clashes between some files, there's a warning and you're sure that the best way to handle it is by excluding files from the resulting jar, then you can get a Jar task by its name (or its type) and add extra exclusion rules.

Copy link

Choose a reason for hiding this comment

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

Thanks for the explanation. From a user's PoV though, I think this problem is quite obscure. On non-JVM platforms that don't need an uber jar, I suspect you don't have to worry about this. But due to an internal implementation detail of kotlinx-benchmark on the JVM, the benchmark assembly process runs into a problem that potentially produces an invalid jar.

And it's not like the current status is any better than excluding all conflicting files: there's no way to tell which source jar will win out when there are conflicts, so it's probably a case of incorrect behaviour by default.

duplicatesStrategy = DuplicatesStrategy.WARN

from(project.provider {
compileClasspath.map {
when {
it.isDirectory -> it
it.exists() -> zipTree(it).let { tree ->
if (it.name.startsWith("kotlin-stdlib-jdk")) {
tree.filter { file ->
!(file.toString().contains("META-INF") && file.name in listOf("module-info.class", "MANIFEST.MF"))
}
} else {
tree
}
}
it.exists() -> zipTree(it)
else -> files()
}
}
Expand Down