feat: Show reported vs skipped tests in console

Author: ludovicianul

src/main/java/dev/dochia/cli/core/report/ExecutionStatisticsListener.java

@@ -30,6 +30,11 @@ public class ExecutionStatisticsListener {
      */
     private final Map<String, Long> success = new HashMap<>();
 
+    /**
+     * Map to track the count of requests that were skipped from reporting per path.
+     */
+    private final Map<String, Long> skippedFromReporting = new HashMap<>();
+
     /**
      * Count of skipped tests.
      */
@@ -96,6 +101,15 @@ public void increaseSuccess(String path) {
         this.success.merge(path, 1L, Long::sum);
     }
 
+    /**
+     * Increases the count of requests skipped from reporting for a specific path.
+     *
+     * @param path The path for which skipped requests are increased.
+     */
+    public void increaseSkippedFromReporting(String path) {
+        this.skippedFromReporting.merge(path, 1L, Long::sum);
+    }
+
     /**
      * Gets the total count of errors across all paths.
      *
@@ -132,6 +146,24 @@ public long getAll() {
         return this.getSuccess() + this.getWarns() + this.getErrors();
     }
 
+    /**
+     * Gets the total count of all requests made (before skip logic).
+     *
+     * @return The total count of all requests.
+     */
+    public long getTotalRequests() {
+        return this.getAll() + getSkippedFromReporting();
+    }
+
+    /**
+     * Gets the total count of requests skipped from reporting.
+     *
+     * @return The total count of skipped requests.
+     */
+    public long getSkippedFromReporting() {
+        return this.skippedFromReporting.values().stream().reduce(0L, Long::sum);
+    }
+
     /**
      * Checks if there are many authentication errors, considering their ratio to the total number of executions.
      *

src/main/java/dev/dochia/cli/core/report/TestCaseExporter.java

@@ -258,16 +258,22 @@ private void writeExecutionTimesForPathAndHttpMethod(String key, List<TestCaseEx
      *
      */
     public void printExecutionDetails() {
-        String dochiaFinished = AnsiUtils.blue("{} tests completed in {}\n");
+        long totalRequests = executionStatisticsListener.getTotalRequests();
+        long skippedFromReporting = executionStatisticsListener.getSkippedFromReporting();
+        long reportedResults = executionStatisticsListener.getAll();
+
+        String dochiaFinished = AnsiUtils.blue("{} tests completed in {}. {} reported, {} skipped\n");
         String passed = AnsiUtils.boldGreen("  ✔ {} passed, ");
         String warnings = AnsiUtils.boldYellow("⚠ {} warnings, ");
         String errors = AnsiUtils.boldRed("‼ {} errors");
+
         String check = AnsiUtils.blue(String.format("Full Report: %s ", reportingPath.toUri() + getSummaryReportTitle()));
         String finalMessage = dochiaFinished + passed + warnings + errors;
         String duration = Duration.ofMillis(System.currentTimeMillis() - t0).toString().toLowerCase(Locale.ROOT).substring(2);
 
         ConsoleUtils.emptyLine();
-        logger.complete(finalMessage, executionStatisticsListener.getAll(), duration, executionStatisticsListener.getSuccess(), executionStatisticsListener.getWarns(), executionStatisticsListener.getErrors(), executionStatisticsListener.getSkipped());
+        logger.complete(finalMessage, totalRequests, reportedResults, skippedFromReporting,
+                executionStatisticsListener.getAll(), duration, executionStatisticsListener.getSuccess(), executionStatisticsListener.getWarns(), executionStatisticsListener.getErrors(), executionStatisticsListener.getSkipped());
 
         // Print quality gate result
         boolean qualityGatePassed = !qualityGateArguments.shouldFailBuild(executionStatisticsListener.getErrors(), executionStatisticsListener.getWarns());

src/main/java/dev/dochia/cli/core/report/TestCaseListener.java

@@ -496,6 +496,7 @@ void reportWarn(PrettyLogger logger, String message, Object... params) {
         } else if (ignoreArguments.isSkipReportingForWarnings()) {
             this.logger.debug(RECEIVED_RESPONSE_IS_MARKED_AS_IGNORED_SKIPPING);
             this.skipTest(logger, replaceBrackets("Skip reporting as --hide-warnings is enabled"));
+            executionStatisticsListener.increaseSkippedFromReporting(testCase.getContractPath());
             this.recordResult(message, params, SKIP_REPORTING, logger);
         } else if (ignoreArguments.isNotIgnoredResponse(httpResponse)) {
             this.logger.debug("Received response is not marked as ignored... reporting warn!");
@@ -505,6 +506,7 @@ void reportWarn(PrettyLogger logger, String message, Object... params) {
         } else if (ignoreArguments.isSkipReportingForIgnoredArguments()) {
             this.logger.debug(RECEIVED_RESPONSE_IS_MARKED_AS_IGNORED_SKIPPING);
             this.skipTest(logger, replaceBrackets("Some response elements were marked as filtered through --filter-*** arguments."));
+            executionStatisticsListener.increaseSkippedFromReporting(testCase.getContractPath());
             this.recordResult(message, params, SKIP_REPORTING, logger);
         } else {
             testCase.setResultIgnoreDetails("warning");
@@ -579,6 +581,7 @@ void reportError(PrettyLogger logger, String message, Object... params) {
         } else if (ignoreArguments.isSkipReportingForIgnoredArguments()) {
             this.logger.debug(RECEIVED_RESPONSE_IS_MARKED_AS_IGNORED_SKIPPING);
             this.skipTest(logger, "Some response elements were filtered usinbg --filter-* argyments.");
+            executionStatisticsListener.increaseSkippedFromReporting(testCase.getContractPath());
             this.recordResult(message, params, SKIP_REPORTING, logger);
         } else {
             testCase.setResultIgnoreDetails(Level.ERROR.toString());
@@ -667,10 +670,12 @@ void reportInfo(PrettyLogger logger, String message, Object... params) {
         } else if (ignoreArguments.isSkipReportingForSuccess()) {
             this.logger.debug(RECEIVED_RESPONSE_IS_MARKED_AS_IGNORED_SKIPPING);
             this.skipTest(logger, replaceBrackets("Skip reporting as --hide-success is enabled"));
+            executionStatisticsListener.increaseSkippedFromReporting(testCase.getContractPath());
             this.recordResult(message, params, SKIP_REPORTING, logger);
         } else if (ignoreArguments.isIgnoredResponse(httpResponse) && ignoreArguments.isSkipReportingForIgnoredArguments()) {
             this.logger.debug(RECEIVED_RESPONSE_IS_MARKED_AS_IGNORED_SKIPPING);
             this.skipTest(logger, "Some response elements were filtered using --filter-* arguments.");
+            executionStatisticsListener.increaseSkippedFromReporting(testCase.getContractPath());
             this.recordResult(message, params, SKIP_REPORTING, logger);
         } else if (httpResponse.exceedsExpectedResponseTime(reportingArguments.getMaxResponseTime())) {
             this.logger.debug("Received response time exceeds --maxResponseTimeInMs: actual {}, max {}",

src/test/java/dev/dochia/cli/core/report/ExecutionStatisticsListenerTest.java

@@ -81,4 +81,24 @@ void shouldTestForIOErrors(int authErrors, int all, boolean expected) {
 
         Assertions.assertThat(listener.areManyIoErrors()).isEqualTo(expected);
     }
+
+    @Test
+    void shouldTrackSkippedFromReporting() {
+        ExecutionStatisticsListener listener = new ExecutionStatisticsListener();
+        listener.increaseSkippedFromReporting("/path1");
+        listener.increaseSkippedFromReporting("/path2");
+        listener.increaseSuccess("/path1");
+
+        Assertions.assertThat(listener.getTotalRequests()).isEqualTo(3);
+        Assertions.assertThat(listener.getSkippedFromReporting()).isEqualTo(2);
+        Assertions.assertThat(listener.getAll()).isEqualTo(1);
+    }
+
+    @Test
+    void shouldReturnZeroForTotalRequestsWhenNoneTracked() {
+        ExecutionStatisticsListener listener = new ExecutionStatisticsListener();
+
+        Assertions.assertThat(listener.getTotalRequests()).isZero();
+        Assertions.assertThat(listener.getSkippedFromReporting()).isZero();
+    }
 }