Include rootProjectName in build-scans.csv for Maven

Author: erichaagdev

components/configure-gradle-enterprise-maven-extension/src/main/java/com/gradle/ConfigureGradleEnterprise.java

@@ -23,10 +23,12 @@ public class ConfigureGradleEnterprise implements GradleEnterpriseListener {
 
     private static final String EXPERIMENT_DIR = System.getProperty("com.gradle.enterprise.build-validation.expDir");
 
+    private final RootProjectExtractor rootProjectExtractor;
     private final Logger logger;
 
     @Inject
-    public ConfigureGradleEnterprise(Logger logger) {
+    public ConfigureGradleEnterprise(RootProjectExtractor rootProjectExtractor, Logger logger) {
+        this.rootProjectExtractor = rootProjectExtractor;
         this.logger = logger;
     }
 
@@ -46,11 +48,13 @@ public void configure(GradleEnterpriseApi api, MavenSession session) {
             buildScan.setAllowUntrustedServer(Boolean.parseBoolean(geAllowUntrustedServer));
         }
 
-        registerBuildScanActions(buildScan);
+        String rootProjectName = rootProjectExtractor.extractRootProject(session).getName();
+
+        registerBuildScanActions(buildScan, rootProjectName);
         configureBuildScanPublishing(buildScan);
     }
 
-    private static void registerBuildScanActions(BuildScanApi buildScan) {
+    private static void registerBuildScanActions(BuildScanApi buildScan, String rootProjectName) {
         buildScan.buildFinished(buildResult -> {
             // communicate via error file that no GE server is set
             boolean omitServerUrlValidation = parseBoolean(System.getProperty("com.gradle.enterprise.build-validation.omitServerUrlValidation"));
@@ -81,7 +85,7 @@ private static void registerBuildScanActions(BuildScanApi buildScan) {
             String baseUrl = String.format("%s://%s%s", buildScanUri.getScheme(), buildScanUri.getHost(), port);
 
             File scanFile = new File(EXPERIMENT_DIR, "build-scans.csv");
-            append(scanFile, String.format("%s,%s,%s,%s\n", runNum, baseUrl, buildScanUri, buildScanId));
+            append(scanFile, String.format("%s,%s,%s,%s,%s\n", runNum, baseUrl, buildScanUri, buildScanId, rootProjectName));
         });
     }
 

components/configure-gradle-enterprise-maven-extension/src/main/java/com/gradle/RootProjectExtractor.java

@@ -0,0 +1,73 @@
+package com.gradle;
+
+import org.apache.maven.execution.ExecutionEvent;
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.model.building.ModelProcessor;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.apache.maven.project.ProjectBuildingException;
+import org.codehaus.plexus.logging.Logger;
+
+import javax.inject.Inject;
+import java.io.File;
+import java.util.*;
+
+import static java.util.Collections.emptyList;
+
+public class RootProjectExtractor {
+    private final ProjectBuilder projectBuilder;
+    private final ModelProcessor modelProcessor;
+    private final Logger logger;
+
+    @Inject
+    public RootProjectExtractor(ProjectBuilder projectBuilder, ModelProcessor modelProcessor, Logger logger) {
+        this.projectBuilder = projectBuilder;
+        this.modelProcessor = modelProcessor;
+        this.logger = logger;
+    }
+
+    public MavenProject extractRootProject(ExecutionEvent event) {
+        return extractRootProject(event.getSession());
+    }
+
+    public MavenProject extractRootProject(MavenSession session) {
+        List<MavenProject> allProjects = discoverAllProjects(session.getAllProjects());
+        File workspaceDirectory = getWorkspaceDirectory(session);
+
+        if (workspaceDirectory.equals(allProjects.get(0).getBasedir())) {
+            return allProjects.get(0);
+        }
+
+        File workspaceDirectoryPom = modelProcessor.locatePom(workspaceDirectory);
+        if (workspaceDirectoryPom.exists()) {
+            try {
+                return projectBuilder.build(workspaceDirectoryPom, session.getProjectBuildingRequest()).getProject();
+            } catch (ProjectBuildingException e) {
+                logger.error("Exception locating the top level project", e);
+            }
+        }
+
+        // We didn't successfully identify the root project, so just return the first project.
+        return allProjects.get(0);
+    }
+
+    private File getWorkspaceDirectory(MavenSession session) {
+        MavenExecutionRequest request = session.getRequest();
+        try {
+            return request.getMultiModuleProjectDirectory();
+        } catch (NoSuchMethodError ignored) {
+            return new File(session.getExecutionRootDirectory());
+        }
+    }
+
+    /**
+     * Older Maven versions under-reported the list of discovered projects.
+     * This method discovers all their submodules. For newer Maven versions it is a no-op.
+     */
+    private List<MavenProject> discoverAllProjects(Collection<MavenProject> sessionProjects) {
+        Set<MavenProject> allProjects = new LinkedHashSet<>(sessionProjects);
+        sessionProjects.stream().flatMap(p -> Optional.ofNullable(p.getCollectedProjects()).orElse(emptyList()).stream()).forEach(allProjects::add);
+        return new ArrayList<MavenProject>(allProjects);
+    }
+}