A new feature 'excludedEnvironmentVariables' (pending: MOJO system pr…

…operties with prefix 'surefire' and 'failsafe').

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java

@@ -444,6 +444,21 @@ public abstract class AbstractSurefireMojo
     @Parameter
     private Map<String, String> environmentVariables = new HashMap<>();
 
+    /**
+     * You can selectively exclude individual environment variables by enumerating their keys.
+     * <br>
+     * All environment variables of the plugin process are inherited to a Surefire sub-process by default.
+     * The keys must literally (case sensitive) match in order to exclude their environment variable.
+     * <br>
+     * The environment is a system-dependent mapping from keys to values which is passed from parent plugin process
+     * to the forked Surefire processes.<br>
+     * Example to exclude two environment variables: <i>mvn test -DexcludedEnvironmentVariables=ACME1,ACME2</i>
+     *
+     * @since 3.0.0-M4
+     */
+    @Parameter( property = "excludedEnvironmentVariables" )
+    private String[] excludedEnvironmentVariables;
+
     /**
      * Command line working directory.
      *
@@ -1195,6 +1210,7 @@ private RunResult executeProvider( @Nonnull ProviderInfo provider, @Nonnull Defa
             if ( getConsoleLogger().isDebugEnabled() )
             {
                 showMap( getEnvironmentVariables(), "environment variable" );
+                showArray( getExcludedEnvironmentVariables(), "excluded environment variable" );
             }
 
             Properties originalSystemProperties = (Properties) System.getProperties().clone();
@@ -2268,6 +2284,7 @@ private ForkConfiguration createForkConfiguration( Platform platform )
                     getProject().getModel().getProperties(),
                     getArgLine(),
                     getEnvironmentVariables(),
+                    getExcludedEnvironmentVariables(),
                     getConsoleLogger().isDebugEnabled(),
                     getEffectiveForkCount(),
                     reuseForks,
@@ -2283,6 +2300,7 @@ else if ( getClassLoaderConfiguration().isManifestOnlyJarRequestedAndUsable() )
                     getProject().getModel().getProperties(),
                     getArgLine(),
                     getEnvironmentVariables(),
+                    getExcludedEnvironmentVariables(),
                     getConsoleLogger().isDebugEnabled(),
                     getEffectiveForkCount(),
                     reuseForks,
@@ -2298,6 +2316,7 @@ else if ( getClassLoaderConfiguration().isManifestOnlyJarRequestedAndUsable() )
                     getProject().getModel().getProperties(),
                     getArgLine(),
                     getEnvironmentVariables(),
+                    getExcludedEnvironmentVariables(),
                     getConsoleLogger().isDebugEnabled(),
                     getEffectiveForkCount(),
                     reuseForks,
@@ -2505,6 +2524,7 @@ private String getConfigChecksum()
         checksum.add( getParallelTestsTimeoutInSeconds() );
         checksum.add( getParallelTestsTimeoutForcedInSeconds() );
         checksum.add( getEnvironmentVariables() );
+        checksum.add( getExcludedEnvironmentVariables() );
         checksum.add( getWorkingDirectory() );
         checksum.add( isChildDelegation() );
         checksum.add( getGroups() );
@@ -2627,6 +2647,14 @@ private void showMap( Map<?, ?> map, String setting )
         }
     }
 
+    private <T> void showArray( T[] array, String setting )
+    {
+        for ( T e : array )
+        {
+            getConsoleLogger().debug( "Setting " + setting + " [" + e + "]" );
+        }
+    }
+
     private Classpath getArtifactClasspath( Artifact surefireArtifact )
     {
         Classpath existing = ClasspathCache.getCachedClassPath( surefireArtifact.getArtifactId() );
@@ -3446,6 +3474,11 @@ public Map<String, String> getEnvironmentVariables()
         return environmentVariables;
     }
 
+    protected String[] getExcludedEnvironmentVariables()
+    {
+        return excludedEnvironmentVariables == null ? new String[0] : excludedEnvironmentVariables;
+    }
+
     @SuppressWarnings( "UnusedDeclaration" )
     public void setEnvironmentVariables( Map<String, String> environmentVariables )
     {

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/AbstractClasspathForkConfiguration.java

@@ -44,14 +44,15 @@ abstract class AbstractClasspathForkConfiguration
                                         @Nonnull Properties modelProperties,
                                         @Nullable String argLine,
                                         @Nonnull Map<String, String> environmentVariables,
+                                        @Nonnull String[] excludedEnvironmentVariables,
                                         boolean debug,
                                         int forkCount,
                                         boolean reuseForks,
                                         @Nonnull Platform pluginPlatform,
                                         @Nonnull ConsoleLogger log )
     {
         super( bootClasspath, tempDirectory, debugLine, workingDirectory, modelProperties, argLine,
-                environmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
+                environmentVariables, excludedEnvironmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
     }
 
     @Override

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ClasspathForkConfiguration.java

@@ -44,12 +44,14 @@ public final class ClasspathForkConfiguration
     public ClasspathForkConfiguration( @Nonnull Classpath bootClasspath, @Nonnull File tempDirectory,
                                        @Nullable String debugLine, @Nonnull File workingDirectory,
                                        @Nonnull Properties modelProperties, @Nullable String argLine,
-                                       @Nonnull Map<String, String> environmentVariables, boolean debug, int forkCount,
+                                       @Nonnull Map<String, String> environmentVariables,
+                                       @Nonnull String[] excludedEnvironmentVariables,
+                                       boolean debug, int forkCount,
                                        boolean reuseForks, @Nonnull Platform pluginPlatform,
                                        @Nonnull ConsoleLogger log )
     {
         super( bootClasspath, tempDirectory, debugLine, workingDirectory, modelProperties, argLine,
-                environmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
+                environmentVariables, excludedEnvironmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
     }
 
     @Override

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/DefaultForkConfiguration.java

@@ -59,6 +59,7 @@ public abstract class DefaultForkConfiguration
     @Nonnull private final Properties modelProperties;
     @Nullable private final String argLine;
     @Nonnull private final Map<String, String> environmentVariables;
+    @Nonnull private final String[] excludedEnvironmentVariables;
     private final boolean debug;
     private final int forkCount;
     private final boolean reuseForks;
@@ -73,6 +74,7 @@ protected DefaultForkConfiguration( @Nonnull Classpath booterClasspath,
                                      @Nonnull Properties modelProperties,
                                      @Nullable String argLine,
                                      @Nonnull Map<String, String> environmentVariables,
+                                     @Nonnull String[] excludedEnvironmentVariables,
                                      boolean debug,
                                      int forkCount,
                                      boolean reuseForks,
@@ -86,6 +88,7 @@ protected DefaultForkConfiguration( @Nonnull Classpath booterClasspath,
         this.modelProperties = modelProperties;
         this.argLine = argLine;
         this.environmentVariables = toImmutable( environmentVariables );
+        this.excludedEnvironmentVariables = excludedEnvironmentVariables;
         this.debug = debug;
         this.forkCount = forkCount;
         this.reuseForks = reuseForks;
@@ -119,7 +122,8 @@ public OutputStreamFlushableCommandline createCommandLine( @Nonnull StartupConfi
                                                                @Nonnull File dumpLogDirectory )
             throws SurefireBooterForkException
     {
-        OutputStreamFlushableCommandline cli = new OutputStreamFlushableCommandline();
+        OutputStreamFlushableCommandline cli =
+                new OutputStreamFlushableCommandline( getExcludedEnvironmentVariables() );
 
         cli.setWorkingDirectory( getWorkingDirectory( forkNumber ).getAbsolutePath() );
 
@@ -289,6 +293,13 @@ protected Map<String, String> getEnvironmentVariables()
         return environmentVariables;
     }
 
+    @Nonnull
+    @Override
+    protected String[] getExcludedEnvironmentVariables()
+    {
+        return excludedEnvironmentVariables;
+    }
+
     @Override
     protected boolean isDebug()
     {

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkConfiguration.java

@@ -45,6 +45,7 @@ public abstract class ForkConfiguration
     @Nonnull protected abstract Properties getModelProperties();
     @Nullable protected abstract String getArgLine();
     @Nonnull protected abstract Map<String, String> getEnvironmentVariables();
+    @Nonnull protected abstract String[] getExcludedEnvironmentVariables();
     protected abstract boolean isDebug();
     protected abstract int getForkCount();
     protected abstract boolean isReuseForks();

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/JarManifestForkConfiguration.java

@@ -62,12 +62,14 @@ public final class JarManifestForkConfiguration
     public JarManifestForkConfiguration( @Nonnull Classpath bootClasspath, @Nonnull File tempDirectory,
                                          @Nullable String debugLine, @Nonnull File workingDirectory,
                                          @Nonnull Properties modelProperties, @Nullable String argLine,
-                                         @Nonnull Map<String, String> environmentVariables, boolean debug,
+                                         @Nonnull Map<String, String> environmentVariables,
+                                         @Nonnull String[] excludedEnvironmentVariables,
+                                         boolean debug,
                                          int forkCount, boolean reuseForks, @Nonnull Platform pluginPlatform,
                                          @Nonnull ConsoleLogger log )
     {
         super( bootClasspath, tempDirectory, debugLine, workingDirectory, modelProperties, argLine,
-                environmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
+                environmentVariables, excludedEnvironmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
     }
 
     @Override

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ModularClasspathForkConfiguration.java

@@ -67,14 +67,15 @@ public ModularClasspathForkConfiguration( @Nonnull Classpath bootClasspath,
                                               @Nonnull Properties modelProperties,
                                               @Nullable String argLine,
                                               @Nonnull Map<String, String> environmentVariables,
+                                              @Nonnull String[] excludedEnvironmentVariables,
                                               boolean debug,
                                               @Nonnegative int forkCount,
                                               boolean reuseForks,
                                               @Nonnull Platform pluginPlatform,
                                               @Nonnull ConsoleLogger log )
     {
         super( bootClasspath, tempDirectory, debugLine, workingDirectory, modelProperties, argLine,
-                environmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
+                environmentVariables, excludedEnvironmentVariables, debug, forkCount, reuseForks, pluginPlatform, log );
     }
 
     @Override

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/OutputStreamFlushReceiver.java

@@ -0,0 +1,47 @@
+package org.apache.maven.plugin.surefire.booterclient.lazytestprovider;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * Facade flushing {@link OutputStream} and isolating the stream in client.
+ */
+final class OutputStreamFlushReceiver
+        implements FlushReceiver
+{
+    private final OutputStream outputStream;
+
+    /**
+     * Wraps an output stream in order to delegate a flush.
+     */
+    OutputStreamFlushReceiver( OutputStream outputStream )
+    {
+        this.outputStream = outputStream;
+    }
+
+    @Override
+    public void flush()
+            throws IOException
+    {
+        outputStream.flush();
+    }
+}

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/OutputStreamFlushableCommandline.java

