Gradle: Support for additional test-to-main directory mappings

* Determine test output directory based on the task
* Raise an exception if the mapping data is invalid.
* Include a functional-test for verifying the plugin behavior

devtools/gradle/build.gradle

@@ -64,9 +64,9 @@ javadoc {
 }
 
 pluginBundle {
-    website = 'https://quarkus.io/' 
-    vcsUrl = 'https://github.com/quarkusio/quarkus' 
-    tags = ['quarkus', 'quarkusio', 'graalvm'] 
+    website = 'https://quarkus.io/'
+    vcsUrl = 'https://github.com/quarkusio/quarkus'
+    tags = ['quarkus', 'quarkusio', 'graalvm']
 }
 
 gradlePlugin {

devtools/gradle/src/main/java/io/quarkus/gradle/QuarkusPluginExtension.java

@@ -4,7 +4,9 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import org.gradle.api.Project;
 import org.gradle.api.file.FileCollection;
@@ -14,6 +16,7 @@
 import org.gradle.api.plugins.JavaPluginConvention;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.SourceSetContainer;
 import org.gradle.api.tasks.testing.Test;
 import org.gradle.jvm.tasks.Jar;
 
@@ -55,6 +58,20 @@ void beforeTest(Test task) {
             final Path serializedModel = QuarkusGradleUtils.serializeAppModel(appModel, task);
             props.put(BootstrapConstants.SERIALIZED_APP_MODEL, serializedModel.toString());
 
+            // Identify the folder containing the sources associated with this test task
+            String fileList = getSourceSets().stream()
+                    .filter(sourceSet -> Objects.equals(
+                            task.getTestClassesDirs().getAsPath(),
+                            sourceSet.getOutput().getClassesDirs().getAsPath()))
+                    .flatMap(sourceSet -> sourceSet.getOutput().getClassesDirs().getFiles().stream())
+                    .filter(File::exists)
+                    .distinct()
+                    .map(testSrcDir -> String.format("%s:%s",
+                            project.relativePath(testSrcDir),
+                            project.relativePath(outputDirectory())))
+                    .collect(Collectors.joining(","));
+            task.environment(BootstrapConstants.TEST_TO_MAIN_MAPPINGS, fileList);
+
             final String nativeRunner = task.getProject().getBuildDir().toPath().resolve(finalName() + "-runner")
                     .toAbsolutePath()
                     .toString();
@@ -96,8 +113,8 @@ public Path appJarOrClasses() {
 
     public File outputDirectory() {
         if (outputDirectory == null) {
-            outputDirectory = getLastFile(project.getConvention().getPlugin(JavaPluginConvention.class)
-                    .getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getOutput().getClassesDirs());
+            outputDirectory = getLastFile(getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getOutput()
+                    .getClassesDirs());
         }
         return outputDirectory;
     }
@@ -108,8 +125,8 @@ public void setOutputDirectory(String outputDirectory) {
 
     public File outputConfigDirectory() {
         if (outputConfigDirectory == null) {
-            outputConfigDirectory = project.getConvention().getPlugin(JavaPluginConvention.class)
-                    .getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getOutput().getResourcesDir();
+            outputConfigDirectory = getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getOutput()
+                    .getResourcesDir();
         }
         return outputConfigDirectory;
     }
@@ -120,8 +137,8 @@ public void setOutputConfigDirectory(String outputConfigDirectory) {
 
     public File sourceDir() {
         if (sourceDir == null) {
-            sourceDir = getLastFile(project.getConvention().getPlugin(JavaPluginConvention.class)
-                    .getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getAllJava().getSourceDirectories());
+            sourceDir = getLastFile(getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getAllJava()
+                    .getSourceDirectories());
         }
         return sourceDir;
     }
@@ -153,8 +170,7 @@ public void setFinalName(String finalName) {
     }
 
     public Set<File> resourcesDir() {
-        return project.getConvention().getPlugin(JavaPluginConvention.class)
-                .getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getResources().getSrcDirs();
+        return getSourceSets().getByName(SourceSet.MAIN_SOURCE_SET_NAME).getResources().getSrcDirs();
     }
 
     public AppArtifact getAppArtifact() {
@@ -199,4 +215,13 @@ private File getLastFile(FileCollection fileCollection) {
         return result;
     }
 
+    /**
+     * Convenience method to get the source sets associated with the current project.
+     *
+     * @return the source sets associated with the current project.
+     */
+    private SourceSetContainer getSourceSets() {
+        return project.getConvention().getPlugin(JavaPluginConvention.class).getSourceSets();
+    }
+
 }

independent-projects/bootstrap/app-model/src/main/java/io/quarkus/bootstrap/BootstrapConstants.java

@@ -11,6 +11,12 @@ public interface BootstrapConstants {
     String SERIALIZED_APP_MODEL = "quarkus-internal.serialized-app-model.path";
     String DESCRIPTOR_FILE_NAME = "quarkus-extension.properties";
 
+    /**
+     * Constant for sharing the additional mappings between test-sources and the corresponding application-sources.
+     * The Gradle plugin populates this data which is then read by the PathTestHelper when executing tests.
+     */
+    String TEST_TO_MAIN_MAPPINGS = "TEST_TO_MAIN_MAPPINGS";
+
     @Deprecated
     String EXTENSION_PROPS_JSON_FILE_NAME = "quarkus-extension.json";
 

integration-tests/gradle/src/test/java/io/quarkus/gradle/AdditionalSourceSetsTest.java

@@ -0,0 +1,24 @@
+package io.quarkus.gradle;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URISyntaxException;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test for verifying that the plugin can work with test-sources which are included as part of a custom source set.
+ * E.g., functional-tests / integration-tests.
+ */
+public class AdditionalSourceSetsTest extends QuarkusGradleWrapperTestBase {
+
+    @Test
+    public void executeFunctionalTest() throws URISyntaxException, IOException, InterruptedException {
+        final File projectDir = getProjectDir("additional-source-sets");
+        BuildResult result = runGradleWrapper(projectDir, "functionalTest");
+        assertEquals(BuildResult.SUCCESS_OUTCOME, result.getTasks().get(":functionalTest"),
+                "Failed to run tests defined in an alternate test sources directory");
+    }
+}

integration-tests/gradle/src/test/resources/additional-source-sets/build.gradle

@@ -0,0 +1,50 @@
+plugins {
+    id 'java'
+    id 'io.quarkus'
+}
+
+repositories {
+    mavenLocal()
+    mavenCentral()
+}
+
+dependencies {
+    implementation enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatformArtifactId}:${quarkusPlatformVersion}")
+    implementation "io.quarkus:quarkus-arc"
+    testImplementation "io.quarkus:quarkus-junit5"
+}
+
+sourceSets {
+    // Functional Tests
+    funcTest {
+        java.srcDir 'src/funcTest/java'
+        if (file('src/funcTest/resources').exists()) {
+            resources.srcDir 'src/funcTest/resources'
+        }
+
+        compileClasspath += sourceSets.main.output + configurations.testRuntimeClasspath + configurations.compileOnly
+        runtimeClasspath += output + compileClasspath
+    }
+}
+
+compileJava {
+    options.compilerArgs << '-parameters'
+}
+
+/*
+ * Functional tests for this module.
+ */
+task functionalTest(type: Test, description: 'Functional tests', dependsOn: [processResources, classes]) {
+    description = 'Run the functional tests.'
+    group = 'verification'
+
+    useJUnitPlatform()
+    testClassesDirs = sourceSets.funcTest.output.classesDirs
+    classpath = sourceSets.funcTest.runtimeClasspath
+
+    // Show standard streams on the console.
+    testLogging {
+        showStandardStreams = true
+    }
+    systemProperty 'quarkus.http.host', 'localhost'
+}

integration-tests/gradle/src/test/resources/additional-source-sets/gradle.properties

@@ -0,0 +1,2 @@
+quarkusPlatformArtifactId=quarkus-bom
+quarkusPlatformGroupId=io.quarkus

integration-tests/gradle/src/test/resources/additional-source-sets/settings.gradle

@@ -0,0 +1,12 @@
+pluginManagement {
+    repositories {
+        mavenLocal()
+        mavenCentral()
+        gradlePluginPortal()
+    }
+    plugins {
+        id 'io.quarkus' version "${quarkusPluginVersion}"
+    }
+}
+
+rootProject.name = 'additional-test-sources'

integration-tests/gradle/src/test/resources/additional-source-sets/src/funcTest/java/ft/SimpleBeanTest.java

@@ -0,0 +1,19 @@
+package ft;
+
+import javax.inject.Inject;
+import org.junit.jupiter.api.Test;
+import io.quarkus.test.junit.QuarkusTest;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@QuarkusTest
+public class SimpleBeanTest {
+
+    @Inject
+    SimpleBean bean;
+
+    @Test
+    public void verify() {
+        assertEquals("hello", bean.hello(), "Did the implementation of the SimpleBean change?");
+    }
+}

integration-tests/gradle/src/test/resources/additional-source-sets/src/main/java/ft/SimpleBean.java

@@ -0,0 +1,11 @@
+package ft;
+
+import javax.enterprise.context.ApplicationScoped;
+
+@ApplicationScoped
+public class SimpleBean {
+
+    public String hello() {
+        return "hello";
+    }
+}

integration-tests/gradle/src/test/resources/additional-source-sets/src/main/resources/META-INF/beans.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_2_0.xsd"
+       bean-discovery-mode="all">
+</beans>

test-framework/common/src/main/java/io/quarkus/test/common/PathTestHelper.java

@@ -9,7 +9,9 @@
 import java.nio.file.Paths;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.stream.Stream;
 
+import io.quarkus.bootstrap.BootstrapConstants;
 import io.quarkus.runtime.util.ClassPathUtils;
 
 /**
@@ -99,6 +101,20 @@ public final class PathTestHelper {
                 File.separator + "test-classes",
                 File.separator + "classes");
         //endregion
+
+        String mappings = System.getenv(BootstrapConstants.TEST_TO_MAIN_MAPPINGS);
+        if (mappings != null) {
+            Stream.of(mappings.split(","))
+                    .filter(s -> !s.isEmpty())
+                    .forEach(s -> {
+                        String[] entry = s.split(":");
+                        if (entry.length == 2) {
+                            TEST_TO_MAIN_DIR_FRAGMENTS.put(entry[0], entry[1]);
+                        } else {
+                            throw new IllegalStateException("Unable to parse additional test-to-main mapping: " + s);
+                        }
+                    });
+        }
     }
 
     private PathTestHelper() {