Fix for #75 - preserve types when readinf from cats config files

Endava · Sep 12, 2023 · 123fa8f · 123fa8f
1 parent 68ca800
commit 123fa8f
Show file tree

Hide file tree

Showing 16 changed files with 89 additions and 88 deletions.
diff --git a/src/main/java/com/endava/cats/args/FilesArguments.java b/src/main/java/com/endava/cats/args/FilesArguments.java
@@ -22,15 +22,14 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-import java.util.stream.Collectors;
 
 @Singleton
 public class FilesArguments {
     private static final String ALL = "all";
     private final PrettyLogger log = PrettyLoggerFactory.getLogger(this.getClass());
-    private Map<String, Map<String, String>> headers;
-    private Map<String, Map<String, String>> queryParams;
-    private Map<String, Map<String, String>> refData;
+    private Map<String, Map<String, Object>> headers;
+    private Map<String, Map<String, Object>> queryParams;
+    private Map<String, Map<String, Object>> refData;
     private Map<String, Map<String, Object>> customFuzzerDetails = new HashMap<>();
     private Map<String, Map<String, Object>> securityFuzzerDetails = new HashMap<>();
 
@@ -49,7 +48,7 @@ public class FilesArguments {
             description = "Specifies the headers that will be passed along with the request. When supplied it will be applied to ALL paths. For per-path control use the `--headers` arg that requires a file.")
     @Setter
     @Getter
-    Map<String, String> headersMap;
+    Map<String, Object> headersMap;
 
     @CommandLine.Option(names = {"--queryParams"},
             description = "Specifies additional query parameters that will be passed along with request. This can be used to pass non-documented query params")
@@ -137,7 +136,7 @@ public void loadHeaders() throws IOException {
         /*Merge headers from file with the ones supplied using the -H argument*/
         if (headersMap != null) {
             headers.merge(ALL, headersMap, (stringStringMap, stringStringMap2) -> {
-                Map<String, String> mergedMap = new HashMap<>(stringStringMap);
+                Map<String, Object> mergedMap = new HashMap<>(stringStringMap);
                 mergedMap.putAll(stringStringMap2);
                 return mergedMap;
             });
@@ -178,7 +177,7 @@ public String replacePathWithUrlParams(String startingUrl) {
      *
      * @return a Map representation of the --headers file with paths being the Map keys
      */
-    public Map<String, String> getHeaders(String path) {
+    public Map<String, Object> getHeaders(String path) {
         return getPathAndAll(headers, path);
     }
 
@@ -190,7 +189,7 @@ public Map<String, String> getHeaders(String path) {
      * @param currentPath the current API path
      * @return a Map with the supplied --refData
      */
-    public Map<String, String> getRefData(String currentPath) {
+    public Map<String, Object> getRefData(String currentPath) {
         return getPathAndAll(refData, currentPath);
     }
 
@@ -201,7 +200,7 @@ public Map<String, String> getRefData(String currentPath) {
      * @param path the given path
      * @return a key-value map with all additional query params
      */
-    public Map<String, String> getAdditionalQueryParamsForPath(String path) {
+    public Map<String, Object> getAdditionalQueryParamsForPath(String path) {
         return getPathAndAll(queryParams, path);
     }
 
@@ -224,20 +223,19 @@ public Map<String, Map<String, Object>> getSecurityFuzzerDetails() {
     }
 
 
-    static Map<String, String> getPathAndAll(Map<String, Map<String, String>> collection, String path) {
+    static Map<String, Object> getPathAndAll(Map<String, Map<String, Object>> collection, String path) {
         return collection.entrySet().stream()
                 .filter(entry -> entry.getKey().equalsIgnoreCase(path) || entry.getKey().equalsIgnoreCase(ALL))
                 .map(Map.Entry::getValue).collect(HashMap::new, Map::putAll, Map::putAll);
     }
 
-
-    private Map<String, Map<String, String>> loadFileAsMapOfMapsOfStrings(File file, String fileType) throws IOException {
-        Map<String, Map<String, String>> fromFile = new HashMap<>();
+    private Map<String, Map<String, Object>> loadFileAsMapOfMapsOfStrings(File file, String fileType) throws IOException {
+        Map<String, Map<String, Object>> fromFile = new HashMap<>();
         if (file == null) {
             log.debug("No {} file provided!", fileType);
         } else {
             log.config("{} file supplied {}", fileType, file.getAbsolutePath());
-            fromFile = this.loadYamlFileToMap(file.getAbsolutePath());
+            fromFile = this.parseYaml(file.getAbsolutePath());
             log.debug("{} file loaded successfully: {}", fileType, fromFile);
         }
         return fromFile;
@@ -257,14 +255,4 @@ public Map<String, Map<String, Object>> parseYaml(String yaml) throws IOExceptio
         }
         return result;
     }
-
-    public Map<String, Map<String, String>> loadYamlFileToMap(String filePath) throws IOException {
-        Map<String, Map<String, String>> result = new HashMap<>();
-        Map<String, Map<String, Object>> headersAsObject = this.parseYaml(filePath);
-        for (Map.Entry<String, Map<String, Object>> entry : headersAsObject.entrySet()) {
-            result.put(entry.getKey(), entry.getValue().entrySet()
-                    .stream().collect(Collectors.toMap(Map.Entry::getKey, en -> String.valueOf(en.getValue()))));
-        }
-        return result;
-    }
 }
diff --git a/src/main/java/com/endava/cats/command/CatsCommand.java b/src/main/java/com/endava/cats/command/CatsCommand.java
@@ -60,7 +60,7 @@
         defaultValueProvider = CommandLine.PropertiesDefaultProvider.class,
         exitCodeOnInvalidInput = 191,
         exitCodeOnExecutionException = 192,
-        resourceBundle = "version",
+//        resourceBundle = "version",
         subcommands = {
                 AutoComplete.GenerateCompletion.class,
                 CommandLine.HelpCommand.class,

diff --git a/src/main/java/com/endava/cats/command/RunCommand.java b/src/main/java/com/endava/cats/command/RunCommand.java
@@ -65,7 +65,7 @@ public class RunCommand implements Runnable, CommandLine.IExitCodeGenerator {
 
     @CommandLine.Option(names = {"-H"},
             description = "Specifies the headers that will be passed along with the request. When supplied it will be applied to ALL paths. For per-path control use the `--headers` arg that requires a file.")
-    Map<String, String> headersMap;
+    Map<String, Object> headersMap;
 
     @CommandLine.Option(names = {"--createRefData"},
             description = "This is only applicable when enabling the @|bold FunctionalFuzzer |@. It will instruct the @|bold FunctionalFuzzer|@ to create a @|bold,underline --refData|@ file " +

diff --git a/src/main/java/com/endava/cats/fuzzer/executor/FieldsIteratorExecutor.java b/src/main/java/com/endava/cats/fuzzer/executor/FieldsIteratorExecutor.java
@@ -62,7 +62,7 @@ public void execute(FieldsIteratorExecutorContext context) {
         Set<String> allFields = context.getFuzzingData().getAllFieldsByHttpMethod();
         context.getLogger().debug("All fields: {}", allFields);
         List<String> fieldsToBeRemoved = filesArguments.getRefData(context.getFuzzingData().getPath()).entrySet()
-                .stream().filter(entry -> entry.getValue().equalsIgnoreCase(CATS_REMOVE_FIELD)).map(Map.Entry::getKey).toList();
+                .stream().filter(entry -> String.valueOf(entry.getValue()).equalsIgnoreCase(CATS_REMOVE_FIELD)).map(Map.Entry::getKey).toList();
         context.getLogger().config("The following fields marked as [{}] in refData will not be fuzzed: {}", CATS_REMOVE_FIELD, fieldsToBeRemoved);
 
         fieldsToBeRemoved.forEach(allFields::remove);

diff --git a/src/main/java/com/endava/cats/fuzzer/fields/InvalidReferencesFieldsFuzzer.java b/src/main/java/com/endava/cats/fuzzer/fields/InvalidReferencesFieldsFuzzer.java
@@ -11,6 +11,7 @@
 import com.endava.cats.generator.simple.UnicodeGenerator;
 import com.endava.cats.report.TestCaseListener;
 import com.endava.cats.util.ConsoleUtils;
+import com.endava.cats.util.WordUtils;
 import io.github.ludovicianul.prettylogger.PrettyLogger;
 import io.github.ludovicianul.prettylogger.PrettyLoggerFactory;
 
@@ -80,6 +81,7 @@ private List<String> replacePathVariables(String path) {
         for (String variable : variables) {
             String variableName = variable.substring(1, variable.length() - 1);
             String value = Optional.ofNullable(filesArguments.getRefData(path).get(variableName))
+                    .map(WordUtils::nullOrValueOf)
                     .orElse(filesArguments.getUrlParamsList()
                             .stream()
                             .filter(param -> param.startsWith(variableName + ":"))

diff --git a/src/main/java/com/endava/cats/fuzzer/fields/base/BaseFieldsFuzzer.java b/src/main/java/com/endava/cats/fuzzer/fields/base/BaseFieldsFuzzer.java
@@ -51,7 +51,7 @@ public void fuzz(FuzzingData data) {
         logger.debug("All fields {}", allFields);
 
         List<String> fieldsToBeRemoved = filesArguments.getRefData(data.getPath()).entrySet()
-                .stream().filter(entry -> entry.getValue().equalsIgnoreCase(CATS_REMOVE_FIELD)).map(Map.Entry::getKey).toList();
+                .stream().filter(entry -> String.valueOf(entry.getValue()).equalsIgnoreCase(CATS_REMOVE_FIELD)).map(Map.Entry::getKey).toList();
         logger.config("The following fields marked as [{}] in refData will not be fuzzed: {}", CATS_REMOVE_FIELD, fieldsToBeRemoved);
 
         fieldsToBeRemoved.forEach(allFields::remove);