Adapted log-parser to include JSON in the commandline execution (#181)

* Adapted log-parser to include JSON in the commandline execution

Author: baubakg

README.md

@@ -456,7 +456,7 @@ java -jar log-parser-1.11.0.jar --startDir=/path/to/logs --parseDefinition=/path
 
 You can provide additional information such as:
 * `--fileFilter` : The wildcard used for selecting the log files. The default value is *.log
-* `--reportType` : The format of the report. The allowed values are currently HTML & CSV. The default value is HTML
+* `--reportType` : The format of the report. The allowed values are currently HTML, JSON & CSV. The default value is HTML
 * `--reportFileName` : The name of the report file. By default, this is the name of the Parse Definition name suffixed with '-export'
 * `--reportName` : The report title as show in an HTML report. By default, the title includes the Parse Definition name
 
@@ -472,6 +472,7 @@ All reports are stored in the directory `log-parser-reports/export/`.
 - **(new feature)** [#138](https://github.com/adobe/log-parser/issues/138) We now have the possibility of anonymizing log data during parsing. For more information please read the section on [Anonymizing Data](#anonymizing-data).
 - **(new feature)** [#117](https://github.com/adobe/log-parser/issues/117) You can now include the file name in the result of the analysis.
 - **(new feature)** [#141](https://github.com/adobe/log-parser/issues/141) You can now export a LogData as a table in a HTML file.
+- **(new feature)** [#173](https://github.com/adobe/log-parser/issues/173) You can now export a LogData as a JSON file.
 - **(new feature)** [#123](https://github.com/adobe/log-parser/issues/123) We now log the total number and size of the parsed files.
 - [#110](https://github.com/adobe/log-parser/issues/110) Moved to Java 11
 - [#169](https://github.com/adobe/log-parser/issues/169) We only keep one Parse Definition entry with the same title in a Parse Definition.

src/main/java/com/adobe/campaign/tests/logparser/RunLogParser.java

@@ -64,18 +64,26 @@ public static void main(String[] in_args) throws StringParseException {
                 l_targetSDKClass);
 
         //Generate Report
-        if (RunArguments.REPORT_FORMAT.fetchValue(in_args).equalsIgnoreCase("CSV")) {
-            l_logData.exportLogDataToCSV(RunArguments.REPORT_FILENAME.fetchValue(in_args,
-                    l_parseDefinition.fetchEscapedTitle() + "-export.csv"));
-        } else if (RunArguments.REPORT_FORMAT.fetchValue(in_args).equalsIgnoreCase("HTML")) {
-            l_logData.exportLogDataToHTML(
-                    RunArguments.REPORT_NAME.fetchValue(in_args, l_parseDefinition.getTitle()),
-                    RunArguments.REPORT_FILENAME.fetchValue(in_args,
-                            l_parseDefinition.fetchEscapedTitle() + "-export.html"));
-        } else {
-            System.err.println("The report format " + RunArguments.REPORT_FORMAT.fetchValue(in_args)
-                    + " is not supported.");
+        switch (RunArguments.REPORT_FORMAT.fetchValue(in_args).toUpperCase()) {
+            case "CSV":
+                l_logData.exportLogDataToCSV(RunArguments.REPORT_FILENAME.fetchValue(in_args,
+                        l_parseDefinition.fetchEscapedTitle() + "-export.csv"));
+                break;
+            case "HTML":
+                l_logData.exportLogDataToHTML(
+                        RunArguments.REPORT_NAME.fetchValue(in_args, l_parseDefinition.getTitle()),
+                        RunArguments.REPORT_FILENAME.fetchValue(in_args,
+                                l_parseDefinition.fetchEscapedTitle() + "-export.html"));
+                break;
+            case "JSON":
+                l_logData.exportLogDataToJSON(RunArguments.REPORT_FILENAME.fetchValue(in_args,
+                        l_parseDefinition.fetchEscapedTitle() + "-export.json"));
+                break;
+            default:
+                System.err.println("The report format " + RunArguments.REPORT_FORMAT.fetchValue(in_args)
+                        + " is not supported.");
         }
 
+
     }
 }

src/main/java/com/adobe/campaign/tests/logparser/core/LogData.java

@@ -518,7 +518,7 @@ public File exportLogDataToJSON(String in_jsonFileName) throws LogDataExportToFi
         T l_firstEntry = this.fetchFirst();
 
         if (l_firstEntry != null) {
-            return exportLogDataToJSON(l_firstEntry.fetchHeaders(), in_jsonFileName + "-export.json");
+            return exportLogDataToJSON(l_firstEntry.fetchHeaders(), in_jsonFileName);
         } else {
             log.warn("No Log data to export. Please load the log data before re-attempting");
             return null;

src/main/java/com/adobe/campaign/tests/logparser/utils/RunArguments.java

@@ -21,7 +21,7 @@ public enum RunArguments {
             "The SDK class to be used for transforming the log data to objects. It is just the class name.",
             "com.adobe.campaign.tests.logparser.core.GenericEntry"),
     REPORT_FORMAT("reportType", false,
-            "The format of the report. The allowed values are currently HTML & CSV.", "HTML"),
+            "The format of the report. The allowed values are currently HTML, JSON & CSV.", "HTML"),
     REPORT_FILENAME("reportFileName", false, "The name of the report file. By default, this is the name of the Parse Definition name suffixed with '-export'", ""),
     REPORT_NAME("reportName", false, "The report title as show in an HTML report. By default the title includes the Parse Definition name", ""),
 

src/test/java/com/adobe/campaign/tests/logparser/ExecutionTests.java

@@ -15,6 +15,7 @@
 import com.adobe.campaign.tests.logparser.utils.CSVManager;
 import com.adobe.campaign.tests.logparser.utils.LogParserFileUtils;
 import com.adobe.campaign.tests.logparser.utils.RunArguments;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.hamcrest.Matchers;
 import org.testng.annotations.Test;
 
@@ -95,6 +96,44 @@ public void testSTDMain_printCSV() throws IOException, StringParseException {
         }
     }
 
+
+    @Test
+    public void testSTDMain_printJSON() throws IOException, StringParseException {
+        String l_rootPath = "src/test/resources/nestedDirs/";
+        String l_fileFilter = "simple*.log";
+
+        final String l_jsonPath = "src/test/resources/parseDefinitions/simpleParseDefinitionLogDataFactory.json";
+
+        ParseDefinition l_parseDefinition = ParseDefinitionFactory.importParseDefinition(l_jsonPath);
+
+        String[] l_args = { RunArguments.START_DIR.buildArgument(l_rootPath),
+                RunArguments.FILTER_LOG_FILES.buildArgument(l_fileFilter),
+                RunArguments.PARSE_DEFINITIONS_FILE.buildArgument(l_jsonPath),
+                RunArguments.REPORT_FORMAT.buildArgument("JSON") };
+
+        RunLogParser.main(l_args);
+
+        File l_exportedFile = new File(LogParserFileUtils.LOG_PARSER_EXPORTS,
+                l_parseDefinition.fetchEscapedTitle() + "-export.json");
+
+        assertThat("We should successfully create the file", l_exportedFile, notNullValue());
+        assertThat("We should successfully create the file", l_exportedFile.exists());
+        assertThat("We should successfully create the file correctly", l_exportedFile.isFile());
+        try {
+            assertThat("We successfully created the file correctly", l_exportedFile.getName(),
+                    Matchers.endsWith(l_parseDefinition.fetchEscapedTitle() + "-export.json"));
+
+            ObjectMapper objectMapper = new ObjectMapper();
+            String values = objectMapper.readValue(l_exportedFile, String.class);
+
+            assertThat("JSON file contains correct verb definition", values.contains(l_parseDefinition.getDefinitionEntries().get(0).getTitle()));
+            assertThat("JSON file contains correct api definition", values.contains(l_parseDefinition.getDefinitionEntries().get(1).getTitle()));
+
+        } finally {
+            l_exportedFile.delete();
+        }
+    }
+
     @Test
     public void testSTDMain_printCSV_empty() throws IOException, StringParseException {
         String l_rootPath = "src/test/resources/logTests/acc/";