chore: Sonarqube improvements

Author: en-milie

src/main/java/com/endava/cats/command/ExplainCommand.java

@@ -67,7 +67,7 @@ private void displayErrorReason() {
         Arrays.stream(CatsResultFactory.Reason.values()).filter(reason -> reason.name()
                         .toLowerCase(Locale.ROOT).contains(info.toLowerCase(Locale.ROOT)))
                 .sorted()
-                .forEach(reason -> logger.noFormat("* Reason {} - {}", reason.reason(), reason.description()));
+                .forEach(reason -> logger.noFormat("* Reason {} - {}", reason.value(), reason.description()));
     }
 
     private void displayFuzzerInfo() {

src/main/java/com/endava/cats/fuzzer/fields/base/TwoXXorFourXXReplaceStringsFuzzer.java

@@ -45,7 +45,7 @@ public void fuzz(FuzzingData data) {
         ResponseCodeFamily expectedResponseCodes = new ResponseCodeFamilyDynamic(List.of("2XX", "4XX"));
         fieldsIteratorExecutor.execute(
                 FieldsIteratorExecutorContext.builder()
-                        .scenario("Replace fields with characters %s".formatted(this.typesOfDataSentToTheService()))
+                        .scenario("Replace fields with %s.".formatted(this.typesOfDataSentToTheService()))
                         .fuzzingData(data).fuzzingStrategy(FuzzingStrategy.replace())
                         .expectedResponseCode(expectedResponseCodes)
                         .fuzzValueProducer(this.fuzzValueProducer())

src/main/java/com/endava/cats/model/CatsResultFactory.java

@@ -15,7 +15,7 @@ public interface CatsResultFactory {
      */
     static CatsResult createExpectedResponse(String receivedResponseCode) {
         String message = "Response matches expected result. Response code [%s] is documented and response body matches the corresponding schema.".formatted(receivedResponseCode);
-        String reason = Reason.ALL_GOOD.description();
+        String reason = Reason.ALL_GOOD.value();
 
         return new CatsResult(message, reason);
     }
@@ -28,7 +28,7 @@ static CatsResult createExpectedResponse(String receivedResponseCode) {
      */
     static CatsResult createNotMatchingResponseSchema(String receivedResponseCode) {
         String message = "Response does NOT match expected result. Response code [%s] is documented, but response body does NOT match the corresponding schema.".formatted(receivedResponseCode);
-        String reason = Reason.NOT_MATCHING_RESPONSE_SCHEMA.description();
+        String reason = Reason.NOT_MATCHING_RESPONSE_SCHEMA.value();
 
         return new CatsResult(message, reason);
     }
@@ -42,7 +42,7 @@ static CatsResult createNotMatchingResponseSchema(String receivedResponseCode) {
      */
     static CatsResult createNotMatchingContentType(List<String> expected, String actual) {
         String message = "Response content type not matching the contract: expected %s, actual [%s]".formatted(expected, actual);
-        String reason = Reason.RESPONSE_CONTENT_TYPE_NOT_MATCHING.description();
+        String reason = Reason.RESPONSE_CONTENT_TYPE_NOT_MATCHING.value();
         return new CatsResult(message, reason);
     }
 
@@ -61,7 +61,7 @@ static CatsResult createNotImplemented() {
      * @return a CatsResult to use in reports
      */
     static CatsResult createNotFound() {
-        return new CatsResult("Response HTTP code 404: you might need to provide business context using --refData or --urlParams", Reason.NOT_FOUND.description());
+        return new CatsResult("Response HTTP code 404: you might need to provide business context using --refData or --urlParams", Reason.NOT_FOUND.value());
     }
 
     /**
@@ -73,7 +73,7 @@ static CatsResult createNotFound() {
      */
     static CatsResult createResponseTimeExceedsMax(long receivedResponseTime, long maxResponseTime) {
         String message = "Test case executed successfully, but response time exceeds --maxResponseTimeInMs: actual %d, max %d".formatted(receivedResponseTime, maxResponseTime);
-        String reason = Reason.RESPONSE_TIME_EXCEEDS_MAX.description();
+        String reason = Reason.RESPONSE_TIME_EXCEEDS_MAX.value();
 
         return new CatsResult(message, reason);
     }
@@ -87,7 +87,7 @@ static CatsResult createResponseTimeExceedsMax(long receivedResponseTime, long m
      */
     static CatsResult createUnexpectedException(String fuzzer, String errorMessage) {
         String message = "Fuzzer [%s] failed due to [%s]".formatted(fuzzer, errorMessage);
-        String reason = Reason.UNEXPECTED_EXCEPTION.description();
+        String reason = Reason.UNEXPECTED_EXCEPTION.value();
 
         return new CatsResult(message, reason);
     }
@@ -100,7 +100,7 @@ static CatsResult createUnexpectedException(String fuzzer, String errorMessage)
      */
     static CatsResult createErrorLeaksDetectedInResponse(List<String> keywords) {
         String message = "The following keywords were detected in the response which might suggest an error details leak: %s".formatted(keywords);
-        String reason = Reason.ERROR_LEAKS_DETECTED.description();
+        String reason = Reason.ERROR_LEAKS_DETECTED.value();
 
         return new CatsResult(message, reason);
     }
@@ -115,7 +115,7 @@ static CatsResult createErrorLeaksDetectedInResponse(List<String> keywords) {
      */
     static CatsResult createUnexpectedBehaviour(String receivedResponseCode, String expectedResponseCode) {
         String message = "Unexpected behaviour: expected %s, actual [%s]".formatted(expectedResponseCode, receivedResponseCode);
-        String reason = Reason.UNEXPECTED_BEHAVIOUR.description() + " %s".formatted(receivedResponseCode);
+        String reason = Reason.UNEXPECTED_BEHAVIOUR.value() + " %s".formatted(receivedResponseCode);
 
         return new CatsResult(message, reason);
     }
@@ -129,7 +129,7 @@ static CatsResult createUnexpectedBehaviour(String receivedResponseCode, String
      */
     static CatsResult createUnexpectedResponseCode(String receivedResponseCode, String expectedResponseCode) {
         String message = "Response does NOT match expected result. Response code is NOT from a list of expected codes for this FUZZER: expected %s, actual [%s]".formatted(expectedResponseCode, receivedResponseCode);
-        String reason = Reason.UNEXPECTED_RESPONSE_CODE.description() + ": %s".formatted(receivedResponseCode);
+        String reason = Reason.UNEXPECTED_RESPONSE_CODE.value() + ": %s".formatted(receivedResponseCode);
 
         return new CatsResult(message, reason);
     }
@@ -144,7 +144,7 @@ static CatsResult createUnexpectedResponseCode(String receivedResponseCode, Stri
      */
     static CatsResult createUndocumentedResponseCode(String receivedResponseCode, String expectedResponseCode, String documentedResponseCodes) {
         String message = "Response does NOT match expected result. Response code is from a list of expected codes for this FUZZER, but it is undocumented: expected %s, actual [%s], documented response codes: %s".formatted(expectedResponseCode, receivedResponseCode, documentedResponseCodes);
-        String reason = Reason.UNDOCUMENTED_RESPONSE_CODE.description() + ": %s".formatted(receivedResponseCode);
+        String reason = Reason.UNDOCUMENTED_RESPONSE_CODE.value() + ": %s".formatted(receivedResponseCode);
 
         return new CatsResult(message, reason);
     }
@@ -172,20 +172,20 @@ enum Reason {
         RESPONSE_CONTENT_TYPE_NOT_MATCHING("Response content type not matching the contract", "The response content type does not match the one defined in the OpenAPI contract"),
         UNEXPECTED_BEHAVIOUR("Unexpected behaviour", "CATS run the test case successfully, but the response code was not expected, nor documented, nor known to typically be documented");
 
-        private final String reason;
+        private final String value;
         private final String description;
 
-        Reason(String reason, String description) {
-            this.reason = reason;
+        Reason(String value, String description) {
+            this.value = value;
             this.description = description;
         }
 
         public String description() {
             return description;
         }
 
-        public String reason() {
-            return reason;
+        public String value() {
+            return value;
         }
     }
 }

src/test/java/com/endava/cats/command/GenerateCommandTest.java

@@ -33,7 +33,7 @@ class GenerateCommandTest {
     ProcessingArguments processingArguments;
 
     @BeforeEach
-    public void init() {
+    void init() {
         generateCommand = new GenerateCommand(fuzzingDataFactory, catsGlobalContext, processingArguments);
     }
 

src/test/java/com/endava/cats/command/ReplayCommandTest.java

@@ -29,7 +29,7 @@ class ReplayCommandTest {
     private TestCaseListener testCaseListener;
 
     @BeforeEach
-    public void setup() {
+    void setup() {
         replayCommand = new ReplayCommand(serviceCaller, testCaseListener);
         replayCommand.authArgs = Mockito.mock(AuthArguments.class);
         ReflectionTestUtils.setField(testCaseListener, "testCaseExporter", Mockito.mock(TestCaseExporter.class));

src/test/java/com/endava/cats/fuzzer/fields/base/ExactValuesInFieldsFuzzerTest.java

@@ -26,7 +26,7 @@ class ExactValuesInFieldsFuzzerTest {
     private FilesArguments filesArguments;
 
     @BeforeEach
-    public void setup() {
+    void setup() {
         filesArguments = Mockito.mock(FilesArguments.class);
         myBaseBoundaryFuzzer = new MyExactValueFuzzer(null, null, filesArguments);
     }

src/test/java/com/endava/cats/io/ServiceCallerTest.java

@@ -53,7 +53,7 @@ class ServiceCallerTest {
     private ServiceCaller serviceCaller;
 
     @BeforeAll
-    public static void setup() {
+    static void setup() {
         wireMockServer = new WireMockServer(new WireMockConfiguration().dynamicPort());
         wireMockServer.start();
         wireMockServer.stubFor(WireMock.get("/not-json").willReturn(WireMock.ok("<html>test</html>")));
@@ -74,12 +74,12 @@ public static void setup() {
     }
 
     @AfterAll
-    public static void clean() {
+    static void clean() {
         wireMockServer.stop();
     }
 
     @BeforeEach
-    public void setupEach() throws Exception {
+    void setupEach() throws Exception {
         filesArguments = new FilesArguments();
         TestCaseListener testCaseListener = Mockito.mock(TestCaseListener.class);
         serviceCaller = new ServiceCaller(catsGlobalContext, testCaseListener, filesArguments, authArguments, apiArguments, processingArguments);

src/test/java/com/endava/cats/util/VersionCheckerTest.java

@@ -17,19 +17,19 @@ class VersionCheckerTest {
     private static VersionChecker versionChecker;
 
     @BeforeAll
-    public static void setup() {
+    static void setup() {
         wireMockServer = new WireMockServer(new WireMockConfiguration().dynamicPort());
         wireMockServer.start();
         VersionChecker.baseUrl = "http://localhost:" + wireMockServer.port() + "/latest";
     }
 
     @BeforeEach
-    public void setupEach() {
+    void setupEach() {
         versionChecker = new VersionChecker();
     }
 
     @AfterAll
-    public static void clean() {
+    static void clean() {
         wireMockServer.stop();
     }