fix: Fix issue with progress not being displayed when request payload…

… contained many fields
Endava · Jun 6, 2024 · 04aaac4 · 04aaac4
1 parent 67c1ead
commit 04aaac4
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 11 deletions.
diff --git a/src/main/java/com/endava/cats/command/CatsCommand.java b/src/main/java/com/endava/cats/command/CatsCommand.java
@@ -384,7 +384,7 @@ private void runFuzzers(List<FuzzingData> fuzzingDataListWithHttpMethodsFiltered
             filteredData.forEach(data -> {
                 logger.start("Starting Fuzzer {}, http method {}, path {}", ansi().fgGreen().a(fuzzer.toString()).reset(), data.getMethod(), data.getPath());
                 logger.debug("Fuzzing payload: {}", data.getPayload());
-                testCaseListener.beforeFuzz(fuzzer.getClass());
+                testCaseListener.beforeFuzz(fuzzer.getClass(), data.getContractPath(), data.getMethod().name());
                 fuzzer.fuzz(data);
                 if (!(fuzzer instanceof FunctionalFuzzer)) {
                     testCaseListener.afterFuzz(data.getContractPath(), data.getMethod().name());

diff --git a/src/main/java/com/endava/cats/command/TemplateFuzzCommand.java b/src/main/java/com/endava/cats/command/TemplateFuzzCommand.java
@@ -142,7 +142,7 @@ public void run() {
                     .targetFields(fieldsToFuzz)
                     .build();
 
-            beforeFuzz();
+            beforeFuzz(fuzzingData.getContractPath(), fuzzingData.getMethod().name());
             templateFuzzer.fuzz(fuzzingData);
             afterFuzz(fuzzingData.getContractPath(), fuzzingData.getMethod().name());
         } catch (IOException e) {
@@ -189,9 +189,9 @@ private void afterFuzz(String path, String method) {
         testCaseListener.endSession();
     }
 
-    private void beforeFuzz() throws IOException {
+    private void beforeFuzz(String path, String method) throws IOException {
         testCaseListener.initReportingPath();
-        testCaseListener.beforeFuzz(templateFuzzer.getClass());
+        testCaseListener.beforeFuzz(templateFuzzer.getClass(), path, method);
     }
 
     private Set<CatsHeader> getHeaders() {

diff --git a/src/main/java/com/endava/cats/fuzzer/special/FunctionalFuzzer.java b/src/main/java/com/endava/cats/fuzzer/special/FunctionalFuzzer.java
@@ -84,7 +84,7 @@ public void executeCustomFuzzerTests() {
         for (Map.Entry<String, Map<String, Object>> entry : filesArguments.getCustomFuzzerDetails().entrySet()) {
             executions.stream().filter(customFuzzerExecution -> customFuzzerExecution.getFuzzingData().getContractPath().equalsIgnoreCase(entry.getKey()))
                     .forEach(customFuzzerExecution -> {
-                        testCaseListener.beforeFuzz(this.getClass());
+                        testCaseListener.beforeFuzz(this.getClass(), customFuzzerExecution.getFuzzingData().getContractPath(), customFuzzerExecution.getFuzzingData().getMethod().name());
                         customFuzzerUtil.executeTestCases(customFuzzerExecution.getFuzzingData(), customFuzzerExecution.getTestId(),
                                 customFuzzerExecution.getTestEntry(), this);
                         testCaseListener.afterFuzz(customFuzzerExecution.getFuzzingData().getContractPath(), customFuzzerExecution.getFuzzingData().getMethod().name());

diff --git a/src/main/java/com/endava/cats/report/TestCaseListener.java b/src/main/java/com/endava/cats/report/TestCaseListener.java
@@ -132,10 +132,12 @@ private String getKeyDefault() {
      *
      * @param fuzzer the class representing the fuzzer
      */
-    public void beforeFuzz(Class<?> fuzzer) {
+    public void beforeFuzz(Class<?> fuzzer, String path, String method) {
         String clazz = ConsoleUtils.removeTrimSanitize(fuzzer.getSimpleName()).replaceAll("[a-z]", "");
         MDC.put(FUZZER, ConsoleUtils.centerWithAnsiColor(clazz, getKeyDefault().length(), Ansi.Color.MAGENTA));
         MDC.put(FUZZER_KEY, ConsoleUtils.removeTrimSanitize(fuzzer.getSimpleName()));
+        this.notifySummaryObservers(path, method, 1);
+
     }
 
     /**
@@ -439,7 +441,7 @@ public void endSession() {
     }
 
     /**
-     * Renders a FUZZING header is logging is SUMMARY.
+     * Renders a FUZZING header if logging is SUMMARY.
      */
     public void renderFuzzingHeader() {
         if (reportingArguments.isSummaryInConsole()) {

diff --git a/src/test/java/com/endava/cats/command/CatsCommandTest.java b/src/test/java/com/endava/cats/command/CatsCommandTest.java
@@ -139,7 +139,7 @@ void givenContractAndServerParameter_whenStartingCats_thenParametersAreProcessed
         Mockito.verify(testCaseListener, Mockito.times(1)).startSession();
         Mockito.verify(testCaseListener, Mockito.times(1)).endSession();
         Mockito.verify(testCaseListener, Mockito.times(20)).afterFuzz(Mockito.any(), Mockito.any());
-        Mockito.verify(testCaseListener, Mockito.times(10)).beforeFuzz(PathTagsLinterFuzzer.class);
+        Mockito.verify(testCaseListener, Mockito.times(10)).beforeFuzz(Mockito.eq(PathTagsLinterFuzzer.class), Mockito.any(), Mockito.any());
 
         ReflectionTestUtils.setField(apiArguments, "contract", "empty");
         ReflectionTestUtils.setField(apiArguments, "server", "empty");
@@ -170,8 +170,8 @@ void givenAnOpenApiContract_whenStartingCats_thenTheContractIsCorrectlyParsed()
         Mockito.verify(fuzzingDataFactory).fromPathItem(Mockito.eq("/pet"), Mockito.any(), Mockito.any());
         Mockito.verify(fuzzingDataFactory, Mockito.times(0)).fromPathItem(Mockito.eq("/petss"), Mockito.any(), Mockito.any());
         Mockito.verify(testCaseListener, Mockito.times(13)).afterFuzz(Mockito.any(), Mockito.any());
-        Mockito.verify(testCaseListener, Mockito.times(9)).beforeFuzz(PathTagsLinterFuzzer.class);
-        Mockito.verify(testCaseListener, Mockito.times(4)).beforeFuzz(CheckDeletedResourcesNotAvailableFuzzer.class);
+        Mockito.verify(testCaseListener, Mockito.times(9)).beforeFuzz(Mockito.eq(PathTagsLinterFuzzer.class), Mockito.anyString(), Mockito.anyString());
+        Mockito.verify(testCaseListener, Mockito.times(4)).beforeFuzz(Mockito.eq(CheckDeletedResourcesNotAvailableFuzzer.class), Mockito.any(), Mockito.any());
 
         ReflectionTestUtils.setField(apiArguments, "contract", "empty");
         ReflectionTestUtils.setField(apiArguments, "server", "empty");

diff --git a/src/test/java/com/endava/cats/report/TestCaseListenerTest.java b/src/test/java/com/endava/cats/report/TestCaseListenerTest.java
@@ -803,7 +803,7 @@ void shouldReturnCurrentTestNumber() {
 
     @Test
     void shouldReturnCurrentFuzzer() {
-        testCaseListener.beforeFuzz(RandomResourcesFuzzer.class);
+        testCaseListener.beforeFuzz(RandomResourcesFuzzer.class, "test", "post");
         String currentFuzzer = testCaseListener.getCurrentFuzzer();
         Assertions.assertThat(currentFuzzer).isEqualTo("RandomResources");
     }