refactor: allow tests to have multiple tags

Author: simschla

app/build.gradle

@@ -40,6 +40,7 @@ tasks.withType(Test).configureEach {
 		if (project.hasProperty('agent')) {
 			it.inputs.property('agent', project.property('agent')) // make sure to re-run tests if agent changes
 		}
+		it.systemProperty 'spotless.cli.inSameThread', 'true' //mark tests
 	}
 	if (it.name == 'testCliProcess' || it.name == 'testCliProcessNpm') {
 		it.dependsOn('shadowJar')

app/src/test/java/com/diffplug/spotless/cli/CLIIntegrationHarness.java

@@ -16,16 +16,25 @@
 package com.diffplug.spotless.cli;
 
 import java.io.IOException;
+import java.util.Set;
+import java.util.stream.Stream;
 
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.condition.EnabledIf;
 
 import com.diffplug.spotless.ResourceHarness;
-import com.diffplug.spotless.tag.CliNativeNpmTest;
-import com.diffplug.spotless.tag.CliNativeTest;
-import com.diffplug.spotless.tag.CliProcessNpmTest;
-import com.diffplug.spotless.tag.CliProcessTest;
 
+@EnabledIf("testEnvIsMatching")
 public abstract class CLIIntegrationHarness extends ResourceHarness {
+    protected static final String SYSPROP_CLI_NATIVE =
+            SpotlessCLIRunnerInNativeExternalProcess.SPOTLESS_CLI_NATIVE_IMAGE_SYSPROP;
+    protected static final String SYSPROP_CLI_SHADOW_JAR =
+            SpotlessCLIRunnerInExternalJavaProcess.SPOTLESS_CLI_SHADOW_JAR_SYSPROP;
+    protected static final String SYSPROP_CLI_IN_SAME_THREAD =
+            SpotlessCLIRunnerInSameThread.SPOTLESS_CLI_IN_SAME_THREAD;
+
+    protected static final Set<String> SYS_PROPS =
+            Set.of(SYSPROP_CLI_NATIVE, SYSPROP_CLI_SHADOW_JAR, SYSPROP_CLI_IN_SAME_THREAD);
 
     /**
      * Each test gets its own temp folder, and we create a gradle
@@ -47,20 +56,32 @@ void gitAttributes() throws IOException {
     }
 
     protected SpotlessCLIRunner cliRunner() {
-        return createRunnerForTag().withWorkingDir(rootFolder());
+        return createRunnerBasedOnSysprop().withWorkingDir(rootFolder());
     }
 
-    protected SpotlessCLIRunner createRunnerForTag() {
-        CliProcessTest cliProcessTest = getClass().getAnnotation(CliProcessTest.class);
-        CliProcessNpmTest cliProcessNpmTest = getClass().getAnnotation(CliProcessNpmTest.class);
-        if (cliProcessTest != null || cliProcessNpmTest != null) {
+    protected SpotlessCLIRunner createRunnerBasedOnSysprop() {
+        if (System.getProperties().containsKey(SYSPROP_CLI_NATIVE)) {
+            return SpotlessCLIRunner.createNative();
+        }
+        if (System.getProperties().containsKey(SYSPROP_CLI_SHADOW_JAR)) {
             return SpotlessCLIRunner.createExternalProcess();
         }
-        CliNativeTest cliNativeTest = getClass().getAnnotation(CliNativeTest.class);
-        CliNativeNpmTest cliNativeNpmTest = getClass().getAnnotation(CliNativeNpmTest.class);
-        if (cliNativeTest != null || cliNativeNpmTest != null) {
-            return SpotlessCLIRunner.createNative();
+        if (System.getProperties().containsKey(SYSPROP_CLI_IN_SAME_THREAD)) {
+            return SpotlessCLIRunner.create();
         }
-        return SpotlessCLIRunner.create();
+        throw new IllegalStateException("Runner created without specifying mode, this is a setup issue.");
+    }
+
+    static boolean testEnvIsMatching() {
+        return SYS_PROPS.stream().anyMatch(p -> System.getProperties().containsKey(p));
+    }
+
+    protected static boolean isInExternalProcess() {
+        return Stream.of(SYSPROP_CLI_NATIVE, SYSPROP_CLI_SHADOW_JAR)
+                .anyMatch(p -> System.getProperties().containsKey(p));
+    }
+
+    protected static boolean isInSameThread() {
+        return System.getProperties().containsKey(SYSPROP_CLI_IN_SAME_THREAD);
     }
 }

app/src/test/java/com/diffplug/spotless/cli/SpotlessCLIHelpAndVersionTest.java

@@ -17,8 +17,13 @@
 
 import org.junit.jupiter.api.Test;
 
+import com.diffplug.spotless.tag.CliNativeTest;
+import com.diffplug.spotless.tag.CliProcessTest;
+
 import static org.assertj.core.api.Assertions.assertThat;
 
+@CliProcessTest
+@CliNativeTest
 public class SpotlessCLIHelpAndVersionTest extends CLIIntegrationHarness {
 
     @Test

app/src/test/java/com/diffplug/spotless/cli/SpotlessCLILoggingJavaProcessTest.java

@@ -20,11 +20,15 @@
 
 import org.assertj.core.api.SoftAssertions;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.DisabledIf;
 
 import com.diffplug.spotless.cli.steps.GoogleJavaFormat;
+import com.diffplug.spotless.tag.CliNativeTest;
 import com.diffplug.spotless.tag.CliProcessTest;
 
 @CliProcessTest
+@CliNativeTest
+@DisabledIf(value = "isInSameThread", disabledReason = "Only run as external process")
 public class SpotlessCLILoggingJavaProcessTest extends CLIIntegrationHarness {
 
     public static final String NEEDS_REFORMATTING_STATEMENT = "needs reformatting";

app/src/test/java/com/diffplug/spotless/cli/SpotlessCLIModeTest.java

@@ -20,9 +20,13 @@
 import org.junit.jupiter.api.Test;
 
 import com.diffplug.spotless.cli.steps.GoogleJavaFormat;
+import com.diffplug.spotless.tag.CliNativeTest;
+import com.diffplug.spotless.tag.CliProcessTest;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+@CliNativeTest
+@CliProcessTest
 public class SpotlessCLIModeTest extends CLIIntegrationHarness {
 
     @Test

app/src/test/java/com/diffplug/spotless/cli/SpotlessCLIRunnerInExternalJavaProcess.java

@@ -23,7 +23,7 @@
 
 public class SpotlessCLIRunnerInExternalJavaProcess extends SpotlessCLIRunner {
 
-    private static final String SPOTLESS_CLI_SHADOW_JAR_SYSPROP = "spotless.cli.shadowJar";
+    static final String SPOTLESS_CLI_SHADOW_JAR_SYSPROP = "spotless.cli.shadowJar";
 
     public SpotlessCLIRunnerInExternalJavaProcess() {
         super();

app/src/test/java/com/diffplug/spotless/cli/SpotlessCLIRunnerInNativeExternalProcess.java

@@ -23,7 +23,7 @@
 
 public class SpotlessCLIRunnerInNativeExternalProcess extends SpotlessCLIRunner {
 
-    private static final String SPOTLESS_CLI_NATIVE_IMAGE_SYSPROP = "spotless.cli.nativeImage";
+    static final String SPOTLESS_CLI_NATIVE_IMAGE_SYSPROP = "spotless.cli.nativeImage";
 
     public SpotlessCLIRunnerInNativeExternalProcess() {
         super();

app/src/test/java/com/diffplug/spotless/cli/SpotlessCLIRunnerInSameThread.java

@@ -23,6 +23,8 @@
 
 public class SpotlessCLIRunnerInSameThread extends SpotlessCLIRunner {
 
+    static final String SPOTLESS_CLI_IN_SAME_THREAD = "spotless.cli.inSameThread";
+
     protected Result executeCommand(List<String> args) {
         SpotlessCLI cli = SpotlessCLI.createInstance();
         CommandLine commandLine = SpotlessCLI.createCommandLine(cli);