build(samples): Remove outputs.upToDateWhen { false } from systemTest tasks (#5522)

* build(samples): Remove outputs.upToDateWhen { false } from systemTest tasks

The systemTest tasks in the sample modules forced Gradle to always treat
their outputs as out of date, disabling up-to-date checks and build cache
reuse. Removing this lets Gradle rely on its normal input/output tracking
for the Test tasks.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* build(samples): Track systemTest app archive via convention plugin

The system tests launch the packaged sample (war/shadowJar/bootJar) from
build/libs as a separate process, so the archive is a real input to the
systemTest task even though it is not on the test classpath. Without it,
removing outputs.upToDateWhen { false } would let Gradle mark systemTest
up-to-date while a separate jar build refreshed the artifact, skipping
verification against the rebuilt sample.

Move that wiring into a single io.sentry.systemtest convention plugin in
build-logic instead of repeating it in every sample build file. The
plugin auto-detects the packaging task (war, else shadowJar, else
bootJar), mirroring the selection in test/system-test-runner.py, and
declares its archive as an input and dependency. Each sample just
applies the plugin.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* build(samples): Track OpenTelemetry agent jar as systemTest input

The agent-based OpenTelemetry samples are launched by the runner with
-javaagent:<sentry-opentelemetry-agent>, started outside the test JVM.
That jar is not on the test classpath nor one of the app archives, so
without tracking it systemTest could stay up-to-date and be skipped
while the runner launches a newer agent.

Add a usesOpenTelemetryAgent opt-in to the io.sentry.systemtest plugin;
the three agent samples enable it and the agent jar is then tracked as a
content input. The runner already builds and launches the agent before
invoking the task, so it is tracked by path without a cross-project task
dependency, which keeps it configuration-on-demand and configuration
cache compatible.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: runningcode

build-logic/src/main/kotlin/io.sentry.systemtest.gradle.kts

@@ -0,0 +1,38 @@
+import io.sentry.gradle.SystemTestExtension
+import org.gradle.api.tasks.ClasspathNormalizer
+
+val systemTest = extensions.create<SystemTestExtension>("sentrySystemTest")
+
+// The sample system tests launch the packaged app (war/shadowJar/bootJar) from build/libs as a
+// separate process, so the archive is a real input even though it is not on the test classpath.
+// Agent-based samples are additionally launched with -javaagent:<otel agent>, another runtime
+// input not on the classpath. See test/system-test-runner.py.
+tasks.matching { it.name == "systemTest" }.configureEach {
+  val archiveTask =
+    listOf("war", "shadowJar", "bootJar").firstOrNull { it in tasks.names }
+      ?: throw GradleException(
+        "io.sentry.systemtest is applied to $path but none of war/shadowJar/bootJar " +
+          "exist to provide the launched app archive for the systemTest task"
+      )
+  // Declaring the archive as an input also wires the dependency on its producing task.
+  inputs
+    .files(tasks.named(archiveTask))
+    .withPropertyName("appArchive")
+    .withNormalizer(ClasspathNormalizer::class.java)
+
+  if (systemTest.usesOpenTelemetryAgent.get()) {
+    // The runner builds the agent and launches the app with -javaagent before invoking this task,
+    // so the agent jar is tracked for content only (by path, no cross-project task dependency): a
+    // change to it makes systemTest out of date even though it runs outside the test JVM.
+    val version = providers.gradleProperty("versionName").get()
+    inputs
+      .files(
+        rootProject.layout.projectDirectory.file(
+          "sentry-opentelemetry/sentry-opentelemetry-agent/build/libs/" +
+            "sentry-opentelemetry-agent-$version.jar"
+        )
+      )
+      .withPropertyName("openTelemetryAgent")
+      .withNormalizer(ClasspathNormalizer::class.java)
+  }
+}

build-logic/src/main/kotlin/io/sentry/gradle/SystemTestExtension.kt

@@ -0,0 +1,17 @@
+package io.sentry.gradle
+
+import org.gradle.api.provider.Property
+
+/** Configuration for the `io.sentry.systemtest` convention plugin. */
+abstract class SystemTestExtension {
+  /**
+   * Set to `true` for samples that the system-test runner launches with the Sentry OpenTelemetry
+   * Java agent (`-javaagent`). The agent jar is then tracked as a `systemTest` input so the task
+   * re-runs when the agent changes, even though it is started outside the test JVM.
+   */
+  abstract val usesOpenTelemetryAgent: Property<Boolean>
+
+  init {
+    usesOpenTelemetryAgent.convention(false)
+  }
+}

sentry-samples/sentry-samples-console-opentelemetry-noagent/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.jvm)
   alias(libs.plugins.gradle.versions)
   alias(libs.plugins.shadow)
+  id("io.sentry.systemtest")
 }
 
 application { mainClass.set("io.sentry.samples.console.Main") }
@@ -71,8 +72,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test

sentry-samples/sentry-samples-console-otlp/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.jvm)
   alias(libs.plugins.gradle.versions)
   alias(libs.plugins.shadow)
+  id("io.sentry.systemtest")
 }
 
 application { mainClass.set("io.sentry.samples.console.Main") }
@@ -74,8 +75,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test

sentry-samples/sentry-samples-console/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.jvm)
   alias(libs.plugins.gradle.versions)
   alias(libs.plugins.shadow)
+  id("io.sentry.systemtest")
 }
 
 application { mainClass.set("io.sentry.samples.console.Main") }
@@ -75,8 +76,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test

sentry-samples/sentry-samples-jul/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.jvm)
   alias(libs.plugins.gradle.versions)
   alias(libs.plugins.shadow)
+  id("io.sentry.systemtest")
 }
 
 application { mainClass.set("io.sentry.samples.jul.Main") }
@@ -66,8 +67,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test

sentry-samples/sentry-samples-log4j2/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.jvm)
   alias(libs.plugins.gradle.versions)
   alias(libs.plugins.shadow)
+  id("io.sentry.systemtest")
 }
 
 application { mainClass.set("io.sentry.samples.log4j2.Main") }
@@ -72,8 +73,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test

sentry-samples/sentry-samples-logback/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.jvm)
   alias(libs.plugins.gradle.versions)
   alias(libs.plugins.shadow)
+  id("io.sentry.systemtest")
 }
 
 application { mainClass.set("io.sentry.samples.logback.Main") }
@@ -66,8 +67,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test

sentry-samples/sentry-samples-spring-7/build.gradle.kts

@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.kotlin.spring)
   id("war")
   alias(libs.plugins.gretty)
+  id("io.sentry.systemtest")
 }
 
 application { mainClass.set("io.sentry.samples.spring7.Main") }
@@ -77,8 +78,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test

sentry-samples/sentry-samples-spring-boot-4-opentelemetry-noagent/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.spring.dependency.management)
   alias(libs.plugins.kotlin.jvm)
   alias(libs.plugins.kotlin.spring)
+  id("io.sentry.systemtest")
 }
 
 group = "io.sentry.sample.spring-boot-4"
@@ -90,8 +91,6 @@ tasks.register<Test>("systemTest").configure {
   testClassesDirs = test.output.classesDirs
   classpath = test.runtimeClasspath
 
-  outputs.upToDateWhen { false }
-
   maxParallelForks = 1
 
   // Cap JVM args per test