add summaryjson report format (#334)

* add summaryjson report format

Author: cx-pedro-lopes

internal/commands/result.go

@@ -61,7 +61,8 @@ func NewResultCommand(resultsWrapper wrappers.ResultsWrapper, scanWrapper wrappe
 		RunE:  runGetResultCommand(resultsWrapper, scanWrapper),
 	}
 	addScanIDFlag(resultCmd, "ID to report on.")
-	addResultFormatFlag(resultCmd, util.FormatJSON, util.FormatSummary, util.FormatSummaryConsole, util.FormatSarif)
+	addResultFormatFlag(resultCmd,
+		util.FormatJSON, util.FormatSummary, util.FormatSummaryConsole, util.FormatSarif, util.FormatSummaryJSON)
 	resultCmd.PersistentFlags().String(commonParams.TargetFlag, "cx_result", "Output file")
 	resultCmd.PersistentFlags().String(commonParams.TargetPathFlag, ".", "Output Path")
 	resultCmd.PersistentFlags().StringSlice(commonParams.FilterFlag, []string{}, filterResultsListFlagUsage)
@@ -250,6 +251,10 @@ func createReport(
 		summaryRpt := createTargetName(targetFile, targetPath, "html")
 		return writeHTMLSummary(summaryRpt, summary)
 	}
+	if util.IsFormat(format, util.FormatSummaryJSON) {
+		summaryRpt := createTargetName(targetFile, targetPath, "json")
+		return exportJSONSummaryResults(summaryRpt, summary)
+	}
 	err := fmt.Errorf("bad report format %s", format)
 	return err
 }
@@ -342,6 +347,23 @@ func exportJSONResults(targetFile string, results *wrappers.ScanResultsCollectio
 	return nil
 }
 
+func exportJSONSummaryResults(targetFile string, results *wrappers.ResultSummary) error {
+	var err error
+	var resultsJSON []byte
+	log.Println("Creating summary JSON Report: ", targetFile)
+	resultsJSON, err = json.Marshal(results)
+	if err != nil {
+		return errors.Wrapf(err, "%s: failed to serialize results response ", failedGettingAll)
+	}
+	f, err := os.Create(targetFile)
+	if err != nil {
+		return errors.Wrapf(err, "%s: failed to create target file  ", failedGettingAll)
+	}
+	_, _ = fmt.Fprintln(f, string(resultsJSON))
+	_ = f.Close()
+	return nil
+}
+
 func convertCxResultsToSarif(results *wrappers.ScanResultsCollection) *wrappers.SarifResultsCollection {
 	var sarif = new(wrappers.SarifResultsCollection)
 	sarif.Schema = "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json"

internal/commands/result_test.go

@@ -39,6 +39,13 @@ func TestRunGetResultsByScanIdJsonFormat(t *testing.T) {
 	os.Remove(fmt.Sprintf("%s.%s", fileName, util.FormatJSON))
 }
 
+func TestRunGetResultsByScanIdSummaryJsonFormat(t *testing.T) {
+	execCmdNilAssertion(t, "result", "--scan-id", "MOCK", "--report-format", "summaryJSON")
+
+	// Remove generated json file
+	os.Remove(fmt.Sprintf("%s.%s", fileName, util.FormatJSON))
+}
+
 func TestRunGetResultsByScanIdSummaryHtmlFormat(t *testing.T) {
 	execCmdNilAssertion(t, "result", "--scan-id", "MOCK", "--report-format", "summaryHTML")
 

internal/commands/util/printer.go

@@ -17,6 +17,7 @@ const (
 	FormatSarif          = "sarif"
 	FormatSonar          = "sonar"
 	FormatSummary        = "summaryHTML"
+	FormatSummaryJSON    = "summaryJSON"
 	FormatSummaryConsole = "summaryConsole"
 	FormatList           = "list"
 	FormatTable          = "table"

test/integration/result_test.go

@@ -28,7 +28,7 @@ func TestResultListJson(t *testing.T) {
 
 	outputBuffer := executeCmdNilAssertion(t, "Getting results should pass",
 		"result",
-		flag(params.TargetFormatFlag), strings.Join([]string{util.FormatJSON, util.FormatSarif, util.FormatSummary, util.FormatSummaryConsole, util.FormatSonar}, ","),
+		flag(params.TargetFormatFlag), strings.Join([]string{util.FormatJSON, util.FormatSarif, util.FormatSummary, util.FormatSummaryConsole, util.FormatSonar, util.FormatSummaryJSON}, ","),
 		flag(params.TargetFlag), fileName,
 		flag(params.ScanIDFlag), scanID,
 		flag(params.TargetPathFlag), resultsDirectory,