Move ProcessStarter to separate source set to allow reuse

junit-team · Nov 28, 2024 · 33679e7 · 33679e7
1 parent 79c2cdc
commit 33679e7
Show file tree

Hide file tree

Showing 23 changed files with 68 additions and 31 deletions.
diff --git a/platform-tests/platform-tests.gradle.kts b/platform-tests/platform-tests.gradle.kts
@@ -1,3 +1,5 @@
+
+import junitbuild.extensions.capitalized
 import org.gradle.api.tasks.PathSensitivity.NONE
 import org.gradle.api.tasks.PathSensitivity.RELATIVE
 import org.gradle.internal.os.OperatingSystem
@@ -9,6 +11,18 @@ plugins {
 	id("junitbuild.jmh-conventions")
 }
 
+val processStarter by sourceSets.creating {
+	java {
+		srcDir("src/processStarter/java")
+	}
+}
+
+java {
+	registerFeature(processStarter.name) {
+		usingSourceSet(processStarter)
+	}
+}
+
 dependencies {
 	// --- Things we are testing --------------------------------------------------
 	testImplementation(projects.junitPlatformCommons)
@@ -37,16 +51,32 @@ dependencies {
 	testImplementation(libs.bundles.xmlunit)
 	testImplementation(testFixtures(projects.junitJupiterApi))
 	testImplementation(testFixtures(projects.junitPlatformReporting))
+	testImplementation(projects.platformTests) {
+		capabilities {
+			requireFeature("process-starter")
+		}
+	}
 
 	// --- Test run-time dependencies ---------------------------------------------
 	testRuntimeOnly(projects.junitVintageEngine)
 	testRuntimeOnly(libs.groovy4) {
 		because("`ReflectionUtilsTests.findNestedClassesWithInvalidNestedClassFile` needs it")
 	}
 
-	// --- https://openjdk.java.net/projects/code-tools/jmh/ -----------------------
+	// --- https://openjdk.java.net/projects/code-tools/jmh/ ----------------------
 	jmh(projects.junitJupiterApi)
 	jmh(libs.junit4)
+
+	// --- ProcessStarter dependencies --------------------------------------------
+	processStarter.implementationConfigurationName(libs.groovy4) {
+		because("it provides convenience methods to handle process output")
+	}
+	processStarter.implementationConfigurationName(libs.commons.io) {
+		because("it uses TeeOutputStream")
+	}
+	processStarter.implementationConfigurationName(libs.opentest4j) {
+		because("it throws TestAbortedException")
+	}
 }
 
 jmh {
@@ -80,6 +110,12 @@ tasks {
 			includeTags("junit4")
 		}
 	}
+	named<JavaCompile>(processStarter.compileJavaTaskName).configure {
+		options.release = 21
+	}
+	named<Checkstyle>("checkstyle${processStarter.name.capitalized()}").configure {
+		config = resources.text.fromFile(checkstyle.configDirectory.file("checkstyleMain.xml"))
+	}
 }
 
 eclipse {

diff --git a/...ooling/support/process/ProcessResult.java → ...platform/tests/process/ProcessResult.java b/...ooling/support/process/ProcessResult.java → ...platform/tests/process/ProcessResult.java
@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package platform.tooling.support.process;
+package org.junit.platform.tests.process;
 
 import java.util.List;
 

diff --git a/...oling/support/process/ProcessStarter.java → ...latform/tests/process/ProcessStarter.java b/...oling/support/process/ProcessStarter.java → ...latform/tests/process/ProcessStarter.java
@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package platform.tooling.support.process;
+package org.junit.platform.tests.process;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;

diff --git a/...ooling/support/process/WatchedOutput.java → ...platform/tests/process/WatchedOutput.java b/...ooling/support/process/WatchedOutput.java → ...platform/tests/process/WatchedOutput.java
@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package platform.tooling.support.process;
+package org.junit.platform.tests.process;
 
 import java.io.ByteArrayOutputStream;
 import java.nio.charset.Charset;

diff --git a/...oling/support/process/WatchedProcess.java → ...latform/tests/process/WatchedProcess.java b/...oling/support/process/WatchedProcess.java → ...latform/tests/process/WatchedProcess.java
@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package platform.tooling.support.process;
+package org.junit.platform.tests.process;
 
 public class WatchedProcess {
 

diff --git a/...tooling/support/process/package-info.java → .../platform/tests/process/package-info.java b/...tooling/support/process/package-info.java → .../platform/tests/process/package-info.java
@@ -4,4 +4,4 @@
  * @since 1.12
  */
 
-package platform.tooling.support.process;
+package org.junit.platform.tests.process;
diff --git a/platform-tooling-support-tests/platform-tooling-support-tests.gradle.kts b/platform-tooling-support-tests/platform-tooling-support-tests.gradle.kts
@@ -47,11 +47,13 @@ dependencies {
 	implementation(libs.commons.io) {
 		because("moving/deleting directory trees")
 	}
-	implementation(libs.groovy4) {
-		because("it provides convenience methods to handle process output")
+	implementation(projects.platformTests) {
+		capabilities {
+			requireFeature("process-starter")
+		}
 	}
 	implementation(projects.junitJupiterApi) {
-		because("it throws TestAbortedException to abort tests and uses the OS enum")
+		because("it uses the OS enum to support Windows")
 	}
 
 	testImplementation(libs.archunit) {

diff --git a/...ling/support/process/ProcessStarters.java → ...form/tooling/support/ProcessStarters.java b/...ling/support/process/ProcessStarters.java → ...form/tooling/support/ProcessStarters.java
@@ -8,16 +8,15 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package platform.tooling.support.process;
+package platform.tooling.support;
 
 import java.nio.file.Path;
 import java.util.Optional;
 
 import org.junit.jupiter.api.condition.OS;
+import org.junit.platform.tests.process.ProcessStarter;
 import org.opentest4j.TestAbortedException;
 
-import platform.tooling.support.Helper;
-
 public class ProcessStarters {
 
 	public static ProcessStarter java() {

diff --git a/...m-tooling-support-tests/src/test/java/platform/tooling/support/tests/AntStarterTests.java b/...m-tooling-support-tests/src/test/java/platform/tooling/support/tests/AntStarterTests.java
@@ -23,7 +23,7 @@
 import org.junit.jupiter.api.Timeout;
 import org.junit.jupiter.api.io.TempDir;
 
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.3

diff --git a/...oling-support-tests/src/test/java/platform/tooling/support/tests/GraalVmStarterTests.java b/...oling-support-tests/src/test/java/platform/tooling/support/tests/GraalVmStarterTests.java
@@ -25,7 +25,7 @@
 import org.junit.jupiter.api.io.TempDir;
 
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.9.1

diff --git a/...pport-tests/src/test/java/platform/tooling/support/tests/GradleKotlinExtensionsTests.java b/...pport-tests/src/test/java/platform/tooling/support/tests/GradleKotlinExtensionsTests.java
@@ -22,7 +22,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.3

diff --git a/...-support-tests/src/test/java/platform/tooling/support/tests/GradleMissingEngineTests.java b/...-support-tests/src/test/java/platform/tooling/support/tests/GradleMissingEngineTests.java
@@ -23,7 +23,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.3

diff --git a/...ooling-support-tests/src/test/java/platform/tooling/support/tests/GradleStarterTests.java b/...ooling-support-tests/src/test/java/platform/tooling/support/tests/GradleStarterTests.java
@@ -24,7 +24,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.3

diff --git a/...ng-support-tests/src/test/java/platform/tooling/support/tests/JarDescribeModuleTests.java b/...ng-support-tests/src/test/java/platform/tooling/support/tests/JarDescribeModuleTests.java
@@ -24,7 +24,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.3

diff --git a/...tooling-support-tests/src/test/java/platform/tooling/support/tests/JavaVersionsTests.java b/...tooling-support-tests/src/test/java/platform/tooling/support/tests/JavaVersionsTests.java
@@ -13,7 +13,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assumptions.assumeTrue;
-import static platform.tooling.support.process.ProcessStarters.currentJdkHome;
+import static platform.tooling.support.ProcessStarters.currentJdkHome;
 import static platform.tooling.support.tests.Projects.copyToWorkspace;
 
 import java.nio.file.Path;
@@ -25,7 +25,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.4

diff --git a/...tooling-support-tests/src/test/java/platform/tooling/support/tests/MavenStarterTests.java b/...tooling-support-tests/src/test/java/platform/tooling/support/tests/MavenStarterTests.java
@@ -24,7 +24,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.3

diff --git a/...t-tests/src/test/java/platform/tooling/support/tests/MavenSurefireCompatibilityTests.java b/...t-tests/src/test/java/platform/tooling/support/tests/MavenSurefireCompatibilityTests.java
@@ -25,7 +25,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.9.2

diff --git a/...ing-support-tests/src/test/java/platform/tooling/support/tests/ModularUserGuideTests.java b/...ing-support-tests/src/test/java/platform/tooling/support/tests/ModularUserGuideTests.java
@@ -33,8 +33,8 @@
 import org.junit.platform.launcher.LauncherConstants;
 
 import platform.tooling.support.MavenRepo;
+import platform.tooling.support.ProcessStarters;
 import platform.tooling.support.ThirdPartyJars;
-import platform.tooling.support.process.ProcessStarters;
 
 /**
  * @since 1.5

diff --git a/...ling-support-tests/src/test/java/platform/tooling/support/tests/MultiReleaseJarTests.java b/...ling-support-tests/src/test/java/platform/tooling/support/tests/MultiReleaseJarTests.java
@@ -24,7 +24,7 @@
 import org.junit.jupiter.api.io.TempDir;
 
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.4

diff --git a/...port-tests/src/test/java/platform/tooling/support/tests/ReflectionCompatibilityTests.java b/...port-tests/src/test/java/platform/tooling/support/tests/ReflectionCompatibilityTests.java
@@ -23,7 +23,7 @@
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 /**
  * @since 1.11

diff --git a/...m-tooling-support-tests/src/test/java/platform/tooling/support/tests/StandaloneTests.java b/...m-tooling-support-tests/src/test/java/platform/tooling/support/tests/StandaloneTests.java
@@ -37,13 +37,13 @@
 import org.junit.jupiter.api.TestMethodOrder;
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.api.parallel.Execution;
+import org.junit.platform.tests.process.ProcessResult;
 import org.opentest4j.TestAbortedException;
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
+import platform.tooling.support.ProcessStarters;
 import platform.tooling.support.ThirdPartyJars;
-import platform.tooling.support.process.ProcessResult;
-import platform.tooling.support.process.ProcessStarters;
 
 /**
  * @since 1.4

diff --git a/...ort-tests/src/test/java/platform/tooling/support/tests/VintageGradleIntegrationTests.java b/...ort-tests/src/test/java/platform/tooling/support/tests/VintageGradleIntegrationTests.java
@@ -19,12 +19,12 @@
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
+import org.junit.platform.tests.process.ProcessResult;
 import org.opentest4j.TestAbortedException;
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessResult;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 class VintageGradleIntegrationTests {
 

diff --git a/...port-tests/src/test/java/platform/tooling/support/tests/VintageMavenIntegrationTests.java b/...port-tests/src/test/java/platform/tooling/support/tests/VintageMavenIntegrationTests.java
@@ -19,12 +19,12 @@
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
+import org.junit.platform.tests.process.ProcessResult;
 import org.opentest4j.TestAbortedException;
 
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
-import platform.tooling.support.process.ProcessResult;
-import platform.tooling.support.process.ProcessStarters;
+import platform.tooling.support.ProcessStarters;
 
 class VintageMavenIntegrationTests {