Use 1 instead of negative 1 for error return code (#286)

ddsharpe · web-flow · commit ac49f1045d5f · 2021-07-06T10:40:55.000-05:00
* negative numbers are not valid return codes, replaced all negative 1 occurrences with non-negative 1

* update expected responses in unit tests for new response code
diff --git a/imagetool/src/main/bin/imagetool.sh b/imagetool/src/main/bin/imagetool.sh
@@ -14,17 +14,17 @@ set -e
 #
 if [ -z "${JAVA_HOME}" ]; then
   echo "Please set the JAVA_HOME environment variable to match the location of your Java installation. Java 8 or newer is required." >&2
-  exit -1
+  exit 1
 elif [ ! -d "${JAVA_HOME}" ]; then
   echo "Your JAVA_HOME environment variable points to a non-existent directory: ${JAVA_HOME}" >&2
-  exit -1
+  exit 1
 fi
 
 if [ -x "${JAVA_HOME}/bin/java" ]; then
   JAVA_EXE=${JAVA_HOME}/bin/java
 else
   echo "Java executable at ${JAVA_HOME}/bin/java either does not exist or is not executable" >&2
-  exit -1
+  exit 1
 fi
 
 script_dir=$(dirname "${BASH_SOURCE[0]}")
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/ImageTool.java
@@ -66,7 +66,7 @@ public static void main(String[] args) {
             }
             System.exit(response.getStatus());
         }