@@ -19,9 +19,13 @@
  * under the License.
  */
 
-import java.io.IOException;
-import java.io.OutputStream;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Properties;
+import java.util.concurrent.ConcurrentLinkedDeque;
+
 import org.apache.maven.shared.utils.cli.CommandLineException;
+import org.apache.maven.shared.utils.cli.CommandLineUtils;
 import org.apache.maven.shared.utils.cli.Commandline;
 
 /**
@@ -35,29 +39,37 @@ public class OutputStreamFlushableCommandline
     extends Commandline
     implements FlushReceiverProvider
 {
+    private final Collection<String> excludedEnvironmentVariables;
+    private volatile FlushReceiver flushReceiver;
+
     /**
-     * Wraps an output stream in order to delegate a flush.
+     * for testing purposes only
      */
-    private final class OutputStreamFlushReceiver
-        implements FlushReceiver
+    public OutputStreamFlushableCommandline()
     {
-        private final OutputStream outputStream;
+        this( new String[0] );
+    }
 
-        private OutputStreamFlushReceiver( OutputStream outputStream )
-        {
-            this.outputStream = outputStream;
-        }
+    public OutputStreamFlushableCommandline( String[] excludedEnvironmentVariables )
+    {
+        this.excludedEnvironmentVariables = new ConcurrentLinkedDeque<>();
+        Collections.addAll( this.excludedEnvironmentVariables, excludedEnvironmentVariables );
+    }
+
+    @Override
+    public final void addSystemEnvironment()
+    {
+        Properties systemEnvVars = CommandLineUtils.getSystemEnvVars();
 
-        @Override
-        public void flush()
-            throws IOException
+        for ( String key : systemEnvVars.stringPropertyNames() )
         {
-            outputStream.flush();
+            if ( !excludedEnvironmentVariables.contains( key ) )
+            {
+                addEnvironment( key, systemEnvVars.getProperty( key ) );
+            }
         }
     }
 
-    private volatile FlushReceiver flushReceiver;
-
     @Override
     public Process execute()
         throws CommandLineException
@@ -77,5 +89,4 @@ public FlushReceiver getFlushReceiver()
     {
         return flushReceiver;
     }
-
-}
+}