feat: Update exit codes to be standard 0, 1, 2

en-milie · en-milie · commit 9df6dffdc4ce · 2026-01-21T23:02:48.000+02:00
diff --git a/src/main/java/com/endava/cats/command/CatsCommand.java b/src/main/java/com/endava/cats/command/CatsCommand.java
@@ -84,18 +84,15 @@
         versionProvider = VersionProvider.class,
         commandListHeading = "%n@|bold,underline Commands:|@%n",
         defaultValueProvider = CommandLine.PropertiesDefaultProvider.class,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         resourceBundle = "version",
         abbreviateSynopsis = true,
         synopsisHeading = "@|bold,underline Usage:|@%n",
         customSynopsis = {"@|bold cats|@ @|fg(yellow) -c|@ <CONTRACT> @|fg(yellow) -s|@ <SERVER> [ADDITIONAL OPTIONS]",
                 "@|bold cats (list | replay | run | template | lint | info | stats | validate | random | generate | explain)|@ [OPTIONS]", "%n"},
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command",
-                "@|bold ERR|@:Where ERR is the number of errors reported by cats"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Run CATS in blackbox mode and only report 500 http error codes:",
                 "    cats -c openapi.yml -s http://localhost:8080 -b -k",
@@ -263,7 +260,7 @@ public void run() {
         } catch (CatsException | IOException | ExecutionException | IllegalArgumentException e) {
             logger.fatal("Something went wrong while running CATS: {}", e.toString());
             logger.debug("Stacktrace: {}", e);
-            exitCodeDueToErrors = 192;
+            exitCodeDueToErrors = CommandLine.ExitCode.SOFTWARE;
         } finally {
             testCaseListener.endSession();
         }
