Introduces a convention plugin for testing framework excludes (#9925)

bric3 · web-flow · commit 640a4bd02bba · 2025-11-13T15:26:30.000Z
* chore: Make the testing framework excludes a convention plugin

* fix: PR review
diff --git a/buildSrc/src/main/kotlin/datadog.configure-tests.gradle.kts b/buildSrc/src/main/kotlin/datadog.configure-tests.gradle.kts
@@ -7,10 +7,6 @@ import org.gradle.api.plugins.jvm.JvmTestSuite
 import java.time.Duration
 import java.time.temporal.ChronoUnit
 
-val isTestingInstrumentation = providers.provider { 
-  project.findProperty("testingInstrumentation") as? Boolean ?: false 
-}
-
 // Need concrete implementation of BuildService in Kotlin
 abstract class ForkedTestLimit : BuildService<BuildServiceParameters.None>
 // Forked tests will fail with OOM if the memory is set too high. Gitlab allows at least a limit of 3.
@@ -43,25 +39,6 @@ tasks.withType<Test>().configureEach {
     !rootProject.providers.gradleProperty("rerun.tests.${project.name}").isPresent
   }
 
-  // Avoid executing classes used to test testing frameworks instrumentation
-  if (isTestingInstrumentation.get()) {
-    exclude("**/TestAssumption*", "**/TestSuiteSetUpAssumption*")
-    exclude("**/TestDisableTestTrace*")
-    exclude("**/TestError*")
-    exclude("**/TestFactory*")
-    exclude("**/TestFailed*")
-    exclude("**/TestFailedWithSuccessPercentage*")
-    exclude("**/TestInheritance*", "**/BaseTestInheritance*")
-    exclude("**/TestParameterized*")
-    exclude("**/TestRepeated*")
-    exclude("**/TestSkipped*")
-    exclude("**/TestSkippedClass*")
-    exclude("**/TestSucceed*")
-    exclude("**/TestTemplate*")
-    exclude("**/TestUnskippable*")
-    exclude("**/TestWithSetup*")
-  }
-
   // Split up tests that want to run forked in their own separate JVM for generated tasks
   if (name.startsWith("forkedTest") || name.endsWith("ForkedTest")) {
     setExcludes(emptyList())
diff --git a/buildSrc/src/main/kotlin/datadog.instrumentation.testing-framework-tests.gradle.kts b/buildSrc/src/main/kotlin/datadog.instrumentation.testing-framework-tests.gradle.kts
@@ -0,0 +1,23 @@
+plugins {
+  java
+}
+
+logger.info("Avoid executing classes used to test testing frameworks instrumentation")
+
+tasks.withType<Test>().configureEach {
+  exclude("**/TestAssumption*", "**/TestSuiteSetUpAssumption*")
+  exclude("**/TestDisableTestTrace*")
+  exclude("**/TestError*")
+  exclude("**/TestFactory*")
+  exclude("**/TestFailed*")
+  exclude("**/TestFailedWithSuccessPercentage*")
+  exclude("**/TestInheritance*", "**/BaseTestInheritance*")
+  exclude("**/TestParameterized*")
+  exclude("**/TestRepeated*")
+  exclude("**/TestSkipped*")
+  exclude("**/TestSkippedClass*")
+  exclude("**/TestSucceed*")
+  exclude("**/TestTemplate*")
+  exclude("**/TestUnskippable*")
+  exclude("**/TestWithSetup*")
+}
diff --git a/dd-java-agent/instrumentation/cucumber/build.gradle b/dd-java-agent/instrumentation/cucumber/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 
diff --git a/dd-java-agent/instrumentation/junit/junit-4.10/build.gradle b/dd-java-agent/instrumentation/junit/junit-4.10/build.gradle
@@ -3,10 +3,9 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
 
 plugins {
   id 'org.jetbrains.kotlin.jvm'
+  id 'datadog.instrumentation.testing-framework-tests'
 }
 
-ext.testingInstrumentation = true
-
 apply from: "$rootDir/gradle/java.gradle"
 apply from: "$rootDir/gradle/test-with-kotlin.gradle"
 
diff --git a/dd-java-agent/instrumentation/junit/junit-4.10/cucumber-junit-4/build.gradle b/dd-java-agent/instrumentation/junit/junit-4.10/cucumber-junit-4/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 
diff --git a/dd-java-agent/instrumentation/junit/junit-4.10/junit-4.13/build.gradle b/dd-java-agent/instrumentation/junit/junit-4.10/junit-4.13/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 
diff --git a/dd-java-agent/instrumentation/junit/junit-4.10/munit-junit-4/build.gradle b/dd-java-agent/instrumentation/junit/junit-4.10/munit-junit-4/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 apply plugin: 'scala'
diff --git a/dd-java-agent/instrumentation/junit/junit-5.3/build.gradle b/dd-java-agent/instrumentation/junit/junit-5.3/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 
diff --git a/dd-java-agent/instrumentation/junit/junit-5.3/cucumber-junit-5/build.gradle b/dd-java-agent/instrumentation/junit/junit-5.3/cucumber-junit-5/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 
diff --git a/dd-java-agent/instrumentation/junit/junit-5.3/junit-5.8/build.gradle b/dd-java-agent/instrumentation/junit/junit-5.3/junit-5.8/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 
diff --git a/dd-java-agent/instrumentation/junit/junit-5.3/spock-junit-5/build.gradle b/dd-java-agent/instrumentation/junit/junit-5.3/spock-junit-5/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 
diff --git a/dd-java-agent/instrumentation/karate/build.gradle b/dd-java-agent/instrumentation/karate/build.gradle
@@ -1,5 +1,5 @@
-ext {
-  testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
 }
 
 apply from: "$rootDir/gradle/java.gradle"
diff --git a/dd-java-agent/instrumentation/scalatest/build.gradle b/dd-java-agent/instrumentation/scalatest/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 apply plugin: 'scala'
diff --git a/dd-java-agent/instrumentation/selenium/build.gradle b/dd-java-agent/instrumentation/selenium/build.gradle
@@ -1,9 +1,6 @@
 plugins {
   id 'java-test-fixtures'
-}
-
-ext {
-  testingInstrumentation = true
+  id 'datadog.instrumentation.testing-framework-tests'
 }
 
 apply from: "$rootDir/gradle/java.gradle"
diff --git a/dd-java-agent/instrumentation/testng/testng-6/build.gradle b/dd-java-agent/instrumentation/testng/testng-6/build.gradle
@@ -1,9 +1,8 @@
 plugins {
   id 'java-test-fixtures'
+  id 'datadog.instrumentation.testing-framework-tests'
 }
 
-ext.testingInstrumentation = true
-
 apply from: "$rootDir/gradle/java.gradle"
 
 muzzle {
diff --git a/dd-java-agent/instrumentation/testng/testng-7/build.gradle b/dd-java-agent/instrumentation/testng/testng-7/build.gradle
@@ -1,9 +1,6 @@
 plugins {
   id 'java-test-fixtures'
-}
-
-ext {
-  testingInstrumentation = true
+  id 'datadog.instrumentation.testing-framework-tests'
 }
 
 apply from: "$rootDir/gradle/java.gradle"
diff --git a/dd-java-agent/instrumentation/weaver/build.gradle b/dd-java-agent/instrumentation/weaver/build.gradle
@@ -1,4 +1,6 @@
-ext.testingInstrumentation = true
+plugins {
+  id 'datadog.instrumentation.testing-framework-tests'
+}
 
 apply from: "$rootDir/gradle/java.gradle"
 apply plugin: 'scala'

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,9 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinVersion`
`3`	`3`
`4`	`4`	`plugins {`
`5`	`5`	`id 'org.jetbrains.kotlin.jvm'`
	`6`	`+ id 'datadog.instrumentation.testing-framework-tests'`
`6`	`7`	`}`
`7`	`8`
`8`		`-ext.testingInstrumentation = true`
`9`		`-`
`10`	`9`	`apply from: "$rootDir/gradle/java.gradle"`
`11`	`10`	`apply from: "$rootDir/gradle/test-with-kotlin.gradle"`
`12`	`11`