Merge pull request #11 from yrodiere/envvar2

Handle Surefire/Failsafe environment variables similarly to system properties - take 2

Author: yrodiere

src/main/java/org/hibernate/search/develocity/GoalMetadataProvider.java

@@ -8,6 +8,8 @@
  */
 package org.hibernate.search.develocity;
 
+import java.util.function.Consumer;
+
 import org.hibernate.search.develocity.util.MavenMojoExecutionConfig;
 import org.hibernate.search.develocity.util.MavenProperties;
 
@@ -51,5 +53,10 @@ public MavenMojoExecutionConfig configuration() {
 		public void buildScanDeduplicatedValue(String key, String value) {
 			buildScanApi.executeOnce( key + value, ignored -> buildScanApi.value( key, value ) );
 		}
+
+		public void nested(String propertyName, Consumer<? super Context> action) {
+			metadataContext.nested( propertyName,
+					nestedMetadataContext -> action.accept( new Context( buildScanApi, nestedMetadataContext ) ) );
+		}
 	}
 }

src/main/java/org/hibernate/search/develocity/plugins/SurefireConfiguredPlugin.java

@@ -1,13 +1,20 @@
 package org.hibernate.search.develocity.plugins;
 
 import java.util.Map;
+import java.util.regex.Pattern;
 
 import org.hibernate.search.develocity.GoalMetadataProvider;
 import org.hibernate.search.develocity.SimpleConfiguredPlugin;
 import org.hibernate.search.develocity.util.JavaVersions;
 
+import com.gradle.maven.extension.api.cache.MojoMetadataProvider;
+
 public class SurefireConfiguredPlugin extends SimpleConfiguredPlugin {
 
+	private static final String SUREFIRE_ENVIRONMENT_VARIABLES = "environmentVariables";
+
+	private static final Pattern TEST_INDEXES_PATTERN = Pattern.compile( "(^|/)test-indexes($|/)" );
+
 	@Override
 	protected String getPluginName() {
 		return "maven-surefire-plugin";
@@ -26,14 +33,56 @@ protected void configureTest(GoalMetadataProvider.Context context) {
 			dependsOnConfigurableJavaExecutable( inputs, context, "jvm", isSkipped( context ),
 					JavaVersions::forJavaExecutable );
 		} );
+
+		configureEnvironmentVariables(context);
+	}
+
+	// Develocity handles environment variables as a big blob by default,
+	// which won't work if some variables point to absolute paths.
+	private void configureEnvironmentVariables(GoalMetadataProvider.Context context) {
+		context.metadata().inputs( inputs -> {
+			// First, override the property to disable handling of environment variables as a blob.
+			// NOTE: ignoring with inputs.ignore( "environmentVariables" ) doesn't work for some reason:
+			// we end up with the goal being marked as "not cacheable"
+			// because "properties were declared both as input and ignored: [environmentVariables]"
+			// NOTE: we get the same result with context.nested( "environmentVariables" ),
+			// which is why we don't use that.
+			inputs.property( SUREFIRE_ENVIRONMENT_VARIABLES, "IGNORED" );
+
+			// Then, try to mimic system properties handling.
+			for ( Map.Entry<String, String> envVariable : context.configuration()
+					.getStringMap( SUREFIRE_ENVIRONMENT_VARIABLES ).entrySet() ) {
+				var key = envVariable.getKey();
+				var keyForDevelocity = SUREFIRE_ENVIRONMENT_VARIABLES + "." + key;
+				var value = envVariable.getValue();
+				if ( value == null ) {
+					value = "";
+				}
+				if ( value.startsWith( context.metadata().getSession().getExecutionRootDirectory() ) ) {
+					if ( TEST_INDEXES_PATTERN.matcher( "test-indexes" ).find() ) {
+						// Lucene indexes used in tests -- we don't care about these.
+						inputs.ignore( keyForDevelocity );
+					}
+					else {
+						inputs.fileSet( keyForDevelocity, value, fileSet -> {
+							fileSet.normalizationStrategy(
+									MojoMetadataProvider.Context.FileSet.NormalizationStrategy.RELATIVE_PATH );
+						} );
+					}
+				}
+				else {
+					inputs.property( keyForDevelocity, value );
+				}
+			}
+		} );
 	}
 
 	protected boolean isSkipped(GoalMetadataProvider.Context context) {
 		return context.configuration().getBoolean( "skip" )
-			   || context.properties().getBoolean( "maven.test.skip" )
-			   || context.configuration().getBoolean( "skipTests" )
-			   || context.properties().getBoolean( "skipTests" )
-			   || context.configuration().getBoolean( "skipExec" )
-			   || context.properties().getBoolean( "maven.test.skip.exec" );
+				|| context.properties().getBoolean( "maven.test.skip" )
+				|| context.configuration().getBoolean( "skipTests" )
+				|| context.properties().getBoolean( "skipTests" )
+				|| context.configuration().getBoolean( "skipExec" )
+				|| context.properties().getBoolean( "maven.test.skip.exec" );
 	}
 }

src/main/java/org/hibernate/search/develocity/util/MavenMojoExecutionConfig.java

@@ -9,7 +9,9 @@
 package org.hibernate.search.develocity.util;
 
 import java.util.ArrayList;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 
 import org.hibernate.search.develocity.Log;
 
@@ -58,6 +60,19 @@ public List<String> getStringList(String key) {
 		return children;
 	}
 
+	public Map<String, String> getStringMap(String key) {
+		var configElement = mojoExecution.getConfiguration()
+				.getChild( key );
+		if ( configElement == null ) {
+			return Map.of();
+		}
+		Map<String, String> result = new LinkedHashMap<>();
+		for ( Xpp3Dom configElementChild : configElement.getChildren() ) {
+			result.put( configElementChild.getName(), configElementChild.getValue() );
+		}
+		return result;
+	}
+
 	public String getFailsafeSystemProperty(String key) {
 		var systemPropertyVariables = mojoExecution.getConfiguration()
 				.getChild( "systemPropertyVariables" );