Introduce a generic way to handle errors when communicating with the service endpoints

There was an inconsistency in the way Fuzzers were treating error cases.
Some Fuzzers were ignoring RuntimeExceptions causing the entire run to fail, rather than an
individual test case. This is now handled commonly in the TestCaseListener#createAndExecuteTest()

Author: en-milie

CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]]([email protected]). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -67,85 +67,4 @@ This document was adapted from the open-source contribution guidelines for [Face
 
 # Code of Conduct
 
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]]([email protected]). All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+Please refer to [Code of Conduct](CODE_OF_CONDUCT.md)

README.md

@@ -16,6 +16,17 @@ The following logging levels are used (in both the console and the test report)
 - `WARN` will report normal but undocumented behaviour or some misalignment between the contract and the service. This will **ideally** be actioned.
 - `ERROR` will report abnormal/unexpected behaviour. This **must** be actioned.
 
+
+# How the Fuzzing works
+CATS will iterate through all endpoints, all HTTP methods and all the associated requests bodies and parameters and `fuzz` their data models fields values according to their defined data type and constraints. The actual fuzzing depends on the specific `Fuzzer` executed. Please see the list of fuzzers and their behaviour.
+There are also differences on how the fuzzing works depending on the HTTP method:
+
+- for methods with request bodies like POST, PUT the fuzzing will be applied at the request body data models level
+- for methods without request bodies like GET, DELETE the fuzzing will be applied at the URL parameters level
+
+This means that for methods with request bodies you need to supply the `path` parameters via `urlParams` or the `referenceData` file as failure to do so will result in `Illegal character in path at index ...` errors. 
+
+
 # Build
 
 You can use the following Maven command to build the project:

src/main/java/com/endava/cats/fuzzer/HappyFuzzer.java

