Skip to content

Use toolchains for java tasks #181

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 4 commits into from
Feb 6, 2024
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 @@ -26,7 +26,10 @@ abstract class GradleTest {
val builder = ProjectBuilder().apply(build)
templates.resolve(name).copyRecursively(rootProjectDir)
file("build.gradle").modify(builder::build)
file("settings.gradle").writeText("") // empty settings file
val settingsFile = file("settings.gradle")
if (!settingsFile.exists()) {
file("settings.gradle").writeText("") // empty settings file
}
return Runner(rootProjectDir, print, gradleVersion)
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package kotlinx.benchmark.integration

import org.gradle.testkit.runner.TaskOutcome
import org.junit.Test
import kotlin.test.assertEquals

class JvmToolchainsTest : GradleTest() {
@Test
fun testJvmToolchainSetup() {
val runner = project("kmp-with-toolchain", true, GradleTestVersion.v8_0) {
}
runner.run("benchmark") {
assertEquals(TaskOutcome.SUCCESS, task(":jvmBenchmark")!!.outcome)
assertOutputDoesNotContain("<failure>")
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,14 @@ internal fun BuildResult.assertOutputContains(
}
}

internal fun BuildResult.assertTasksUpToDate(tasks: Collection<String>) = assertTasksUpToDate(*tasks.toTypedArray())
internal fun BuildResult.assertOutputDoesNotContain(
expectedSubString: String,
message: String = "Build output contains \"$expectedSubString\""
) {
assert(!output.contains(expectedSubString)) {
printBuildOutput()
message
}
}

internal fun BuildResult.assertTasksUpToDate(tasks: Collection<String>) = assertTasksUpToDate(*tasks.toTypedArray())
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
kotlin {
jvm {
jvmToolchain(21)
}

sourceSets {
commonMain {
dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime:0.5.0-SNAPSHOT")
}
}
}
}

benchmark {
targets {
register("jvm")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
org.gradle.jvmargs=-Xmx2g -XX:MaxPermSize=2048m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
plugins {
id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package test

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

// Don't really need to measure anything here, just check that the benchmark works
@State(Scope.Benchmark)
@Warmup(iterations = 0)
@Measurement(iterations = 1, time = 100, timeUnit = BenchmarkTimeUnit.MILLISECONDS)
@OutputTimeUnit(BenchmarkTimeUnit.MILLISECONDS)
@BenchmarkMode(Mode.Throughput)
open class CommonBenchmark {
@Benchmark
open fun mathBenchmark() = 3.14
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package kotlinx.benchmark.gradle

import org.gradle.api.*
import org.gradle.api.file.*
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.*
import org.gradle.workers.*
import java.io.*
Expand All @@ -28,11 +29,18 @@ open class JmhBytecodeGeneratorTask
@InputFiles
@PathSensitive(PathSensitivity.RELATIVE)
lateinit var runtimeClasspath: FileCollection

@Optional
@Input
var executableProvider: Provider<String> = project.provider { null }

@TaskAction
fun generate() {
val workQueue = workerExecutor.processIsolation { workerSpec ->
workerSpec.classpath.setFrom(runtimeClasspath.files)
if (executableProvider.isPresent) {
workerSpec.forkOptions.executable = executableProvider.get()
}
}
workQueue.submit(JmhBytecodeGeneratorWorker::class.java) { workParameters ->
workParameters.inputClasses.setFrom(inputClassesDirs.files)
Expand Down
5 changes: 5 additions & 0 deletions plugin/main/src/kotlinx/benchmark/gradle/JvmTasks.kt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ fun Project.createJvmBenchmarkCompileTask(target: JvmBenchmarkTarget, compileCla
classpath = compileClasspath
source = fileTree("$benchmarkBuildDir/sources")
destinationDirectory.set(file("$benchmarkBuildDir/classes"))
javaCompiler.set(javaCompilerProvider())
}

task<Jar>(
Expand Down Expand Up @@ -90,6 +91,9 @@ fun Project.createJvmBenchmarkGenerateSourceTask(
inputClassesDirs = compilationOutput
outputResourcesDir = file("$benchmarkBuildDir/resources")
outputSourcesDir = file("$benchmarkBuildDir/sources")
executableProvider = javaLauncherProvider().map {
it.executablePath.asFile.absolutePath
}
}
}

Expand Down Expand Up @@ -123,5 +127,6 @@ fun Project.createJvmBenchmarkExecTask(

val reportFile = setupReporting(target, config)
args(writeParameters(target.name, reportFile, traceFormat(), config))
javaLauncher.set(javaLauncherProvider())
}
}
19 changes: 18 additions & 1 deletion plugin/main/src/kotlinx/benchmark/gradle/Utils.kt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ import org.gradle.api.Action
import org.gradle.api.Project
import org.gradle.api.Task
import org.gradle.api.invocation.Gradle
import org.gradle.api.plugins.JavaPluginExtension
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.TaskProvider
import org.gradle.jvm.toolchain.JavaCompiler
import org.gradle.jvm.toolchain.JavaLauncher
import org.gradle.jvm.toolchain.JavaToolchainService
import java.io.File
import java.nio.file.Path
import java.time.LocalDateTime
Expand Down Expand Up @@ -261,4 +266,16 @@ internal fun Project.getSystemProperty(key: String): String? {
} else {
System.getProperty(key)
}
}
}

fun Project.javaCompilerProvider(): Provider<JavaCompiler> = provider {
val toolchainService = extensions.findByType(JavaToolchainService::class.java) ?: return@provider null
val javaExtension = extensions.findByType(JavaPluginExtension::class.java) ?: return@provider null
toolchainService.compilerFor(javaExtension.toolchain).orNull
}

fun Project.javaLauncherProvider(): Provider<JavaLauncher> = provider {
val toolchainService = extensions.findByType(JavaToolchainService::class.java) ?: return@provider null
val javaExtension = extensions.findByType(JavaPluginExtension::class.java) ?: return@provider null
toolchainService.launcherFor(javaExtension.toolchain).orNull
}