Merge pull request #329 from gradle/erichaagdev/groovy-scripts-m2-directory

Add support for evaluating one or more Groovy scripts in the Develocity storage directory

Author: ribafish

README.md

@@ -57,11 +57,13 @@ captured and under which conditions.
 
 ## Capturing additional tags, links and values in your build scans
 
-You can apply additional configuration beyond what is contributed by the Common Custom User Data Maven extension by default. The additional configuration happens in a specific
-Groovy script. This is a good intermediate step before creating your own extension.
+You can apply additional configuration beyond what is contributed by the Common Custom User Data Maven extension by default.
+The extension evaluates Groovy scripts from two locations:
 
-The Common Custom User Data Maven extension checks for a `.mvn/develocity-custom-user-data.groovy` or `.mvn/gradle-enterprise-custom-user-data.groovy` Groovy script in your root project. If the file exists, it evaluates
-the script with the following bindings:
+1. Any `*.groovy` files in the `custom-user-data` directory, located within the [Develocity storage directory](https://docs.gradle.com/develocity/maven-extension/current/#anatomy_of_the_develocity_directory), `${user.home}/.m2/.develocity` by default
+2. A `.mvn/develocity-custom-user-data.groovy` or `.mvn/gradle-enterprise-custom-user-data.groovy` in your root project
+
+All matching files are evaluated with the following bindings:
 
 - `develocity/gradleEnterprise` (type: [DevelocityAdapter](https://github.com/gradle/develocity-agent-adapters/blob/main/develocity-maven-extension-adapters/src/compatibilityApi/java/com/gradle/develocity/agent/maven/adapters/DevelocityAdapter.java)): _configure Develocity_
 - `buildScan` (type: [BuildScanApiAdapter](https://github.com/gradle/develocity-agent-adapters/blob/main/develocity-maven-extension-adapters/src/compatibilityApi/java/com/gradle/develocity/agent/maven/adapters/BuildScanApiAdapter.java)): _configure build scan publishing and enhance build scans_
@@ -70,6 +72,8 @@ the script with the following bindings:
 - `project` (type: [`MavenProject`](https://maven.apache.org/ref/current/maven-core/apidocs/org/apache/maven/project/MavenProject.html)): _the top-level Maven project_
 - `session` (type: [`MavenSession`](https://maven.apache.org/ref/current/maven-core/apidocs/org/apache/maven/execution/MavenSession.html)): _the Maven session_
 
+The Groovy scripts are evaluated in the exact order listed above, with the scripts in the `custom-user-data` directory being executed in alphabetical order.
+
 See [here](.mvn/develocity-custom-user-data.groovy) for an example.
 
 ## Developing a customized version of the extension

src/main/java/com/gradle/GroovyScriptUserData.java

@@ -8,10 +8,29 @@
 import org.slf4j.Logger;
 
 import java.io.File;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+import java.util.stream.Collectors;
 
 final class GroovyScriptUserData {
 
     static void evaluate(MavenSession session, DevelocityAdapter develocity, Logger logger, CustomConfigurationSpec customConfigurationSpec) throws MavenExecutionException {
+        evaluateGroovyScriptsInDevelocityStorageDirectory(session, develocity, logger, customConfigurationSpec);
+        evaluateGroovyScriptInRootProject(session, develocity, logger, customConfigurationSpec);
+    }
+
+    private static void evaluateGroovyScriptsInDevelocityStorageDirectory(MavenSession session, DevelocityAdapter develocity, Logger logger, CustomConfigurationSpec customConfigurationSpec) throws MavenExecutionException {
+        File customUserDataDirectory = develocity.getStorageDirectory().resolve("custom-user-data").toFile();
+        List<File> scripts = getGroovyScripts(customUserDataDirectory);
+        for (File script : scripts) {
+            logger.debug("Evaluating custom user data Groovy script: {}", script);
+            evaluateGroovyScript(session, develocity, logger, script, customConfigurationSpec.apiVariableName);
+        }
+    }
+
+    private static void evaluateGroovyScriptInRootProject(MavenSession session, DevelocityAdapter develocity, Logger logger, CustomConfigurationSpec customConfigurationSpec) throws MavenExecutionException {
         File script = getGroovyScript(session, customConfigurationSpec.groovyScriptName);
         if (script.exists()) {
             logger.debug("Evaluating custom user data Groovy script: {}", script);
@@ -35,6 +54,23 @@ private static File getGroovyScript(MavenSession session, String scriptName) {
         return new File(rootDir, ".mvn/" + scriptName + ".groovy");
     }
 
+    private static List<File> getGroovyScripts(File directory) {
+        if (directory.exists() && directory.isDirectory()) {
+            File[] files = directory.listFiles();
+            if (files != null) {
+                return Arrays.stream(files)
+                        .filter(GroovyScriptUserData::isGroovyScript)
+                        .sorted(Comparator.comparing(File::getName))
+                        .collect(Collectors.toList());
+            }
+        }
+        return Collections.emptyList();
+    }
+
+    private static boolean isGroovyScript(File file) {
+        return file.isFile() && file.getName().endsWith(".groovy");
+    }
+
     private static void evaluateGroovyScript(MavenSession session, DevelocityAdapter develocity, Logger logger, File groovyScript, String apiVariableName) throws MavenExecutionException {
         try {
             Binding binding = prepareBinding(session, develocity, logger, apiVariableName);