@@ -28,21 +28,15 @@ public HappyFuzzer(ServiceCaller sc, TestCaseListener lr) {
     }
 
     public void fuzz(FuzzingData data) {
-        testCaseListener.createAndExecuteTest(() ->
-                process(data)
-        );
+        testCaseListener.createAndExecuteTest(LOGGER, this, () -> process(data));
     }
 
     private void process(FuzzingData data) {
-        try {
-            testCaseListener.addScenario(LOGGER, "Scenario: send a 'happy' flow request will all fields and all headers in");
-            testCaseListener.addExpectedResult(LOGGER, "Expected result: should get a 2XX response code");
-            CatsResponse response = serviceCaller.call(data.getMethod(), ServiceData.builder().relativePath(data.getPath()).headers(data.getHeaders()).payload(data.getPayload()).build());
-
-            testCaseListener.reportResult(LOGGER, data, response, ResponseCodeFamily.TWOXX);
-        } catch (Exception e) {
-            testCaseListener.reportError(LOGGER, "Fuzzer [{}] failed due to [{}]", this.getClass().getSimpleName(), e.getMessage());
-        }
+        testCaseListener.addScenario(LOGGER, "Scenario: send a 'happy' flow request will all fields and all headers in");
+        testCaseListener.addExpectedResult(LOGGER, "Expected result: should get a 2XX response code");
+        CatsResponse response = serviceCaller.call(data.getMethod(), ServiceData.builder().relativePath(data.getPath()).headers(data.getHeaders()).payload(data.getPayload()).build());
+
+        testCaseListener.reportResult(LOGGER, data, response, ResponseCodeFamily.TWOXX);
     }
 
     public String toString() {

src/main/java/com/endava/cats/fuzzer/fields/BaseFieldsFuzzer.java

@@ -40,9 +40,7 @@ public void fuzz(FuzzingData data) {
         logger.info("All fields {}", data.getAllFieldsAsSingleSet());
 
         for (String fuzzedField : data.getAllFieldsAsSingleSet()) {
-            testCaseListener.createAndExecuteTest(() ->
-                    process(data, fuzzedField)
-            );
+            testCaseListener.createAndExecuteTest(logger, this, () -> process(data, fuzzedField));
         }
     }
 
@@ -58,19 +56,16 @@ protected void process(FuzzingData data, String fuzzedField) {
             FuzzingResult fuzzingResult = catsUtil.replaceFieldWithFuzzedValue(data.getPayload(), fuzzedField, fuzzingStrategy);
             boolean isFuzzedValueMatchingPattern = this.isFuzzedValueMatchingPattern(fuzzingResult.getFuzzedValue(), data, fuzzedField);
 
-            try {
-                ServiceData serviceData = ServiceData.builder().relativePath(data.getPath())
-                        .headers(data.getHeaders()).payload(fuzzingResult.getJson().toString())
-                        .fuzzedField(fuzzedField).build();
-                CatsResponse response = serviceCaller.call(data.getMethod(), serviceData);
 
-                ResponseCodeFamily expectedResponseCodeBasedOnConstraints = this.getExpectedResponseCodeBasedOnConstraints(isFuzzedValueMatchingPattern, fuzzingConstraints);
+            ServiceData serviceData = ServiceData.builder().relativePath(data.getPath())
+                    .headers(data.getHeaders()).payload(fuzzingResult.getJson().toString())
+                    .fuzzedField(fuzzedField).build();
+            CatsResponse response = serviceCaller.call(data.getMethod(), serviceData);
 
-                testCaseListener.addExpectedResult(logger, "Expected result: should return [{}]", expectedResponseCodeBasedOnConstraints.asString());
-                testCaseListener.reportResult(logger, data, response, expectedResponseCodeBasedOnConstraints);
-            } catch (Exception e) {
-                testCaseListener.reportError(logger, "Fuzzer [{}] failed due to [{}]", this.getClass().getSimpleName(), e.getMessage());
-            }
+            ResponseCodeFamily expectedResponseCodeBasedOnConstraints = this.getExpectedResponseCodeBasedOnConstraints(isFuzzedValueMatchingPattern, fuzzingConstraints);
+
+            testCaseListener.addExpectedResult(logger, "Expected result: should return [{}]", expectedResponseCodeBasedOnConstraints.asString());
+            testCaseListener.reportResult(logger, data, response, expectedResponseCodeBasedOnConstraints);
         } else {
             FuzzingStrategy strategy = this.createSkipStrategy(fuzzingStrategy);
             testCaseListener.skipTest(logger, strategy.process(""));

src/main/java/com/endava/cats/fuzzer/fields/CustomFuzzer.java

@@ -61,11 +61,11 @@ protected void processCustomFuzzerFile(FuzzingData data) {
 
     private void executeTestCases(FuzzingData data, String key, Object value) {
         LOGGER.info("Path [{}] has the following custom data [{}]", data.getPath(), value);
-        if (this.entryIsValid((Map<String, Object>) value)) {
 
+        if (this.entryIsValid((Map<String, Object>) value)) {
             List<Map<String, String>> individualTestCases = this.createIndividualRequest((Map<String, Object>) value);
             for (Map<String, String> individualTestCase : individualTestCases) {
-                testCaseListener.createAndExecuteTest(() -> process(data, key, individualTestCase));
+                testCaseListener.createAndExecuteTest(LOGGER, this, () -> process(data, key, individualTestCase));
             }
         } else {
             LOGGER.warn("Skipping path [{}] as not valid. It either doesn't contain a valid expectedResponseCode or there is more than one list of values for a specific field", data.getPath());
@@ -74,18 +74,13 @@ private void executeTestCases(FuzzingData data, String key, Object value) {
 
     private void process(FuzzingData data, String testName, Map<String, String> currentPathValues) {
         testCaseListener.addScenario(LOGGER, "Scenario: send request with custom values supplied. Test key [{}]", testName);
-        try {
-            String expectedResponseCode = String.valueOf(currentPathValues.get(EXPECTED_RESPONSE_CODE));
-            testCaseListener.addExpectedResult(LOGGER, "Expected result: should return [{}]", expectedResponseCode);
+        String expectedResponseCode = String.valueOf(currentPathValues.get(EXPECTED_RESPONSE_CODE));
+        testCaseListener.addExpectedResult(LOGGER, "Expected result: should return [{}]", expectedResponseCode);
 
-            String payloadWithCustomValuesReplaced = this.getStringWithCustomValuesFromFile(data, currentPathValues);
-            CatsResponse response = serviceCaller.call(data.getMethod(), ServiceData.builder().relativePath(data.getPath()).replaceRefData(false)
-                    .headers(data.getHeaders()).payload(payloadWithCustomValuesReplaced).build());
-            testCaseListener.reportResult(LOGGER, data, response, ResponseCodeFamily.from(expectedResponseCode));
-
-        } catch (Exception e) {
-            testCaseListener.reportError(LOGGER, "Fuzzer [{}] failed due to [{}]", this.getClass().getSimpleName(), e.getMessage());
-        }
+        String payloadWithCustomValuesReplaced = this.getStringWithCustomValuesFromFile(data, currentPathValues);
+        CatsResponse response = serviceCaller.call(data.getMethod(), ServiceData.builder().relativePath(data.getPath()).replaceRefData(false)
+                .headers(data.getHeaders()).payload(payloadWithCustomValuesReplaced).build());
+        testCaseListener.reportResult(LOGGER, data, response, ResponseCodeFamily.from(expectedResponseCode));
     }
 
     private String getStringWithCustomValuesFromFile(FuzzingData data, Map<String, String> currentPathValues) {

src/main/java/com/endava/cats/fuzzer/fields/NewFieldsFuzzer.java

@@ -35,9 +35,7 @@ public NewFieldsFuzzer(ServiceCaller sc, TestCaseListener lr, CatsUtil cu) {
 
     @Override
     public void fuzz(FuzzingData data) {
-        testCaseListener.createAndExecuteTest(() ->
-                process(data)
-        );
+        testCaseListener.createAndExecuteTest(LOGGER, this, () -> process(data));
     }
 
     private void process(FuzzingData data) {