chore: use testFixtures sourceset instead of depending on all the tes…

…t classes

This change enables cleaner separation between "actual tests" and "support classes for the tests".

For instance, `:src:core` might provide dummy samplers like `ThreadSleep` for testing purposes.
`ThreadSleep` would depend on `src/test/main` (since it would `extend AbstractSampler`),
 and other modules (e.g. tests in `:src:protocols:http`) might need that `ThreadSleep` sampler.

It won't be practical to create `core-testkit` modules for every module,
so we move those reusable test classes to `testFixtures/...` source set.

See https://docs.gradle.org/current/userguide/java_testing.html#sec:java_test_fixtures

build-logic/build-parameters/build.gradle.kts

@@ -65,6 +65,10 @@ buildParameters {
         defaultValue.set(true)
         description.set("Skip forbidden-apis verifications")
     }
+    bool("suppressPomMetadataWarnings") {
+        defaultValue.set(true)
+        description.set("Skip suppressPomMetadataWarningsFor warnings triggered by inability to map test fixtures dependences to Maven pom.xml")
+    }
     bool("enableErrorprone") {
         // By default, disable errorProne in CI so we don't perform the same checks in several jobs
         defaultValue.set(System.getenv("CI") != "true")

build-logic/jvm/src/main/kotlin/build-logic.java.gradle.kts

@@ -55,6 +55,9 @@ dependencies {
     }
     findProject(":src:bom-testing")?.let{
         testImplementation(platform(it))
+        plugins.withId("java-test-fixtures") {
+            "testFixturesImplementation"(platform(it))
+        }
     }
     findProject(":src:bom-thirdparty")?.let{
         api(platform(it))
@@ -149,22 +152,3 @@ tasks.configureEach<Jar> {
         attributes["Implementation-Version"] = rootProject.version
     }
 }
-
-// <editor-fold defaultstate="collapsed" desc="TODO: remove dependencies between testClasses of the different projects">
-val testClasses by configurations.creating {
-}
-
-if (file("src/test").isDirectory) {
-    // Do not generate test jars when src/test folder is missing (e.g. "config.jar")
-    val testJar by tasks.registering(Jar::class) {
-        val sourceSets: SourceSetContainer by project
-        archiveClassifier.set("test")
-        from(sourceSets["test"].output)
-    }
-
-    // Parenthesis needed to use Project#getArtifacts
-    (artifacts) {
-        testClasses(testJar)
-    }
-}
-// </editor-fold>

build-logic/publishing/src/main/kotlin/build-logic.publish-to-central.gradle.kts

@@ -17,13 +17,18 @@
 
 plugins {
     id("maven-publish")
+    id("build-logic.build-params")
     id("build-logic.publish-to-tmp-maven-repo")
 }
 
 val repoUrl = "https://github.com/apache/jmeter"
 
 publishing {
     publications.withType<MavenPublication>().configureEach {
+        if (buildParameters.suppressPomMetadataWarnings) {
+            suppressPomMetadataWarningsFor("testFixturesApiElements")
+            suppressPomMetadataWarningsFor("testFixturesRuntimeElements")
+        }
         // Use the resolved versions in pom.xml
         // Gradle might have different resolution rules, so we set the versions
         // that were used in Gradle build/test.

src/components/build.gradle.kts

@@ -21,7 +21,7 @@ plugins {
 
 dependencies {
     api(projects.src.core)
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 
     api("org.apache-extras.beanshell:bsh") {
         because(

src/core/build.gradle.kts

@@ -19,13 +19,14 @@ import com.github.autostyle.gradle.AutostyleTask
 import com.github.vlsi.gradle.ide.IdeExtension
 
 plugins {
+    id("java-test-fixtures")
     id("build-logic.jvm-published-library")
 }
 
 dependencies {
     api(projects.src.launcher)
     api(projects.src.jorphan)
-    testImplementation(project(":src:jorphan", "testClasses"))
+    testImplementation(testFixtures(projects.src.jorphan))
 
     api("bsf:bsf") {
         because("protected BSFManager BSFTestElement#getManager()")
@@ -120,6 +121,12 @@ dependencies {
 
     testImplementation("commons-net:commons-net")
     testRuntimeOnly("org.spockframework:spock-core")
+
+    testFixturesApi(testFixtures(projects.src.jorphan))
+    testFixturesImplementation("junit:junit")
+    testFixturesImplementation("org.spockframework:spock-core")
+    testFixturesImplementation(projects.src.testkit)
+    testFixturesImplementation("org.junit.jupiter:junit-jupiter")
 }
 
 val generatedVersionDir = File(buildDir, "generated/sources/version")

src/dist-check/build.gradle.kts

@@ -21,6 +21,7 @@ import org.apache.jmeter.buildtools.batchtest.BatchTestServer
 import java.time.Duration
 
 plugins {
+    id("java-test-fixtures")
     id("build-logic.batchtest")
     id("com.github.vlsi.gradle-extensions")
     id("build-logic.jvm-library")
@@ -31,7 +32,8 @@ val loggingClasspath by configurations.creating
 
 dependencies {
     api(projects.src.dist)
-    testImplementation(project(":src:dist", "allTestClasses"))
+
+    testImplementation(testFixtures(projects.src.core))
     testImplementation("org.apache.commons:commons-lang3") {
         because("StringUtils")
     }

src/dist/build.gradle.kts

@@ -80,17 +80,11 @@ val srcLicense by configurations.creating {
     isCanBeConsumed = false
 }
 
-val allTestClasses by configurations.creating {
-    isCanBeConsumed = true
-    isCanBeResolved = false
-}
-
 // Note: you can inspect final classpath (list of jars in the binary distribution)  via
 // gw dependencies --configuration runtimeClasspath
 dependencies {
     for (p in jars) {
         api(project(p))
-        allTestClasses(project(p, "testClasses"))
     }
 
     binLicense(project(":src:licenses", "binLicense"))

src/functions/build.gradle.kts

@@ -21,7 +21,7 @@ plugins {
 
 dependencies {
     api(projects.src.components)
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 
     implementation("org.mozilla:rhino")
     implementation("commons-codec:commons-codec")

src/jorphan/build.gradle.kts

@@ -16,6 +16,7 @@
  */
 
 plugins {
+    id("java-test-fixtures")
     id("build-logic.jvm-published-library")
 }
 
@@ -28,4 +29,6 @@ dependencies {
     implementation("org.apache.commons:commons-lang3")
     implementation("org.apache.commons:commons-math3")
     implementation("org.apache.commons:commons-text")
+
+    testFixturesImplementation("org.junit.jupiter:junit-jupiter")
 }

src/protocol/bolt/build.gradle.kts

@@ -27,5 +27,5 @@ dependencies {
     implementation("com.fasterxml.jackson.core:jackson-core")
     implementation("com.fasterxml.jackson.core:jackson-databind")
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/ftp/build.gradle.kts

@@ -30,5 +30,5 @@ dependencies {
         because("StringUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/http/build.gradle.kts

@@ -25,7 +25,6 @@ dependencies {
     api(projects.src.components) {
         because("we need SearchTextExtension")
     }
-    testImplementation(project(":src:components", "testClasses"))
 
     api("com.thoughtworks.xstream:xstream") {
         because("HTTPResultConverter uses XStream in public API")
@@ -77,6 +76,7 @@ dependencies {
     implementation("com.miglayout:miglayout-swing")
     implementation("com.fasterxml.jackson.core:jackson-core")
     implementation("com.fasterxml.jackson.core:jackson-databind")
+    testImplementation(testFixtures(projects.src.core))
     testImplementation(testFixtures(projects.src.testkitWiremock))
     testImplementation("com.github.tomakehurst:wiremock-jre8")
     // For some reason JMeter bundles just tika-core and tika-parsers without transitive
@@ -87,6 +87,4 @@ dependencies {
     runtimeOnly("org.apache.tika:tika-parsers") {
         isTransitive = false
     }
-
-    testImplementation(project(":src:core", "testClasses"))
 }

src/protocol/java/build.gradle.kts

@@ -29,7 +29,7 @@ dependencies {
         because("IOUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
     testImplementation(projects.src.functions) {
         because("We need __counter function for tests")
     }

src/protocol/jdbc/build.gradle.kts

@@ -30,5 +30,5 @@ dependencies {
         because("IOUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/jms/build.gradle.kts

@@ -22,7 +22,6 @@ plugins {
 dependencies {
     api(projects.src.core)
 
-    testImplementation(project(":src:core", "testClasses"))
     api("com.github.ben-manes.caffeine:caffeine") {
         because("MessageRenderer#getValueFromFile(..., caffeine.cache.Cache)")
     }
@@ -37,5 +36,5 @@ dependencies {
     }
     implementation("com.miglayout:miglayout-swing")
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/junit-sample/build.gradle.kts

@@ -24,5 +24,5 @@ dependencies {
 
     api("junit:junit")
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/junit/build.gradle.kts

@@ -31,5 +31,5 @@ dependencies {
     }
     implementation("com.miglayout:miglayout-swing")
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/ldap/build.gradle.kts

@@ -29,5 +29,5 @@ dependencies {
         because("StringUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/mail/build.gradle.kts

@@ -37,5 +37,5 @@ dependencies {
         because("IOUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/mongodb/build.gradle.kts

@@ -27,5 +27,5 @@ dependencies {
         because("StringUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/native/build.gradle.kts

@@ -26,5 +26,5 @@ dependencies {
         because("StringUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

src/protocol/tcp/build.gradle.kts

@@ -29,5 +29,5 @@ dependencies {
         because("IOUtils")
     }
 
-    testImplementation(project(":src:core", "testClasses"))
+    testImplementation(testFixtures(projects.src.core))
 }

xdocs/usermanual/jmeter_tutorial.xml

@@ -97,6 +97,7 @@ The folders inside of <code>apache-jmeter</code>
   <dt><code>lib/ext</code></dt><dd>contains the core jar files for JMeter and the protocols</dd>
   <dt><code>src</code></dt><dd>contains subdirectory for each protocol and component</dd>
   <dt><code>src/*/test</code></dt><dd>unit test related directory</dd>
+  <dt><code>src/testFixtures</code></dt><dd>Directory that contains test-related code that might be reused in other modules</dd>
   <dt><code>xdocs</code></dt><dd>XML files for documentation. JMeter generates its documentation from XML.</dd>
 </dl>