@@ -508,7 +505,10 @@ private List<FuzzingData> filterFuzzingData(List<FuzzingData> fuzzingDataListWit
 
     @Override
     public int getExitCode() {
-        return exitCodeDueToErrors + executionStatisticsListener.getErrors();
+        if (exitCodeDueToErrors > 0) {
+            return exitCodeDueToErrors;
+        }
+        return executionStatisticsListener.getErrors() > 0 ? CommandLine.ExitCode.SOFTWARE : CommandLine.ExitCode.OK;
     }
 
     @Override
diff --git a/src/main/java/com/endava/cats/command/ExplainCommand.java b/src/main/java/com/endava/cats/command/ExplainCommand.java
@@ -21,12 +21,10 @@
         name = "explain",
         mixinStandardHelpOptions = true,
         usageHelpAutoWidth = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {" Explain a 9XX response code:",
                 "    cats explain --type response_code 953",
diff --git a/src/main/java/com/endava/cats/command/GenerateCommand.java b/src/main/java/com/endava/cats/command/GenerateCommand.java
@@ -32,13 +32,11 @@
         name = "generate",
         mixinStandardHelpOptions = true,
         usageHelpAutoWidth = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         description = "Generates valid requests based on the given OpenAPI spec",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Generate payloads for a POST on /test from a given OpenAPI contract:",
                 "    cats generate -c openapi.yml -X POST -p /test",
@@ -101,7 +99,7 @@ public GenerateCommand(FuzzingDataFactory fuzzingDataFactory, CatsGlobalContext
         this.processingArguments = processingArguments;
     }
 
-    private int exitCodeDueToErrors = 0;
+    private int exitCodeDueToErrors = CommandLine.ExitCode.OK;
 
     @Override
     public void run() {
@@ -133,7 +131,7 @@ public void run() {
         } catch (IOException | IllegalArgumentException e) {
             logger.fatal("Something went wrong while running CATS: {}", e.toString());
             logger.debug("Stacktrace: {}", e);
-            exitCodeDueToErrors = 192;
+            exitCodeDueToErrors = CommandLine.ExitCode.SOFTWARE;
         }
     }
 
diff --git a/src/main/java/com/endava/cats/command/InfoCommand.java b/src/main/java/com/endava/cats/command/InfoCommand.java
@@ -18,12 +18,10 @@
         name = "info",
         mixinStandardHelpOptions = true,
         usageHelpAutoWidth = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Get info about current environment:",
                 "    cats info",
diff --git a/src/main/java/com/endava/cats/command/LintCommand.java b/src/main/java/com/endava/cats/command/LintCommand.java
@@ -24,13 +24,10 @@
         usageHelpAutoWidth = true,
         description = "Run OpenAPI contract linters",
         abbreviateSynopsis = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command",
-                "@|bold ERR|@:Where ERR is the number of errors reported by cats"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Lint an OpenAPI contract:",
                 "    cats lint -c openapi.yml",
diff --git a/src/main/java/com/endava/cats/command/ListCommand.java b/src/main/java/com/endava/cats/command/ListCommand.java
@@ -54,13 +54,11 @@
         name = "list",
         mixinStandardHelpOptions = true,
         usageHelpAutoWidth = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         description = "List Fuzzers, OpenAPI paths, OpenAPI formats, Mutators, Custom Mutator Types and FieldFuzzing strategies",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  List all paths for an OpenAPI contract:",
                 "    cats list --paths -c openapi.yml",
diff --git a/src/main/java/com/endava/cats/command/RandomCommand.java b/src/main/java/com/endava/cats/command/RandomCommand.java
@@ -27,14 +27,11 @@
         usageHelpAutoWidth = true,
         description = "Run continuous fuzzing based on random mutators, rather than pre-defined fuzzers",
         abbreviateSynopsis = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         synopsisHeading = "%nUsage: ",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command",
-                "@|bold ERR|@:Where ERR is the number of errors reported by cats"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Run continuous fuzzing for path /my-path for 100 seconds and match 500 http response codes:",
                 "    cats random -H header=value -X POST -p /my-path -s http://localhost:8080 --mc 500 --stopAfterTimeInSec 100  ",
diff --git a/src/main/java/com/endava/cats/command/ReplayCommand.java b/src/main/java/com/endava/cats/command/ReplayCommand.java
@@ -36,13 +36,11 @@
         name = "replay",
         mixinStandardHelpOptions = true,
         usageHelpAutoWidth = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         description = "Replay previously executed CATS tests",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Replay Test 1 from the default reporting folder:",
                 "    cats replay Test1",
diff --git a/src/main/java/com/endava/cats/command/RunCommand.java b/src/main/java/com/endava/cats/command/RunCommand.java
@@ -31,14 +31,11 @@
         usageHelpAutoWidth = true,
         description = "Run functional tests written in CATS YAML format",
         abbreviateSynopsis = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         synopsisHeading = "%nUsage: ",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command",
-                "@|bold ERR|@:Where ERR is the number of errors reported by cats"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Run custom payloads using the SecurityFuzzer:",
                 "    cats run -c openapi.yml -s http://localhost:8080 securityFuzzer.yml",
diff --git a/src/main/java/com/endava/cats/command/StatsCommand.java b/src/main/java/com/endava/cats/command/StatsCommand.java
@@ -30,13 +30,11 @@
         name = "stats",
         mixinStandardHelpOptions = true,
         usageHelpAutoWidth = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         description = "Prints statistics about an OpenAPI spec file",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Print stats for an OpenAPI contract:",
                 "    cats stats -c openapi.yml",
diff --git a/src/main/java/com/endava/cats/command/TemplateFuzzCommand.java b/src/main/java/com/endava/cats/command/TemplateFuzzCommand.java
@@ -56,14 +56,11 @@
         usageHelpAutoWidth = true,
         description = "Run Fuzzers based on a supplied request template or query & path params",
         abbreviateSynopsis = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         synopsisHeading = "%nUsage: ",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command",
-                "@|bold ERR|@:Where ERR is the number of errors reported by cats"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Run fuzz tests for a given POST request:",
                 "    cats template -H header=value -X POST -d '{\"field1\":\"value1\",\"field2\":\"value2\",\"field3\":\"value3\"}' -t \"field1,field2,header\" -i \"2XX,4XX\" http://service-url ",
diff --git a/src/main/java/com/endava/cats/command/ValidateCommand.java b/src/main/java/com/endava/cats/command/ValidateCommand.java
@@ -19,13 +19,11 @@
         name = "validate",
         mixinStandardHelpOptions = true,
         usageHelpAutoWidth = true,
-        exitCodeOnInvalidInput = 191,
-        exitCodeOnExecutionException = 192,
         description = "Performs strict validation for a given OpenAPI spec",
         exitCodeListHeading = "%n@|bold,underline Exit Codes:|@%n",
         exitCodeList = {"@|bold  0|@:Successful program execution",
-                "@|bold 191|@:Usage error: user input for the command was incorrect",
-                "@|bold 192|@:Internal execution error: an exception occurred when executing command"},
+                "@|bold 2|@:Usage error: user input for the command was incorrect",
+                "@|bold 1|@:Internal execution error: an exception occurred when executing command"},
         footerHeading = "%n@|bold,underline Examples:|@%n",
         footer = {"  Check if a given OpenAPI contract is valid:",
                 "    cats validate -c openapi.yml"},
diff --git a/src/main/java/com/endava/cats/util/CatsParamExceptionHandler.java b/src/main/java/com/endava/cats/util/CatsParamExceptionHandler.java
@@ -4,6 +4,9 @@
 import io.github.ludovicianul.prettylogger.PrettyLoggerFactory;
 import picocli.CommandLine;
 
+/**
+ * Custom exception handler for picocli.
+ */
 public class CatsParamExceptionHandler implements CommandLine.IParameterExceptionHandler {
     private final PrettyLogger logger = PrettyLoggerFactory.getLogger(CatsParamExceptionHandler.class);
 
@@ -12,6 +15,6 @@ public int handleParseException(CommandLine.ParameterException ex, String[] args
         logger.fatal(AnsiUtils.red("{}"), ex.getMessage());
         logger.fatal(AnsiUtils.bold("Try cats --help for the full list of arguments"));
 
-        return 191;
+        return CommandLine.ExitCode.USAGE;
     }
 }
diff --git a/src/test/java/com/endava/cats/command/CatsCommandTest.java b/src/test/java/com/endava/cats/command/CatsCommandTest.java
@@ -190,7 +190,7 @@ void givenAnOpenApiContract_whenStartingCats_thenTheContractIsCorrectlyParsed()
     void shouldReturnErrorsExitCode() {
         Mockito.when(executionStatisticsListener.getErrors()).thenReturn(190);
 
-        Assertions.assertThat(catsMain.getExitCode()).isEqualTo(190);
+        Assertions.assertThat(catsMain.getExitCode()).isEqualTo(1);
     }
 
     @Test
diff --git a/src/test/java/com/endava/cats/command/GenerateCommandTest.java b/src/test/java/com/endava/cats/command/GenerateCommandTest.java
@@ -80,6 +80,6 @@ void shouldRunWhenContractAndPath(String pretty) {
     void shouldThrowExceptionWhenContractIssues(String contract) {
         CommandLine commandLine = new CommandLine(generateCommand);
         commandLine.execute("--contract", contract, "--path", "/pet", "--debug");
-        Assertions.assertThat(generateCommand.getExitCode()).isEqualTo(192);
+        Assertions.assertThat(generateCommand.getExitCode()).isEqualTo(1);
     }
 }
diff --git a/src/test/java/com/endava/cats/command/LintCommandTest.java b/src/test/java/com/endava/cats/command/LintCommandTest.java
@@ -59,6 +59,6 @@ void shouldReturnNonZeroExitCode() {
         Mockito.when(listener.getErrors()).thenReturn(10);
         ReflectionTestUtils.setField(catsCommand, "executionStatisticsListener", listener);
         int exitCode = lintCommand.getExitCode();
-        Assertions.assertThat(exitCode).isEqualTo(10);
+        Assertions.assertThat(exitCode).isEqualTo(1);
     }
 }
diff --git a/src/test/java/com/endava/cats/command/RunCommandTest.java b/src/test/java/com/endava/cats/command/RunCommandTest.java
@@ -86,7 +86,7 @@ void shouldReturnNonZeroExitCode() {
         Mockito.when(listener.getErrors()).thenReturn(10);
         ReflectionTestUtils.setField(catsCommand, "executionStatisticsListener", listener);
         int exitCode = runCommand.getExitCode();
-        Assertions.assertThat(exitCode).isEqualTo(10);
+        Assertions.assertThat(exitCode).isEqualTo(1);
     }
 
     @Test
