Add validation step to target-specific test tasks

Author: jjohannes

src/main/java/org/gradlex/javamodule/packaging/JavaModulePackagingExtension.java

@@ -48,6 +48,7 @@
 import org.gradle.testing.base.TestSuite;
 import org.gradlex.javamodule.packaging.model.Target;
 import org.gradlex.javamodule.packaging.tasks.Jpackage;
+import org.gradlex.javamodule.packaging.tasks.ValidateHostSystemAction;
 
 import javax.inject.Inject;
 import java.util.Arrays;
@@ -86,10 +87,19 @@ abstract public class JavaModulePackagingExtension {
     abstract protected Project getProject();
 
 
+    /**
+     * Retrieve the target with the given 'label'. If the target does not yet exist, it will be created.
+     */
+    @SuppressWarnings("unused")
     public Target target(String label) {
         return target(label, target -> {});
     }
 
+    /**
+     * Register or update a target with the given 'label'. The 'label' uniquely identifies the target.
+     * It is used for task names and can be chosen freely.
+     * Details of the target are configured in the {@link Target} configuration action.
+     */
     public Target target(String label, Action<? super Target> action) {
         Target target;
         if (targets.getNames().contains(label)) {
@@ -102,6 +112,11 @@ public Target target(String label, Action<? super Target> action) {
         return target;
     }
 
+    /**
+     * Set a 'primary target'. Standard Gradle tasks that are not bound to a specific target – like 'assemble' – use
+     * this 'primary target'.
+     */
+    @SuppressWarnings("unused")
     public Target primaryTarget(Target target) {
         SourceSetContainer sourceSets = getProject().getExtensions().getByType(SourceSetContainer.class);
         ConfigurationContainer configurations = getProject().getConfigurations();
@@ -117,22 +132,25 @@ public Target primaryTarget(Target target) {
         return target;
     }
 
+    /**
+     * Set a test suite to be 'multi-target'. This registers an additional 'test' task for each target.
+     */
     public TestSuite multiTargetTestSuite(TestSuite testSuite) {
         if (!(testSuite instanceof JvmTestSuite)) {
             return testSuite;
         }
 
         JvmTestSuite suite = (JvmTestSuite) testSuite;
-        targets.all(target -> {
-            suite.getTargets().register(testSuite.getName() + capitalize(target.getName()), testTarget -> {
-                testTarget.getTestTask().configure(task -> {
-                    ConfigurationContainer configurations = getProject().getConfigurations();
-                    task.setClasspath(configurations.getByName(target.getName() + capitalize(suite.getSources().getRuntimeClasspathConfigurationName())).plus(
-                            getObjects().fileCollection().from(getProject().getTasks().named(suite.getSources().getJarTaskName())))
-                    );
-                });
-            });
-        });
+        targets.all(target -> suite.getTargets().register(testSuite.getName() + capitalize(target.getName()), testTarget -> testTarget.getTestTask().configure(task -> {
+            task.getInputs().property("operatingSystem", target.getOperatingSystem());
+            task.getInputs().property("architecture", target.getArchitecture());
+
+            ConfigurationContainer configurations = getProject().getConfigurations();
+            task.setClasspath(configurations.getByName(target.getName() + capitalize(suite.getSources().getRuntimeClasspathConfigurationName())).plus(
+                    getObjects().fileCollection().from(getProject().getTasks().named(suite.getSources().getJarTaskName())))
+            );
+            task.doFirst(new ValidateHostSystemAction());
+        })));
 
         return testSuite;
     }

src/main/java/org/gradlex/javamodule/packaging/internal/Validator.java

@@ -0,0 +1,36 @@
+package org.gradlex.javamodule.packaging.internal;
+
+public class Validator {
+    public static void validateHostSystem(String arch, String os) {
+        String hostOs = System.getProperty("os.name").replace(" ", "").toLowerCase();
+        String hostArch = System.getProperty("os.arch");
+
+        if (os.contains("macos")) {
+            if (!hostOs.contains(os)) {
+                wrongHostSystemError(hostOs, os);
+            }
+        } else if (os.contains("windows")) {
+            if (!hostOs.contains(os)) {
+                wrongHostSystemError(hostOs, os);
+            }
+        } else {
+            if (hostOs.contains("windows") || hostOs.contains("macos")) {
+                wrongHostSystemError(hostOs, os);
+            }
+        }
+
+        if (arch.contains("64") && !hostArch.contains("64")) {
+            wrongHostSystemError(hostArch, arch);
+        }
+        if (arch.contains("aarch") && !hostArch.contains("aarch")) {
+            wrongHostSystemError(hostArch, arch);
+        }
+        if (!arch.contains("aarch") && hostArch.contains("aarch")) {
+            wrongHostSystemError(hostArch, arch);
+        }
+    }
+
+    public static void wrongHostSystemError(String hostOs, String os) {
+        throw new RuntimeException("Running on " + hostOs + "; cannot build for " + os);
+    }
+}

src/main/java/org/gradlex/javamodule/packaging/tasks/Jpackage.java

@@ -50,6 +50,7 @@
 
 import static java.util.Objects.requireNonNull;
 import static org.gradle.nativeplatform.OperatingSystemFamily.WINDOWS;
+import static org.gradlex.javamodule.packaging.internal.Validator.validateHostSystem;
 
 @CacheableTask
 abstract public class Jpackage extends DefaultTask {
@@ -123,10 +124,8 @@ public void runJpackage() throws Exception {
 
         String os = getOperatingSystem().get();
         String arch = getArchitecture().get();
-        String hostOs = System.getProperty("os.name").replace(" ", "").toLowerCase();
-        String hostArch = System.getProperty("os.arch");
 
-        validateHostSystem(arch, hostArch, os, hostOs);
+        validateHostSystem(arch, os);
 
         Directory resourcesDir = getTempDirectory().get().dir("jpackage-resources");
         Directory appImageParent = getTempDirectory().get().dir("app-image");
@@ -233,34 +232,4 @@ private String bytesToHex(byte[] hash) {
         }
         return hexString.toString();
     }
-
-    private void validateHostSystem(String arch, String hostArch, String os, String hostOs) {
-        if (os.contains("macos")) {
-            if (!hostOs.contains(os)) {
-                wrongHostSystemError(hostOs, os);
-            }
-        } else if (os.contains("windows")) {
-            if (!hostOs.contains(os)) {
-                wrongHostSystemError(hostOs, os);
-            }
-        } else {
-            if (hostOs.contains("windows") || hostOs.contains("macos")) {
-                wrongHostSystemError(hostOs, os);
-            }
-        }
-
-        if (arch.contains("64") && !hostArch.contains("64")) {
-            wrongHostSystemError(hostArch, arch);
-        }
-        if (arch.contains("aarch") && !hostArch.contains("aarch")) {
-            wrongHostSystemError(hostArch, arch);
-        }
-        if (!arch.contains("aarch") && hostArch.contains("aarch")) {
-            wrongHostSystemError(hostArch, arch);
-        }
-    }
-
-    private void wrongHostSystemError(String hostOs, String os) {
-        throw new RuntimeException("Running on " + hostOs + "; cannot build for " + os);
-    }
 }

src/main/java/org/gradlex/javamodule/packaging/tasks/ValidateHostSystemAction.java

@@ -0,0 +1,16 @@
+package org.gradlex.javamodule.packaging.tasks;
+
+import org.gradle.api.Action;
+import org.gradle.api.Task;
+
+import java.util.Map;
+
+import static org.gradlex.javamodule.packaging.internal.Validator.validateHostSystem;
+
+public class ValidateHostSystemAction implements Action<Task> {
+    @Override
+    public void execute(Task task) {
+        Map<String, Object> inputs = task.getInputs().getProperties();
+        validateHostSystem((String) inputs.get("architecture"), (String) inputs.get("operatingSystem"));
+    }
+}