-        System.exit(-1);
+        System.exit(1);
     }
 
     /**
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddEntry.java
@@ -30,7 +30,7 @@ public CommandResponse call() throws CacheStoreException {
             cache().addToCache(key, location);
             return new CommandResponse(0, msg);
         }
-        return new CommandResponse(-1, "IMG-0044");
+        return new CommandResponse(1, "IMG-0044");
     }
 
     @Option(
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntry.java
@@ -29,11 +29,11 @@ public CommandResponse call() throws Exception {
             List<String> patches = new ArrayList<>();
             patches.add(patchId);
             if (!Utils.validatePatchIds(patches, true)) {
-                return new CommandResponse(-1, "Patch ID validation failed");
+                return new CommandResponse(1, "Patch ID validation failed");
             }
             return addToCache(patchId);
         } else {
-            return new CommandResponse(-1, "IMG-0076", "--patchId");
+            return new CommandResponse(1, "IMG-0076", "--patchId");
         }
     }
 
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/CacheAddOperation.java
@@ -17,7 +17,7 @@ public abstract class CacheAddOperation extends CacheOperation {
     CommandResponse addToCache(String key) throws CacheStoreException {
         // if file is invalid or does not exist, return an error
         if (filePath == null || !Files.isRegularFile(filePath)) {
-            return new CommandResponse(-1, "IMG-0049", filePath);
+            return new CommandResponse(1, "IMG-0049", filePath);
         }
 
         // if the new value is the same as the existing cache value, do nothing
@@ -28,7 +28,7 @@ CommandResponse addToCache(String key) throws CacheStoreException {
 
         // if there is already a cache entry and the user did not ask to force it, return an error
         if (!force && existingValue != null) {
-            return new CommandResponse(-1, "IMG-0048", key, existingValue);
+            return new CommandResponse(1, "IMG-0048", key, existingValue);
         }
 
         // input appears valid, add the entry to the cache and exit
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteEntry.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/cache/DeleteEntry.java
@@ -34,7 +34,7 @@ public CommandResponse call() throws Exception {
                 }
             }
         }
-        return new CommandResponse(-1, "IMG-0045");
+        return new CommandResponse(1, "IMG-0045");
     }
 
     @Option(
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/CreateImage.java
@@ -51,7 +51,7 @@ public CommandResponse call() throws Exception {
             tmpDir = getTempDirectory();
 
             if (!Utils.validatePatchIds(patches, false)) {
-                return new CommandResponse(-1, "Patch ID validation failed");
+                return new CommandResponse(1, "Patch ID validation failed");
             }
 
             copyOptionsFromImage(fromImage, tmpDir);
@@ -106,7 +106,7 @@ public CommandResponse call() throws Exception {
             }
         } catch (Exception ex) {
             logger.fine("**ERROR**", ex);
-            return new CommandResponse(-1, ex.getMessage());
+            return new CommandResponse(1, ex.getMessage());
         } finally {
             if (!skipcleanup) {
                 Utils.deleteFilesRecursively(tmpDir);
diff --git a/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java b/imagetool/src/main/java/com/oracle/weblogic/imagetool/cli/menu/RebaseImage.java
@@ -75,7 +75,7 @@ public CommandResponse call() throws Exception {
                 modelHome = baseImageProperties.getProperty("wdtModelHome", null);
                 modelOnly = Boolean.parseBoolean(baseImageProperties.getProperty("wdtModelOnly", null));
             } else {
-                return new CommandResponse(-1, "Source Image not set");
+                return new CommandResponse(1, "Source Image not set");
             }
 
             if (!Utils.isEmptyString(targetImage)) {
@@ -94,15 +94,15 @@ public CommandResponse call() throws Exception {
             }
 
             if (newJavaHome != null && !newJavaHome.equals(oldJavaHome)) {
-                return new CommandResponse(-1, Utils.getMessage("IMG-0026"));
+                return new CommandResponse(1, Utils.getMessage("IMG-0026"));
             }
 
             if (newOracleHome != null && !newOracleHome.equals(oldOracleHome)) {
-                return new CommandResponse(-1, Utils.getMessage("IMG-0021"));
+                return new CommandResponse(1, Utils.getMessage("IMG-0021"));
             }
 
             if (Utils.isEmptyString(domainHome)) {
-                return new CommandResponse(-1, Utils.getMessage("IMG-0025"));
+                return new CommandResponse(1, Utils.getMessage("IMG-0025"));
             }
 
             if (modelOnly) {
@@ -161,7 +161,7 @@ public CommandResponse call() throws Exception {
             // add directory to pass the context
             runDockerCommand(dockerfile, cmdBuilder);
         } catch (Exception ex) {
-            return new CommandResponse(-1, ex.getMessage());
+            return new CommandResponse(1, ex.getMessage());
         } finally {
             if (!skipcleanup) {
                 Utils.deleteFilesRecursively(tmpDir);
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
@@ -51,7 +51,7 @@ public CommandResponse call() throws Exception {
             init(buildId);
 
             if (fromImage == null || fromImage.isEmpty()) {
-                return new CommandResponse(-1, "update requires a base image. use --fromImage to specify base image");
+                return new CommandResponse(1, "update requires a base image. use --fromImage to specify base image");
             }
 
             dockerfileOptions.setBaseImage(fromImage).setWdtBase(fromImage);
@@ -65,14 +65,14 @@ public CommandResponse call() throws Exception {
 
             String oracleHome = baseImageProperties.getProperty("oracleHome", null);
             if (oracleHome == null) {
-                return new CommandResponse(-1, "IMG-0072", fromImage);
+                return new CommandResponse(1, "IMG-0072", fromImage);
             }
             dockerfileOptions.setOracleHome(oracleHome);
 
             if (wdtOptions.isUsingWdt() && !wdtOptions.modelOnly()) {
                 String domainHome = baseImageProperties.getProperty("domainHome", null);
                 if (domainHome == null && wdtOperation == WdtOperation.UPDATE) {
-                    return new CommandResponse(-1, "IMG-0071", fromImage);
+                    return new CommandResponse(1, "IMG-0071", fromImage);
                 }
             }
 
@@ -83,7 +83,7 @@ public CommandResponse call() throws Exception {
             String baseImageUsr = baseImageProperties.getProperty("oracleHomeUser");
             String baseImageGrp = baseImageProperties.getProperty("oracleHomeGroup");
             if (!dockerfileOptions.userid().equals(baseImageUsr) || !dockerfileOptions.groupid().equals(baseImageGrp)) {
-                return new CommandResponse(-1, "IMG-0087", fromImage, baseImageUsr, baseImageGrp);
+                return new CommandResponse(1, "IMG-0087", fromImage, baseImageUsr, baseImageGrp);
             }
 
             List<InstalledPatch> installedPatches = Collections.emptyList();
@@ -115,18 +115,18 @@ public CommandResponse call() throws Exception {
                     logger.warning("IMG-0009");
                 } else {
                     if (!Utils.validatePatchIds(patches, false)) {
-                        return new CommandResponse(-1, "Patch ID validation failed");
+                        return new CommandResponse(1, "Patch ID validation failed");
                     }
 
                     String oraclePatches = baseImageProperties.getProperty("oraclePatches", null);
                     if (oraclePatches != null) {
                         if (oraclePatches.contains("OPatch failed")) {
                             logger.severe("patch inventory = " + oraclePatches);
-                            return new CommandResponse(-1, "opatch lsinventory failed");
+                            return new CommandResponse(1, "opatch lsinventory failed");
                         }
                         installedPatches = InstalledPatch.getPatchList(oraclePatches);
                     } else {
-                        return new CommandResponse(-1, "lsinventory missing. required to check for conflicts");
+                        return new CommandResponse(1, "lsinventory missing. required to check for conflicts");
                     }
                 }
             }
@@ -138,7 +138,7 @@ public CommandResponse call() throws Exception {
             dockerfileOptions.setWdtCommand(wdtOperation);
             if (dockerfileOptions.runRcu()
                 && (wdtOperation == WdtOperation.UPDATE || wdtOperation == WdtOperation.DEPLOY)) {
-                return new CommandResponse(-1, "IMG-0055");
+                return new CommandResponse(1, "IMG-0055");
             }
 
             FmwInstallerType installerType = FmwInstallerType.fromProductList(
@@ -156,7 +156,7 @@ public CommandResponse call() throws Exception {
                 wdtOptions.handleResourceTemplates(imageTag);
             }
         } catch (Exception ex) {
-            return new CommandResponse(-1, ex.getMessage());
+            return new CommandResponse(1, ex.getMessage());
         } finally {
             if (!skipcleanup) {
                 Utils.deleteFilesRecursively(tmpDir);
diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddEntryTest.java
@@ -57,6 +57,6 @@ void testMissingValue() {
     @Test
     void testInvalidParameters() {
         CommandResponse response = ImageTool.run(new AddEntry(), printStream, printStream, "--key", "", "--value", "");
-        assertEquals(-1, response.getStatus());
+        assertEquals(1, response.getStatus());
     }
 }
diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddInstallerEntryTest.java
@@ -62,6 +62,6 @@ void testMissingVersion() {
     void testInvalidParameters() {
         CommandResponse response = ImageTool.run(new AddInstallerEntry(), printStream, printStream, "--type",
                 InstallerType.WLS.toString(), "--version", "", "--path", "/path/to/non/existent/file");
-        assertEquals(-1, response.getStatus());
+        assertEquals(1, response.getStatus());
     }
 }
diff --git a/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java b/imagetool/src/test/java/com/oracle/weblogic/imagetool/cli/cache/AddPatchEntryTest.java
@@ -63,7 +63,7 @@ void testInvalidFileParameter() {
         int exitCode = cmd.execute("--patchId=12345678_12.2.1.3.0", "--path=/here/there");
         CommandResponse result = cmd.getExecutionResult();
         assertNotNull(result, "Response missing from call to addPatch");
-        assertEquals(-1, result.getStatus());
+        assertEquals(1, result.getStatus());
     }
 
     @Test
@@ -73,6 +73,6 @@ void testInvalidPatchId() {
         cmd.execute("--patchId=12345678", "--path=pom.xml");
         CommandResponse result = cmd.getExecutionResult();
         assertNotNull(result, "Response missing from call to addPatch");
-        assertEquals(-1, result.getStatus());
+        assertEquals(1, result.getStatus());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public static void main(String[] args) {`
`66`	`66`	`}`
`67`	`67`	`System.exit(response.getStatus());`
`68`	`68`	`}`
`69`		`- System.exit(-1);`
	`69`	`+ System.exit(1);`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public CommandResponse call() throws CacheStoreException {`
`30`	`30`	`cache().addToCache(key, location);`
`31`	`31`	`return new CommandResponse(0, msg);`
`32`	`32`	`}`
`33`		`- return new CommandResponse(-1, "IMG-0044");`
	`33`	`+ return new CommandResponse(1, "IMG-0044");`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`@Option(`
Original file line number	Diff line number	Diff line change
`@@ -29,11 +29,11 @@ public CommandResponse call() throws Exception {`
`29`	`29`	`List<String> patches = new ArrayList<>();`
`30`	`30`	`patches.add(patchId);`
`31`	`31`	`if (!Utils.validatePatchIds(patches, true)) {`
`32`		`- return new CommandResponse(-1, "Patch ID validation failed");`
	`32`	`+ return new CommandResponse(1, "Patch ID validation failed");`
`33`	`33`	`}`
`34`	`34`	`return addToCache(patchId);`
`35`	`35`	`} else {`
`36`		`- return new CommandResponse(-1, "IMG-0076", "--patchId");`
	`36`	`+ return new CommandResponse(1, "IMG-0076", "--patchId");`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public abstract class CacheAddOperation extends CacheOperation {`
`17`	`17`	`CommandResponse addToCache(String key) throws CacheStoreException {`
`18`	`18`	`// if file is invalid or does not exist, return an error`
`19`	`19`	`if (filePath == null \|\| !Files.isRegularFile(filePath)) {`
`20`		`- return new CommandResponse(-1, "IMG-0049", filePath);`
	`20`	`+ return new CommandResponse(1, "IMG-0049", filePath);`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`// if the new value is the same as the existing cache value, do nothing`
`@@ -28,7 +28,7 @@ CommandResponse addToCache(String key) throws CacheStoreException {`
`28`	`28`
`29`	`29`	`// if there is already a cache entry and the user did not ask to force it, return an error`
`30`	`30`	`if (!force && existingValue != null) {`
`31`		`- return new CommandResponse(-1, "IMG-0048", key, existingValue);`
	`31`	`+ return new CommandResponse(1, "IMG-0048", key, existingValue);`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`// input appears valid, add the entry to the cache and exit`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public CommandResponse call() throws Exception {`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`	`}`
`37`		`- return new CommandResponse(-1, "IMG-0045");`
	`37`	`+ return new CommandResponse(1, "IMG-0045");`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`@Option(`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public CommandResponse call() throws Exception {`
`51`	`51`	`init(buildId);`
`52`	`52`
`53`	`53`	`if (fromImage == null \|\| fromImage.isEmpty()) {`
`54`		`- return new CommandResponse(-1, "update requires a base image. use --fromImage to specify base image");`
	`54`	`+ return new CommandResponse(1, "update requires a base image. use --fromImage to specify base image");`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`dockerfileOptions.setBaseImage(fromImage).setWdtBase(fromImage);`
`@@ -65,14 +65,14 @@ public CommandResponse call() throws Exception {`
`65`	`65`
`66`	`66`	`String oracleHome = baseImageProperties.getProperty("oracleHome", null);`
`67`	`67`	`if (oracleHome == null) {`
`68`		`- return new CommandResponse(-1, "IMG-0072", fromImage);`
	`68`	`+ return new CommandResponse(1, "IMG-0072", fromImage);`
`69`	`69`	`}`
`70`	`70`	`dockerfileOptions.setOracleHome(oracleHome);`
`71`	`71`
`72`	`72`	`if (wdtOptions.isUsingWdt() && !wdtOptions.modelOnly()) {`
`73`	`73`	`String domainHome = baseImageProperties.getProperty("domainHome", null);`
`74`	`74`	`if (domainHome == null && wdtOperation == WdtOperation.UPDATE) {`
`75`		`- return new CommandResponse(-1, "IMG-0071", fromImage);`
	`75`	`+ return new CommandResponse(1, "IMG-0071", fromImage);`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`
`@@ -83,7 +83,7 @@ public CommandResponse call() throws Exception {`
`83`	`83`	`String baseImageUsr = baseImageProperties.getProperty("oracleHomeUser");`
`84`	`84`	`String baseImageGrp = baseImageProperties.getProperty("oracleHomeGroup");`
`85`	`85`	`if (!dockerfileOptions.userid().equals(baseImageUsr) \|\| !dockerfileOptions.groupid().equals(baseImageGrp)) {`
`86`		`- return new CommandResponse(-1, "IMG-0087", fromImage, baseImageUsr, baseImageGrp);`
	`86`	`+ return new CommandResponse(1, "IMG-0087", fromImage, baseImageUsr, baseImageGrp);`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`List<InstalledPatch> installedPatches = Collections.emptyList();`
`@@ -115,18 +115,18 @@ public CommandResponse call() throws Exception {`
`115`	`115`	`logger.warning("IMG-0009");`
`116`	`116`	`} else {`
`117`	`117`	`if (!Utils.validatePatchIds(patches, false)) {`
`118`		`- return new CommandResponse(-1, "Patch ID validation failed");`
	`118`	`+ return new CommandResponse(1, "Patch ID validation failed");`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`String oraclePatches = baseImageProperties.getProperty("oraclePatches", null);`
`122`	`122`	`if (oraclePatches != null) {`
`123`	`123`	`if (oraclePatches.contains("OPatch failed")) {`
`124`	`124`	`logger.severe("patch inventory = " + oraclePatches);`
`125`		`- return new CommandResponse(-1, "opatch lsinventory failed");`
	`125`	`+ return new CommandResponse(1, "opatch lsinventory failed");`
`126`	`126`	`}`
`127`	`127`	`installedPatches = InstalledPatch.getPatchList(oraclePatches);`
`128`	`128`	`} else {`
`129`		`- return new CommandResponse(-1, "lsinventory missing. required to check for conflicts");`
	`129`	`+ return new CommandResponse(1, "lsinventory missing. required to check for conflicts");`
`130`	`130`	`}`
`131`	`131`	`}`
`132`	`132`	`}`
`@@ -138,7 +138,7 @@ public CommandResponse call() throws Exception {`
`138`	`138`	`dockerfileOptions.setWdtCommand(wdtOperation);`
`139`	`139`	`if (dockerfileOptions.runRcu()`
`140`	`140`	`&& (wdtOperation == WdtOperation.UPDATE \|\| wdtOperation == WdtOperation.DEPLOY)) {`
`141`		`- return new CommandResponse(-1, "IMG-0055");`
	`141`	`+ return new CommandResponse(1, "IMG-0055");`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`FmwInstallerType installerType = FmwInstallerType.fromProductList(`
`@@ -156,7 +156,7 @@ public CommandResponse call() throws Exception {`
`156`	`156`	`wdtOptions.handleResourceTemplates(imageTag);`
`157`	`157`	`}`
`158`	`158`	`} catch (Exception ex) {`
`159`		`- return new CommandResponse(-1, ex.getMessage());`
	`159`	`+ return new CommandResponse(1, ex.getMessage());`
`160`	`160`	`} finally {`
`161`	`161`	`if (!skipcleanup) {`
`162`	`162`	`Utils.deleteFilesRecursively(tmpDir);`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,6 @@ void testMissingValue() {`
`57`	`57`	`@Test`
`58`	`58`	`void testInvalidParameters() {`
`59`	`59`	`CommandResponse response = ImageTool.run(new AddEntry(), printStream, printStream, "--key", "", "--value", "");`
`60`		`- assertEquals(-1, response.getStatus());`
	`60`	`+ assertEquals(1, response.getStatus());`
`61`	`61`	`}`
`62`	`62`	`}`