diff --git a/build-logic/settings.gradle.kts b/build-logic/settings.gradle.kts new file mode 100644 index 00000000000..612ae4b8fdd --- /dev/null +++ b/build-logic/settings.gradle.kts @@ -0,0 +1,50 @@ +pluginManagement { + repositories { + mavenLocal() + if (settings.extra.has("gradlePluginProxy")) { + maven { + url = uri(settings.extra["gradlePluginProxy"] as String) + isAllowInsecureProtocol = true + } + } + if (settings.extra.has("mavenRepositoryProxy")) { + maven { + url = uri(settings.extra["mavenRepositoryProxy"] as String) + isAllowInsecureProtocol = true + } + } + gradlePluginPortal() + mavenCentral() + } +} + +dependencyResolutionManagement { + versionCatalogs { + create("libs") { + from(files("../gradle/libs.versions.toml")) + } + } + repositories { + mavenLocal() + if (settings.extra.has("mavenRepositoryProxy")) { + maven { + url = uri(settings.extra["mavenRepositoryProxy"] as String) + isAllowInsecureProtocol = true + } + } + gradlePluginPortal() + mavenCentral() + // Hosts gradle-tooling-api; used by the smoke-test plugin to run nested Gradle builds + // pinned to older Gradle versions. + maven { + url = uri("https://repo.gradle.org/gradle/libs-releases") + content { + includeGroup("org.gradle") + } + } + } +} + +rootProject.name = "build-logic" + +include(":smoke-test") diff --git a/build-logic/smoke-test/build.gradle.kts b/build-logic/smoke-test/build.gradle.kts new file mode 100644 index 00000000000..2581025425e --- /dev/null +++ b/build-logic/smoke-test/build.gradle.kts @@ -0,0 +1,56 @@ +plugins { + `java-gradle-plugin` + `kotlin-dsl` + `jvm-test-suite` +} + +java { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 +} + +kotlin { + compilerOptions { + jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_1_8) + } +} + +dependencies { + implementation(libs.gradle.tooling.api) + runtimeOnly("org.slf4j:slf4j-simple:1.7.36") +} + +gradlePlugin { + plugins { + create("smoke-test-app") { + id = "dd-trace-java.smoke-test-app" + implementationClass = "datadog.buildlogic.smoketest.SmokeTestAppPlugin" + } + } +} + +@Suppress("UnstableApiUsage") +testing { + suites { + val test by getting(JvmTestSuite::class) { + useJUnitJupiter(libs.versions.junit5) + dependencies { + implementation(libs.junit.jupiter) + implementation(libs.junit.jupiter.params) + implementation(libs.junit.jupiter.engine) + implementation(libs.assertj.core) + implementation(gradleTestKit()) + } + targets.configureEach { + testTask.configure { + // The gradle-test-kit runner shells out to a Gradle daemon, which can be slow on a + // cold cache. Surface stdout/stderr to make CI failures debuggable. + testLogging { + showStandardStreams = true + events("failed", "skipped") + } + } + } + } + } +} diff --git a/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/NestedBuildProjectJar.kt b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/NestedBuildProjectJar.kt new file mode 100644 index 00000000000..503f78c47b4 --- /dev/null +++ b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/NestedBuildProjectJar.kt @@ -0,0 +1,24 @@ +package datadog.buildlogic.smoketest + +import org.gradle.api.file.RegularFileProperty +import org.gradle.api.provider.Property +import org.gradle.api.tasks.Input +import org.gradle.api.tasks.InputFile +import org.gradle.api.tasks.PathSensitive +import org.gradle.api.tasks.PathSensitivity + +/** + * A jar produced by the root build that needs to be forwarded into a [NestedGradleBuild]. + * + * At execution time the task adds `-P${propertyName}=` to the nested + * Gradle invocation, so the inner build script can pick it up via `findProperty(...)`. + */ +abstract class NestedBuildProjectJar { + + @get:Input + abstract val propertyName: Property + + @get:InputFile + @get:PathSensitive(PathSensitivity.NONE) + abstract val file: RegularFileProperty +} diff --git a/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/NestedGradleBuild.kt b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/NestedGradleBuild.kt new file mode 100644 index 00000000000..e2c1c34f09f --- /dev/null +++ b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/NestedGradleBuild.kt @@ -0,0 +1,128 @@ +package datadog.buildlogic.smoketest + +import org.gradle.api.Action +import org.gradle.api.DefaultTask +import org.gradle.api.file.DirectoryProperty +import org.gradle.api.file.FileTree +import org.gradle.api.file.RegularFile +import org.gradle.api.model.ObjectFactory +import org.gradle.api.provider.ListProperty +import org.gradle.api.provider.Property +import org.gradle.api.provider.Provider +import org.gradle.api.tasks.IgnoreEmptyDirectories +import org.gradle.api.tasks.Input +import org.gradle.api.tasks.InputFiles +import org.gradle.api.tasks.Internal +import org.gradle.api.tasks.Nested +import org.gradle.api.tasks.OutputDirectory +import org.gradle.api.tasks.PathSensitive +import org.gradle.api.tasks.PathSensitivity +import org.gradle.api.tasks.TaskAction +import org.gradle.jvm.toolchain.JavaLanguageVersion +import org.gradle.jvm.toolchain.JavaLauncher +import org.gradle.jvm.toolchain.JavaToolchainService +import org.gradle.kotlin.dsl.newInstance +import org.gradle.tooling.GradleConnector +import javax.inject.Inject + +/** + * Runs a nested Gradle build inside [applicationDir] via the Gradle Tooling API. + * + * Lets a smoke test pin a Gradle version (typically older than the root build) and a Java + * toolchain for the nested daemon, without committing per-application `gradlew` wrappers. + * + * The nested build script is expected to honour `-PappBuildDir=` and redirect its + * `buildDir` to that path so the artifact lands in [applicationBuildDir]. Project artifacts + * from the root build can be forwarded via [projectJar]; each entry is passed as + * `-P=` and tracked as a task input so the nested build re-runs + * when the upstream jar changes. + */ +abstract class NestedGradleBuild @Inject constructor( + private val objects: ObjectFactory, + javaToolchains: JavaToolchainService, +) : DefaultTask() { + + init { + gradleVersion.convention(DEFAULT_NESTED_GRADLE_VERSION) + javaLauncher.convention( + javaToolchains.launcherFor { + languageVersion.set(JavaLanguageVersion.of(DEFAULT_NESTED_JAVA_VERSION)) + }, + ) + } + + @get:Internal + abstract val applicationDir: DirectoryProperty + + @get:InputFiles + @get:IgnoreEmptyDirectories + @get:PathSensitive(PathSensitivity.RELATIVE) + val applicationSources: FileTree = + objects.fileTree().from(applicationDir).matching { + exclude(".gradle/**", "build/**") + } + + @get:Input + abstract val gradleVersion: Property + + @get:Nested + abstract val javaLauncher: Property + + @get:Input + abstract val tasksToRun: ListProperty + + @get:Input + abstract val buildArguments: ListProperty + + @get:Nested + abstract val projectJars: ListProperty + + @get:OutputDirectory + abstract val applicationBuildDir: DirectoryProperty + + /** Forward a root-build jar as `-P=` into the nested build. */ + fun projectJar(name: String, file: Provider) { + projectJars.add( + objects.newInstance().apply { + propertyName.set(name) + this.file.set(file) + }, + ) + } + + /** Configure additional aspects of the nested build via a typed action. */ + fun projectJar(action: Action) { + projectJars.add( + objects.newInstance().also(action::execute), + ) + } + + @TaskAction + fun runNestedBuild() { + val appDir = applicationDir.get().asFile + val appBuildDirFile = applicationBuildDir.get().asFile + val daemonJavaHome = javaLauncher.get().metadata.installationPath.asFile + + val args = buildList { + add("-PappBuildDir=${appBuildDirFile.absolutePath}") + projectJars.get().forEach { entry -> + add("-P${entry.propertyName.get()}=${entry.file.get().asFile.absolutePath}") + } + addAll(buildArguments.get()) + } + + val connector = GradleConnector.newConnector() + .useGradleVersion(gradleVersion.get()) + .forProjectDirectory(appDir) + + connector.connect().use { connection -> + connection.newBuild() + .forTasks(*tasksToRun.get().toTypedArray()) + .withArguments(args) + .setJavaHome(daemonJavaHome) + .setStandardOutput(System.out) + .setStandardError(System.err) + .run() + } + } +} diff --git a/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/SmokeTestAppExtension.kt b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/SmokeTestAppExtension.kt new file mode 100644 index 00000000000..ccb5ee838db --- /dev/null +++ b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/SmokeTestAppExtension.kt @@ -0,0 +1,214 @@ +package datadog.buildlogic.smoketest + +import org.gradle.api.Action +import org.gradle.api.Project +import org.gradle.api.artifacts.Configuration +import org.gradle.api.file.DirectoryProperty +import org.gradle.api.file.RegularFile +import org.gradle.api.provider.ListProperty +import org.gradle.api.provider.MapProperty +import org.gradle.api.provider.Property +import org.gradle.api.provider.Provider +import org.gradle.api.tasks.TaskProvider +import org.gradle.api.tasks.testing.Test +import org.gradle.jvm.toolchain.JavaLanguageVersion +import org.gradle.jvm.toolchain.JavaLauncher +import org.gradle.jvm.toolchain.JavaToolchainService +import org.gradle.kotlin.dsl.newInstance +import org.gradle.kotlin.dsl.register +import org.gradle.kotlin.dsl.withType +import org.gradle.process.CommandLineArgumentProvider +import java.util.Locale +import javax.inject.Inject + +/** + * Project extension that wires a [NestedGradleBuild] task for a smoke-test application. + * + * The plugin only contributes a task when the consumer calls [application]; if the extension + * stays unconfigured, the plugin is a no-op and consumers can register [NestedGradleBuild] + * directly. + */ +abstract class SmokeTestAppExtension @Inject constructor( + private val project: Project, + javaToolchains: JavaToolchainService, +) { + + /** + * Gradle version used by the nested daemon. Defaults to [DEFAULT_NESTED_GRADLE_VERSION] — + * the version pinned for smoke-test applications whose Spring Boot plugin is incompatible + * with Gradle 9. + */ + abstract val gradleVersion: Property + + /** + * JDK used by the nested daemon. Defaults to a [DEFAULT_NESTED_JAVA_VERSION] toolchain; + * override to pin a different JDK if the nested application's plugin chain requires it. + * The inner build script is responsible for pinning the produced bytecode level (e.g. + * `java { sourceCompatibility = JavaVersion.VERSION_1_8 }`). + */ + abstract val javaLauncher: Property + + /** Directory containing the nested project's `settings.gradle` + sources. */ + abstract val applicationDir: DirectoryProperty + + /** + * Directory the nested build writes its outputs to. The nested build script is expected to + * honour `-PappBuildDir=`; see the existing smoke-test inner builds for the pattern. + */ + abstract val applicationBuildDir: DirectoryProperty + + internal abstract val projectJars: ListProperty + + init { + applicationDir.convention(project.layout.projectDirectory.dir("application")) + applicationBuildDir.convention(project.layout.buildDirectory.dir("application")) + gradleVersion.convention(DEFAULT_NESTED_GRADLE_VERSION) + javaLauncher.convention( + javaToolchains.launcherFor { + languageVersion.set(JavaLanguageVersion.of(DEFAULT_NESTED_JAVA_VERSION)) + }, + ) + } + + /** + * Register the nested-build task and wire the produced artifact into every `Test` task as + * a system property. Calling this triggers task registration; consumers that prefer to + * register [NestedGradleBuild] manually can leave [application] uncalled. + */ + fun application(action: Action) { + val spec = project.objects.newInstance() + action.execute(spec) + val taskName = requireNotNull(spec.taskName.orNull) { + "smokeTestApp.application { taskName = ... } is required" + } + val artifactPath = requireNotNull(spec.artifactPath.orNull) { + "smokeTestApp.application { artifactPath = ... } is required" + } + val sysProperty = requireNotNull(spec.sysProperty.orNull) { + "smokeTestApp.application { sysProperty = ... } is required" + } + val nestedTasks = spec.nestedTasks.orNull?.takeIf { it.isNotEmpty() } ?: listOf(taskName) + + val taskProvider: TaskProvider = + project.tasks.register(taskName) { + applicationDir.set(this@SmokeTestAppExtension.applicationDir) + applicationBuildDir.set(this@SmokeTestAppExtension.applicationBuildDir) + gradleVersion.set(this@SmokeTestAppExtension.gradleVersion) + javaLauncher.set(this@SmokeTestAppExtension.javaLauncher) + tasksToRun.set(nestedTasks) + buildArguments.set(spec.buildArguments) + projectJars.set(this@SmokeTestAppExtension.projectJars) + } + + val artifactProvider: Provider = applicationBuildDir.file(artifactPath) + val extras = spec.additionalSystemProperties.get().mapValues { (_, relativePath) -> + applicationBuildDir.file(relativePath) + } + project.tasks.withType().configureEach { + dependsOn(taskProvider) + jvmArgumentProviders.add(SmokeTestArgProvider(sysProperty, artifactProvider, extras)) + } + } + + /** + * Forward the default `jar` artifact from [sourceProject] into the nested build as + * `-P=`. The jar is consumed via a resolvable [Configuration], + * which both establishes the correct task dependency and lets Gradle resolve the artifact + * lazily — no `evaluationDependsOn` is needed. + */ + fun projectJar(propertyName: String, sourceProject: Project) { + val configurationName = "smokeTestAppExtraJar" + + propertyName.replaceFirstChar { it.titlecase(Locale.ROOT) } + val cfg = project.configurations.maybeCreate(configurationName).apply { + isCanBeConsumed = false + isCanBeResolved = true + isTransitive = false + description = "Jar artifact forwarded as -P$propertyName into the smoke-test nested build" + } + project.dependencies.add(configurationName, sourceProject) + addProjectJarFromConfiguration(propertyName, cfg) + } + + /** + * Lower-level overload for the rare case where the caller already has a provider of the + * file. The caller is responsible for the upstream task dependency. + */ + fun projectJar(propertyName: String, file: Provider) { + projectJars.add( + project.objects.newInstance().apply { + this.propertyName.set(propertyName) + this.file.set(file) + }, + ) + } + + private fun addProjectJarFromConfiguration(propertyName: String, cfg: Configuration) { + projectJars.add( + project.objects.newInstance().apply { + this.propertyName.set(propertyName) + // Configuration.elements yields a Provider that carries the producing task dependency, + // so wiring it into the task's @InputFile both tracks file contents and arranges build + // order. + this.file.set( + cfg.elements.map { files -> + project.objects.fileProperty().fileValue(files.single().asFile).get() + }, + ) + }, + ) + } +} + +/** DSL describing the nested-build invocation for one smoke-test application. */ +abstract class ApplicationSpec @Inject constructor() { + /** Outer task name; the nested daemon runs the same task by default. */ + abstract val taskName: Property + + /** Path to the produced artifact, relative to `applicationBuildDir`. */ + abstract val artifactPath: Property + + /** System property name set on Test tasks to point them at the produced artifact. */ + abstract val sysProperty: Property + + /** Tasks run inside the nested build. Defaults to `[taskName]`. */ + abstract val nestedTasks: ListProperty + + /** Extra arguments passed to the nested Gradle invocation. */ + abstract val buildArguments: ListProperty + + /** + * Additional system properties to forward to every `Test` task, keyed by property name with + * values resolved against `applicationBuildDir`. Use this for smoke tests that need more + * than the single primary artifact path (e.g. a separately unpacked server install). + */ + abstract val additionalSystemProperties: MapProperty +} + +/** + * Default Gradle distribution version for the nested daemon. Pinned to a Gradle 8 release + * because the Spring Boot Gradle plugin pre-3.5.0 calls `Configuration.getUploadTaskName()`, + * removed in Gradle 9. + */ +const val DEFAULT_NESTED_GRADLE_VERSION = "8.14.5" + +/** + * Default JDK language version for the nested daemon. JDK 21 is the version the root build + * requires for Gradle 9; standardising the nested daemon on the same JDK avoids pulling a + * second toolchain onto dev machines and CI runners. Inner build scripts cross-compile down + * to their actual bytecode target via `java { sourceCompatibility = ... }`. + */ +const val DEFAULT_NESTED_JAVA_VERSION = 21 + +private class SmokeTestArgProvider( + private val sysProperty: String, + private val artifact: Provider, + private val extras: Map>, +) : CommandLineArgumentProvider { + override fun asArguments(): Iterable = + buildList { + add("-D$sysProperty=${artifact.get().asFile.absolutePath}") + extras.forEach { (key, value) -> + add("-D$key=${value.get().asFile.absolutePath}") + } + } +} diff --git a/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/SmokeTestAppPlugin.kt b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/SmokeTestAppPlugin.kt new file mode 100644 index 00000000000..b6d6fe6b7ba --- /dev/null +++ b/build-logic/smoke-test/src/main/kotlin/datadog/buildlogic/smoketest/SmokeTestAppPlugin.kt @@ -0,0 +1,21 @@ +package datadog.buildlogic.smoketest + +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.kotlin.dsl.create + +/** + * Exposes the [NestedGradleBuild] task type plus a `smokeTestApp` extension that wires the + * nested-build task and Test-side system properties for a smoke-test application. + * + * Consumers can either: + * - configure `smokeTestApp { application { ... } }` to let the plugin register the task and + * wire it into every `Test` task, or + * - leave the extension untouched and register a [NestedGradleBuild] task manually (for cases + * that need more control, e.g. additional `Exec`-like task wiring). + */ +class SmokeTestAppPlugin : Plugin { + override fun apply(project: Project) { + project.extensions.create("smokeTestApp") + } +} diff --git a/build-logic/smoke-test/src/test/kotlin/datadog/buildlogic/smoketest/SmokeTestAppEndToEndTest.kt b/build-logic/smoke-test/src/test/kotlin/datadog/buildlogic/smoketest/SmokeTestAppEndToEndTest.kt new file mode 100644 index 00000000000..b3ad87bbaf3 --- /dev/null +++ b/build-logic/smoke-test/src/test/kotlin/datadog/buildlogic/smoketest/SmokeTestAppEndToEndTest.kt @@ -0,0 +1,204 @@ +package datadog.buildlogic.smoketest + +import org.assertj.core.api.Assertions.assertThat +import org.gradle.testkit.runner.GradleRunner +import org.gradle.testkit.runner.TaskOutcome +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.io.TempDir +import java.io.File +import java.nio.file.Path + +/** + * End-to-end tests that drive the plugin through the Gradle Test Kit and a temporary, + * self-contained Kotlin-DSL test project. The inner "smoke-test application" is itself a + * minimal Kotlin-DSL Gradle build; the outer build wires it through the `smokeTestApp` DSL. + * + * These tests are slow (each test spins up a Gradle daemon) but they are the only way to + * exercise the Tooling API path end-to-end. + */ +class SmokeTestAppEndToEndTest { + + @TempDir + lateinit var projectDir: Path + + private val outerSettings get() = projectDir.resolve("settings.gradle.kts").toFile() + private val outerBuild get() = projectDir.resolve("build.gradle.kts").toFile() + private val applicationDir get() = projectDir.resolve("application").toFile() + + @BeforeEach + fun setUp() { + applicationDir.mkdirs() + } + + @Test + fun `application block registers a NestedGradleBuild task with the configured name`() { + writeOuterSettings() + outerBuild.writeText( + """ + plugins { + java + id("dd-trace-java.smoke-test-app") + } + + smokeTestApp { + javaLauncher.set( + javaToolchains.launcherFor { languageVersion.set(JavaLanguageVersion.of(${currentMajorJdk()})) } + ) + application { + taskName.set("packageApp") + artifactPath.set("libs/test.jar") + sysProperty.set("test.path") + } + } + """.trimIndent(), + ) + + val result = runner("tasks", "--all").build() + + assertThat(result.output).contains("packageApp") + } + + @Test + fun `nested build produces the configured artifact`() { + writeOuterSettings() + outerBuild.writeText( + """ + plugins { + java + id("dd-trace-java.smoke-test-app") + } + + smokeTestApp { + javaLauncher.set( + javaToolchains.launcherFor { languageVersion.set(JavaLanguageVersion.of(${currentMajorJdk()})) } + ) + application { + taskName.set("buildJar") + artifactPath.set("libs/sample.jar") + sysProperty.set("sample.path") + } + } + """.trimIndent(), + ) + writeInnerSettings() + writeInnerBuild( + """ + tasks.register("buildJar") { + archiveFileName.set("sample.jar") + from(file("src")) + } + """.trimIndent(), + ) + File(applicationDir, "src").mkdir() + File(applicationDir, "src/hello.txt").writeText("hi") + + val result = runner("buildJar").build() + + assertThat(result.task(":buildJar")?.outcome).isEqualTo(TaskOutcome.SUCCESS) + assertThat(File(projectDir.toFile(), "build/application/libs/sample.jar")).exists() + } + + @Test + fun `plugin is a no-op when the application block is never called`() { + writeOuterSettings() + outerBuild.writeText( + """ + plugins { + java + id("dd-trace-java.smoke-test-app") + } + + smokeTestApp { + // No application block, no javaLauncher — should not blow up. + } + """.trimIndent(), + ) + + val result = runner("help").build() + + assertThat(result.output).contains("BUILD SUCCESSFUL") + } + + @Test + fun `manual NestedGradleBuild task registration works without the application block`() { + writeOuterSettings() + outerBuild.writeText( + """ + import datadog.buildlogic.smoketest.NestedGradleBuild + + plugins { + java + id("dd-trace-java.smoke-test-app") + } + + tasks.register("customBuild") { + applicationDir.set(layout.projectDirectory.dir("application")) + applicationBuildDir.set(layout.buildDirectory.dir("application")) + gradleVersion.set(gradle.gradleVersion) + javaLauncher.set( + javaToolchains.launcherFor { languageVersion.set(JavaLanguageVersion.of(${currentMajorJdk()})) } + ) + tasksToRun.set(listOf("buildJar")) + } + """.trimIndent(), + ) + writeInnerSettings() + writeInnerBuild( + """ + tasks.register("buildJar") { + archiveFileName.set("custom.jar") + from(file("src")) + } + """.trimIndent(), + ) + File(applicationDir, "src").mkdir() + File(applicationDir, "src/hello.txt").writeText("hi") + + val result = runner("customBuild").build() + + assertThat(result.task(":customBuild")?.outcome).isEqualTo(TaskOutcome.SUCCESS) + } + + private fun writeOuterSettings() { + outerSettings.writeText( + """ + rootProject.name = "smoke-test-app-fixture" + """.trimIndent(), + ) + } + + private fun writeInnerSettings() { + File(applicationDir, "settings.gradle.kts").writeText( + """ + rootProject.name = "smoke-test-app-fixture-application" + """.trimIndent(), + ) + } + + private fun writeInnerBuild(taskBlock: String) { + File(applicationDir, "build.gradle.kts").writeText( + """ + plugins { + java + } + if (hasProperty("appBuildDir")) { + layout.buildDirectory.set(file(property("appBuildDir") as String)) + } + $taskBlock + """.trimIndent(), + ) + } + + private fun runner(vararg args: String): GradleRunner = + GradleRunner.create() + .withProjectDir(projectDir.toFile()) + .withPluginClasspath() + .withArguments(*args, "--stacktrace") + .forwardOutput() + + private fun currentMajorJdk(): Int = + System.getProperty("java.specification.version").let { + if (it.startsWith("1.")) it.substring(2).toInt() else it.toInt() + } +} diff --git a/build-logic/smoke-test/src/test/kotlin/datadog/buildlogic/smoketest/SmokeTestAppPluginTest.kt b/build-logic/smoke-test/src/test/kotlin/datadog/buildlogic/smoketest/SmokeTestAppPluginTest.kt new file mode 100644 index 00000000000..22fd1ce93fe --- /dev/null +++ b/build-logic/smoke-test/src/test/kotlin/datadog/buildlogic/smoketest/SmokeTestAppPluginTest.kt @@ -0,0 +1,83 @@ +package datadog.buildlogic.smoketest + +import org.assertj.core.api.Assertions.assertThat +import org.gradle.api.plugins.JavaPlugin +import org.gradle.jvm.toolchain.JavaLanguageVersion +import org.gradle.kotlin.dsl.apply +import org.gradle.kotlin.dsl.findByType +import org.gradle.kotlin.dsl.getByType +import org.gradle.kotlin.dsl.withType +import org.gradle.testfixtures.ProjectBuilder +import org.junit.jupiter.api.Test + +/** + * Fast in-process tests that exercise plugin application and extension wiring through + * [ProjectBuilder]. End-to-end task execution lives in [SmokeTestAppEndToEndTest]. + */ +class SmokeTestAppPluginTest { + + @Test + fun `applying the plugin creates the smokeTestApp extension`() { + val project = ProjectBuilder.builder().build() + + project.plugins.apply("dd-trace-java.smoke-test-app") + + assertThat(project.extensions.findByType()).isNotNull + } + + @Test + fun `plugin is a no-op when smokeTestApp_application is never called`() { + val project = ProjectBuilder.builder().build() + + project.plugins.apply("dd-trace-java.smoke-test-app") + + // No task of our type should be registered until `application { }` is invoked. + assertThat(project.tasks.withType()).isEmpty() + } + + @Test + fun `extension defaults applicationDir to projectDir slash application`() { + val project = ProjectBuilder.builder().build() + project.plugins.apply("dd-trace-java.smoke-test-app") + + val extension = project.extensions.getByType() + + assertThat(extension.applicationDir.get().asFile) + .isEqualTo(project.layout.projectDirectory.dir("application").asFile) + } + + @Test + fun `extension defaults applicationBuildDir to buildDir slash application`() { + val project = ProjectBuilder.builder().build() + project.plugins.apply("dd-trace-java.smoke-test-app") + + val extension = project.extensions.getByType() + + assertThat(extension.applicationBuildDir.get().asFile) + .isEqualTo(project.layout.buildDirectory.dir("application").get().asFile) + } + + @Test + fun `extension defaults gradleVersion to the smoke-test pinned version`() { + val project = ProjectBuilder.builder().build() + project.plugins.apply("dd-trace-java.smoke-test-app") + + val extension = project.extensions.getByType() + + assertThat(extension.gradleVersion.get()).isEqualTo(DEFAULT_NESTED_GRADLE_VERSION) + } + + @Test + fun `extension defaults javaLauncher to a JDK 21 toolchain`() { + // JavaToolchainService is contributed by the `java-base` plugin; apply something that + // pulls it in so ProjectBuilder can resolve the convention. + val project = ProjectBuilder.builder().build() + project.apply() + project.plugins.apply("dd-trace-java.smoke-test-app") + + val extension = project.extensions.getByType() + + assertThat(extension.javaLauncher.get().metadata.languageVersion) + .isEqualTo(JavaLanguageVersion.of(DEFAULT_NESTED_JAVA_VERSION)) + } +} diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 6b1916a456f..6abe7896aab 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -4,6 +4,7 @@ # Build develocity = "4.4.1" forbiddenapis = "3.10" +gradle-tooling-api = "8.14.5" spotbugs_annotations = "4.9.8" # DataDog libs and forks @@ -78,6 +79,7 @@ testcontainers = "1.21.4" # Build develocity = { module = "com.gradle:develocity-gradle-plugin", version.ref = "develocity" } forbiddenapis = { module = "de.thetaphi:forbiddenapis", version.ref = "forbiddenapis" } +gradle-tooling-api = { module = "org.gradle:gradle-tooling-api", version.ref = "gradle-tooling-api" } spotbugs-annotations = { module = "com.github.spotbugs:spotbugs-annotations", version.ref = "spotbugs_annotations" } # DataDog libs and forks diff --git a/gradle/repositories.gradle b/gradle/repositories.gradle index 98085e93c50..e7d4824b4c6 100644 --- a/gradle/repositories.gradle +++ b/gradle/repositories.gradle @@ -35,4 +35,12 @@ repositories { includeGroupAndSubgroups "org.springframework" } } + // Hosts gradle-tooling-api, used by build-logic:smoke-test to run nested + // Gradle builds for smoke-test applications pinned to older Gradle versions. + maven { + url = 'https://repo.gradle.org/gradle/libs-releases' + content { + includeGroup "org.gradle" + } + } } diff --git a/settings.gradle.kts b/settings.gradle.kts index bd5aaceffaa..e6c9469b9c6 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -16,7 +16,16 @@ pluginManagement { } gradlePluginPortal() mavenCentral() + // Hosts gradle-tooling-api, a transitive dep of the build-logic:smoke-test plugin used + // to run nested Gradle builds for smoke-test applications pinned to older Gradle versions. + maven { + url = uri("https://repo.gradle.org/gradle/libs-releases") + content { + includeGroup("org.gradle") + } + } } + includeBuild("build-logic") } plugins {