Fixed three messages for internationalization/localization (#357)

ddsharpe · web-flow · commit 6e636cacde55 · 2022-04-18T19:36:54.000-05:00
* remove duplicate code block from UpdateImage

* added SystemStubs test tool for testing methods with Environment variable dependencies

* moved order of Sonar analysis
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -34,7 +34,7 @@ pipeline {
                 sh 'mvn -B -DskipTests -DskipITs clean install'
             }
         }
-        stage ('Test') {
+        stage ('Unit Tests') {
             when {
                 not { changelog '\\[skip-ci\\].*' }
             }
@@ -47,6 +47,25 @@ pipeline {
                 }
             }
         }
+        stage ('Sonar Analysis') {
+            when {
+                anyOf {
+                    changeRequest()
+                    branch "main"
+                }
+            }
+            tools {
+                maven 'maven-3.6.0'
+                jdk 'jdk11'
+            }
+            steps {
+                withSonarQubeEnv('SonarCloud') {
+                    withCredentials([string(credentialsId: 'encj_github_token', variable: 'GITHUB_TOKEN')]) {
+                        runSonarScanner()
+                    }
+                }
+            }
+        }
         stage ('SystemTest Gate') {
             when {
                 allOf {
@@ -99,25 +118,6 @@ pipeline {
                 }
             }
         }
-        stage ('Analyze') {
-            when {
-                anyOf {
-                    changeRequest()
-                    branch "main"
-                }
-            }
-            tools {
-                maven 'maven-3.6.0'
-                jdk 'jdk11'
-            }
-            steps {
-                withSonarQubeEnv('SonarCloud') {
-                    withCredentials([string(credentialsId: 'encj_github_token', variable: 'GITHUB_TOKEN')]) {
-                        runSonarScanner()
-                    }
-                }
-            }
-        }
         stage ('Save Nightly Installer'){
             when {
                 allOf {
diff --git a/imagetool/pom.xml b/imagetool/pom.xml
@@ -37,7 +37,6 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>
-            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>com.github.spullara.mustache.java</groupId>
@@ -48,6 +47,10 @@
             <artifactId>annotations</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>uk.org.webcompere</groupId>
+            <artifactId>system-stubs-jupiter</artifactId>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/UpdateImage.java
@@ -161,10 +161,7 @@ public CommandResponse call() throws Exception {
         } catch (Exception ex) {
             return CommandResponse.error(ex.getMessage());
         } finally {
-            if (!skipcleanup) {
-                Utils.deleteFilesRecursively(buildDir());
-                Utils.removeIntermediateDockerImages(buildEngine, buildId());
-            }
+            cleanup();
         }
         Instant endTime = Instant.now();
         logger.finer("Exiting UpdateImage.call ");
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/util/Utils.java
@@ -471,7 +471,8 @@ public static String findProxyUrl(String proxyUrl, String protocol) {
                     if (isEmptyString(retVal)) {
                         retVal = System.getProperty("http.nonProxyHosts", null);
                         if (!isEmptyString(retVal)) {
-                            retVal = retVal.replaceAll("\\|", ",");
+                            //http.nonProxyHosts property uses | instead of , as a separator
+                            retVal = retVal.replace("|", ",");
                         }
                     }
                     break;
@@ -538,13 +539,13 @@ public static String getBuildWorkingDir() throws IOException {
         boolean pathExists = Files.exists(path, LinkOption.NOFOLLOW_LINKS);
 
         if (!pathExists) {
-            throw new IOException("Working Directory does not exists " + workingDir);
+            throw new IOException(Utils.getMessage("IMG-0111", workingDir));
         } else {
             if (!Files.isDirectory(path)) {
-                throw new IOException("Working Directory specified is not a directory " + workingDir);
+                throw new IOException(Utils.getMessage("IMG-0112", workingDir));
             }
             if (!Files.isWritable(path)) {
-                throw new IOException("Working Directory specified is not writable " + workingDir);
+                throw new IOException(Utils.getMessage("IMG-0113", workingDir));
             }
         }
 
diff --git a/imagetool/src/main/resources/ImageTool.properties b/imagetool/src/main/resources/ImageTool.properties
@@ -109,3 +109,6 @@ IMG-0107=Failed to download and save file {0} from {1}: {2}
 IMG-0108=Environment variable {0}=`{1}` is not an integer and will be ignored.
 IMG-0109=Invalid value found in {0}.  {1} < {2}.  Using default value: {3}.
 IMG-0110=Retries exhausted, unable to obtain patch information from Oracle
+IMG-0111=The directory specified with WLSIMG_BLDDIR must exist prior to running this tool: {0}
+IMG-0112=The value specified with WLSIMG_BLDDIR must be a directory: {0}
+IMG-0113=The directory specified with WLSIMG_BLDDIR must be writable: {0}
diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/UtilsTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/util/UtilsTest.java
@@ -4,24 +4,42 @@
 package com.oracle.weblogic.imagetool.util;
 
 import java.io.IOException;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.logging.Level;
 
 import com.oracle.weblogic.imagetool.api.model.CachedFile;
 import com.oracle.weblogic.imagetool.logging.LoggingFacade;
 import com.oracle.weblogic.imagetool.logging.LoggingFactory;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.api.io.TempDir;
+import uk.org.webcompere.systemstubs.environment.EnvironmentVariables;
+import uk.org.webcompere.systemstubs.jupiter.SystemStub;
+import uk.org.webcompere.systemstubs.jupiter.SystemStubsExtension;
+import uk.org.webcompere.systemstubs.properties.SystemProperties;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @Tag("unit")
+@ExtendWith(SystemStubsExtension.class)
 class UtilsTest {
 
+    @SystemStub
+    private EnvironmentVariables environment;
+
+    @SystemStub
+    private SystemProperties overrideProperties;
+
     @Test
     void compareVersions() {
         assertEquals(0, Utils.compareVersions("12.2.1.3.0", "12.2.1.3.0"));
@@ -106,4 +124,96 @@ void oracleHomeFromResponseFile() throws Exception {
             logger.setLevel(oldLevel);
         }
     }
+
+    @Test
+    @DisplayName("Default working directory to User's home dir")
+    void getBuildWorkingDir1() throws IOException {
+        String expected = System.getProperty("user.home");
+        assertEquals(expected, Utils.getBuildWorkingDir());
+    }
+
+    @Test
+    @DisplayName("Override working directory with system property")
+    void getBuildWorkingDir2(@TempDir Path tempDir) throws IOException {
+        // provide existing directory as input to WLSIMG_BLDDIR should succeed
+        String expected = tempDir.toString();
+        overrideProperties.set("WLSIMG_BLDDIR", expected);
+        assertEquals(expected, Utils.getBuildWorkingDir());
+
+        // Create a read-only directory as input for WLSIMG_BLDDIR
+        Path unwritableDir = tempDir.resolve("unwritable");
+        Files.createDirectory(unwritableDir);
+        if (!unwritableDir.toFile().setReadOnly()) {
+            throw new IOException("Unable to mark test directory as read-only");
+        }
+        // read-only directory as input for working directory should throw an exception
+        overrideProperties.set("WLSIMG_BLDDIR", unwritableDir.toString());
+        assertThrows(IOException.class, Utils::getBuildWorkingDir);
+    }
+
+    @Test
+    @DisplayName("Override working directory with invalid directory")
+    void getBuildWorkingDir3() {
+        String expected = "/this/does/not/exist";
+        overrideProperties.set("WLSIMG_BLDDIR", expected);
+        assertThrows(IOException.class, Utils::getBuildWorkingDir);
+    }
+
+    @Test
+    @DisplayName("Override working directory with invalid file")
+    void getBuildWorkingDir4(@TempDir Path tempDir) throws IOException {
+        Path tempFile = tempDir.resolve("getBuildWorkingDir4.txt");
+        List<String> lines = Arrays.asList("a", "b");
+        Files.write(tempFile, lines);
+
+        String expected = tempFile.toString();
+        overrideProperties.set("WLSIMG_BLDDIR", expected);
+        // The override for WLSIMG_BUILDDIR must be a directory, NOT a file
+        assertThrows(IOException.class, Utils::getBuildWorkingDir);
+    }
+
+    @Test
+    void findProxyUrlWithCommandLine() {
+        // Always default to the proxy set by the user on the tool's command line
+        String expected = "http://some.proxy-host.com";
+        assertEquals(expected, Utils.findProxyUrl(expected, "http"));
+        assertEquals(expected, Utils.findProxyUrl(expected, "https"));
+    }
+
+    /**
+     * If not specified by the user, the environment variable value should be returned
+     * for http_proxy and https_proxy.
+     */
+    @Test
+    void findProxyUrlWithEnvironment() {
+        // No ENV variable set (filed issue on SystemStub)
+        environment.set("http_proxy", null);
+        environment.set("HTTP_PROXY", null);
+        assertNull(Utils.findProxyUrl("", "http"));
+
+        String expected = "http://env.proxy-host.com";
+        // ENV for http_proxy and https_proxy are set
+        environment.set("http_proxy", expected);
+        environment.set("https_proxy", expected);
+        assertEquals(expected, Utils.findProxyUrl("", "http"));
+        assertEquals(expected, Utils.findProxyUrl("", "https"));
+    }
+
+    @Test
+    void findProxyUrlForNoProxy() {
+        // No ENV variable set (filed issue on SystemStub)
+        environment.set("no_proxy", null);
+        environment.set("NO_PROXY", null);
+        assertNull(Utils.findProxyUrl("", "none"));
+
+        String expected = ".host.com,.anotherhost.com,.and.another.com";
+        // | (bar) should be replaced by , (comma) for http.nonProxyHosts system property
+        String withBars = expected.replace(",", "|");
+        overrideProperties.set("http.nonProxyHosts", withBars);
+        assertEquals(expected, Utils.findProxyUrl("", "none"));
+
+        // ENV for no_proxy is set
+        environment.set("no_proxy", expected);
+        assertEquals(expected, Utils.findProxyUrl("", "none"));
+    }
 }
diff --git a/pom.xml b/pom.xml
@@ -74,11 +74,13 @@
                 <groupId>org.junit.jupiter</groupId>
                 <artifactId>junit-jupiter-engine</artifactId>
                 <version>5.8.1</version>
+                <scope>test</scope>
             </dependency>
             <dependency>
-                <groupId>com.google.guava</groupId>
-                <artifactId>guava</artifactId>
-                <version>29.0-jre</version>
+                <groupId>uk.org.webcompere</groupId>
+                <artifactId>system-stubs-jupiter</artifactId>
+                <version>1.2.0</version>
+                <scope>test</scope>
             </dependency>
             <dependency>
                 <groupId>com.github.spullara.mustache.java</groupId>

Original file line number	Diff line number	Diff line change
`@@ -471,7 +471,8 @@ public static String findProxyUrl(String proxyUrl, String protocol) {`
`471`	`471`	`if (isEmptyString(retVal)) {`
`472`	`472`	`retVal = System.getProperty("http.nonProxyHosts", null);`
`473`	`473`	`if (!isEmptyString(retVal)) {`
`474`		`- retVal = retVal.replaceAll("\\\|", ",");`
	`474`	`+ //http.nonProxyHosts property uses \| instead of , as a separator`
	`475`	`+ retVal = retVal.replace("\|", ",");`
`475`	`476`	`}`
`476`	`477`	`}`
`477`	`478`	`break;`
`@@ -538,13 +539,13 @@ public static String getBuildWorkingDir() throws IOException {`
`538`	`539`	`boolean pathExists = Files.exists(path, LinkOption.NOFOLLOW_LINKS);`
`539`	`540`
`540`	`541`	`if (!pathExists) {`
`541`		`- throw new IOException("Working Directory does not exists " + workingDir);`
	`542`	`+ throw new IOException(Utils.getMessage("IMG-0111", workingDir));`
`542`	`543`	`} else {`
`543`	`544`	`if (!Files.isDirectory(path)) {`
`544`		`- throw new IOException("Working Directory specified is not a directory " + workingDir);`
	`545`	`+ throw new IOException(Utils.getMessage("IMG-0112", workingDir));`
`545`	`546`	`}`
`546`	`547`	`if (!Files.isWritable(path)) {`
`547`		`- throw new IOException("Working Directory specified is not writable " + workingDir);`
	`548`	`+ throw new IOException(Utils.getMessage("IMG-0113", workingDir));`
`548`	`549`	`}`
`549`	`550`	`}`
`550`	`551`