Update DockerConnectionDetector,VolumeBindingUtil with home OS env

+ Update DockerConnectionDetector,VolumeBindingUtil with updated precedence for home OS environment variable + Move HOME OS env variable resolving logic to EnvUtil
fabric8io · Apr 4, 2021 · 8a20007 · 8a20007
1 parent c203542
commit 8a20007
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 11 deletions.
diff --git a/src/main/java/io/fabric8/maven/docker/access/DockerConnectionDetector.java b/src/main/java/io/fabric8/maven/docker/access/DockerConnectionDetector.java
@@ -6,6 +6,8 @@
 import io.fabric8.maven.docker.access.util.LocalSocketUtil;
 import io.fabric8.maven.docker.util.*;
 
+import static io.fabric8.maven.docker.util.EnvUtil.getUserHome;
+
 /**
  * Detector for determining the Docker access mechanism
  */
@@ -167,7 +169,7 @@ private void initCertPath(String certPath) throws IOException {
             this.certPath = certPath != null ? certPath : System.getenv("DOCKER_CERT_PATH");
             // Try default locations as last resort
             if (this.certPath == null) {
-                File dockerHome = new File(System.getProperty("user.home") + "/.docker");
+                File dockerHome = new File(getUserHome() + "/.docker");
                 if (dockerHome.isDirectory()) {
                     String[] entries = dockerHome.list(SuffixFileFilter.PEM_FILTER);
                     if (entries == null) {

diff --git a/src/main/java/io/fabric8/maven/docker/util/DockerFileUtil.java b/src/main/java/io/fabric8/maven/docker/util/DockerFileUtil.java
@@ -23,7 +23,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
-import java.util.function.UnaryOperator;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -36,6 +35,8 @@
 import io.fabric8.maven.docker.assembly.DockerAssemblyConfigurationSource;
 import org.yaml.snakeyaml.Yaml;
 
+import static io.fabric8.maven.docker.util.EnvUtil.getUserHome;
+
 
 /**
  * Utility class for dealing with dockerfiles
@@ -45,8 +46,6 @@
 public class DockerFileUtil {
 
     private static final String ARG_PATTERN_REGEX = "\\$(?:\\{(.*)\\}|(.*))";
-    // injection point for unit tests
-    private static UnaryOperator<String> systemGetEnv = System::getenv;
 
     private DockerFileUtil() {}
 
@@ -252,11 +251,7 @@ public static Map<String,?> readKubeConfig() {
     }
 
     private static File getHomeDir() {
-        String homeDir = systemGetEnv.apply("HOME");
-        if (homeDir == null) {
-            homeDir = System.getProperty("user.home");
-        }
-        return new File(homeDir);
+        return new File(getUserHome());
     }
 
     private static void updateMapWithArgValue(Map<String, String> result, Map<String, String> args, String argString) {

diff --git a/src/main/java/io/fabric8/maven/docker/util/EnvUtil.java b/src/main/java/io/fabric8/maven/docker/util/EnvUtil.java
@@ -5,6 +5,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.*;
 import java.util.concurrent.TimeUnit;
+import java.util.function.UnaryOperator;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -37,6 +38,9 @@ public class EnvUtil {
 
     public static final String PROPERTY_COMBINE_POLICY_SUFFIX = "_combine";
 
+    // injection point for unit tests
+    private static UnaryOperator<String> systemGetEnv = System::getenv;
+
     private EnvUtil() {}
 
     // Convert docker host URL to an HTTP(s) URL
@@ -510,4 +514,16 @@ public static boolean isMaven350OrLater(MavenSession mavenSession) {
         String mavenVersion = mavenSession.getSystemProperties().getProperty("maven.version", "3");
         return greaterOrEqualsVersion(mavenVersion, "3.5.0");
     }
+
+    /**
+     * Get User's HOME directory path
+     * @return a String value for user's home directory
+     */
+    public static String getUserHome() {
+        String homeDir = systemGetEnv.apply("HOME");
+        if (homeDir == null) {
+            homeDir =  System.getProperty("user.home");
+        }
+        return homeDir;
+    }
 }
diff --git a/src/main/java/io/fabric8/maven/docker/util/VolumeBindingUtil.java b/src/main/java/io/fabric8/maven/docker/util/VolumeBindingUtil.java
@@ -8,6 +8,7 @@
 import java.util.regex.Pattern;
 
 import static io.fabric8.maven.docker.util.DockerPathUtil.resolveAbsolutely;
+import static io.fabric8.maven.docker.util.EnvUtil.getUserHome;
 
 /**
  * Utility methods for working with Docker volume bindings.
@@ -169,7 +170,7 @@ public static String resolveRelativeVolumeBinding(File baseDir, String bindingSt
         if (isRelativePath(localPath)) {
             File resolvedFile;
             if (isUserHomeRelativePath(localPath)) {
-                resolvedFile = resolveAbsolutely(prepareUserHomeRelativePath(localPath), System.getProperty("user.home"));
+                resolvedFile = resolveAbsolutely(prepareUserHomeRelativePath(localPath), getUserHome());
             } else {
                 if (!baseDir.isAbsolute()) {
                     throw new IllegalArgumentException("Base directory '" + baseDir + "' must be absolute.");

diff --git a/src/test/java/io/fabric8/maven/docker/util/AuthConfigFactoryTest.java b/src/test/java/io/fabric8/maven/docker/util/AuthConfigFactoryTest.java
@@ -300,7 +300,7 @@ private void executeWithTempHomeDir(HomeDirExecutor executor) throws IOException
         String userHome = System.getProperty("user.home");
         environmentVariables.clear("KUBECONFIG");
         try {
-            Field envField = DockerFileUtil.class.getDeclaredField("systemGetEnv");
+            Field envField = EnvUtil.class.getDeclaredField("systemGetEnv");
             ReflectionAccessor.getInstance().makeAccessible(envField);
             @SuppressWarnings("unchecked")
             UnaryOperator<String> origEnv = (UnaryOperator<String>) envField.get(null);