fix: make CLI return 0 for --version or --help options

rdeltour · rdeltour · commit 49aacb238c3e · 2023-07-06T23:15:30.000+02:00
Fix #1520
diff --git a/src/main/java/com/adobe/epubcheck/tool/EpubChecker.java b/src/main/java/com/adobe/epubcheck/tool/EpubChecker.java
@@ -92,6 +92,7 @@ public class EpubChecker
   File listChecksOut;
   File customMessageFile;
   boolean listChecks = false;
+  boolean displayHelpOrVersion = false;
   boolean useCustomMessageFile = false;
   boolean failOnWarnings = false;
   private Messages messages = Messages.getInstance();
@@ -138,6 +139,10 @@ public int run(String[] args)
           dumpMessageDictionary(report);
           return 0;
         }
+        if (displayHelpOrVersion)
+        {
+          return 0;
+        }
         if (useCustomMessageFile)
         {
           report.setCustomMessageFile(customMessageFile.getAbsolutePath());
@@ -487,7 +492,7 @@ private boolean processArguments(String[] args)
     setCustomMessageFileFromEnvironment();
 
     Pattern argPattern = Pattern.compile("--?(.*)");
-
+    
     for (int i = 0; i < args.length; i++)
     {
       Matcher argMatch = argPattern.matcher(args[i]);
@@ -738,9 +743,11 @@ else if (!fileName.startsWith("-"))
           case "?":
           case "help":
               displayHelp(); // display help message
+              displayHelpOrVersion = true;
             break;
           case "version":
             displayVersion();
+            displayHelpOrVersion = true;
             break;
           default:
               System.err.println(String.format(messages.get("unrecognized_argument"), args[i]));
@@ -789,7 +796,7 @@ else if (!fileName.startsWith("-"))
 
     if (path == null)
     {
-      if (listChecks)
+      if (listChecks || displayHelpOrVersion)
       {
         return true;
       }
diff --git a/src/test/java/com/adobe/epubcheck/tools/CommandLineTest.java b/src/test/java/com/adobe/epubcheck/tools/CommandLineTest.java
@@ -180,7 +180,7 @@ public void notfoundTest()
    * Validate that the -out parameter will generate a well formed xml output.
    *
    * @throws Exception
-   *           Any parsing errors will be thrown as an exception.
+   *         Any parsing errors will be thrown as an exception.
    */
   @Test
   public void outputXMLReportTest()
@@ -206,7 +206,7 @@ public void outputXMLReportTest()
    * unpacked epubs.
    *
    * @throws Exception
-   *           Any parsing errors will be thrown as an exception.
+   *         Any parsing errors will be thrown as an exception.
    */
   @Test
   public void outputXMLModeExpandedReportTest()
@@ -244,7 +244,7 @@ public void quietTest()
    * get a correct xml output report with the output flag.
    *
    * @throws Exception
-   *           Any parsing errors will be thrown as an exception.
+   *         Any parsing errors will be thrown as an exception.
    */
   @Test
   public void quietRunWithOutputTest()
@@ -378,9 +378,8 @@ public void missingLocaleShouldFailTest()
   @Test
   public void helpMessageTest1()
   {
-    runCommandLineTest(1, "-?");
-    assertEquals("Command output not as expected", messages.get("no_file_specified"),
-        errContent.toString().trim());
+    runCommandLineTest(0, "-?");
+    assertEquals("", errContent.toString().trim());
     String expected = String.format(messages.get("help_text").replaceAll("[\\s]+", " "),
         EpubCheck.version());
     String actual = outContent.toString();
@@ -395,9 +394,8 @@ public void helpMessageTest1()
   @Test
   public void helpMessageTest2()
   {
-    runCommandLineTest(1, "-help");
-    assertEquals("Command output not as expected", messages.get("no_file_specified"),
-        errContent.toString().trim());
+    runCommandLineTest(0, "-help");
+    assertEquals("", errContent.toString().trim());
     String expected = String.format(messages.get("help_text").replaceAll("[\\s]+", " "),
         EpubCheck.version());
     String actual = outContent.toString();
@@ -412,9 +410,8 @@ public void helpMessageTest2()
   @Test
   public void helpMessageTest3()
   {
-    runCommandLineTest(1, "--help");
-    assertEquals("Command output not as expected", messages.get("no_file_specified"),
-        errContent.toString().trim());
+    runCommandLineTest(0, "--help");
+    assertEquals("", errContent.toString().trim());
     String expected = String.format(messages.get("help_text").replaceAll("[\\s]+", " "),
         EpubCheck.version());
     String actual = outContent.toString();
@@ -428,9 +425,8 @@ public void helpMessageTest3()
   @Test
   public void versionDisplayTest1()
   {
-    runCommandLineTest(1, "--version");
-    assertEquals("Command output not as expected", messages.get("no_file_specified"),
-        errContent.toString().trim());
+    runCommandLineTest(0, "--version");
+    assertEquals("", errContent.toString().trim());
     String expected = String.format(
         messages.get("epubcheck_version_text").replaceAll("[\\s]+", " "), EpubCheck.version());
     String actual = outContent.toString();
@@ -444,9 +440,8 @@ public void versionDisplayTest1()
   @Test
   public void versionDisplayTest2()
   {
-    runCommandLineTest(1, "-version");
-    assertEquals("Command output not as expected", messages.get("no_file_specified"),
-        errContent.toString().trim());
+    runCommandLineTest(0, "-version");
+    assertEquals("", errContent.toString().trim());
     String expected = String.format(
         messages.get("epubcheck_version_text").replaceAll("[\\s]+", " "), EpubCheck.version());
     String actual = outContent.toString();
@@ -689,7 +684,7 @@ public void failOnWarningsTest()
    * document.
    *
    * @throws Exception
-   *           Throws an exception if the temp file can't be created.
+   *         Throws an exception if the temp file can't be created.
    */
   @Test
   public void jsonFileTest()
@@ -714,7 +709,7 @@ public void jsonFileTest()
    * document.
    *
    * @throws Exception
-   *           Any parsing errors will be thrown as an exception.
+   *         Any parsing errors will be thrown as an exception.
    */
   @Test
   public void xmlFileTest()
@@ -740,7 +735,7 @@ public void xmlFileTest()
    * document.
    *
    * @throws Exception
-   *           Any parsing errors will be thrown as an exception.
+   *         Any parsing errors will be thrown as an exception.
    */
   @Test
   public void xmpFileTest()
