Remove duplicate call to funtction GetOutput and added a empty test case to yaml parser

Author: cx-miguel-neiva

cmd/main.go

@@ -164,16 +164,21 @@ func postRun(cmd *cobra.Command, args []string) error {
 
 	cfg := config.LoadConfig("2ms", Version)
 
+	var output string
+	var err error
+
 	if Report.TotalItemsScanned > 0 {
-		if err := Report.ShowReport(stdoutFormatVar, cfg); err != nil {
+		output, err = Report.GetOutput(stdoutFormatVar, cfg)
+		if err != nil {
+			return err
+		}
+
+		if err := Report.ShowReport(output); err != nil {
 			return err
 		}
 
 		if len(reportPathVar) > 0 {
-			err := Report.WriteFile(reportPathVar, cfg)
-			if err != nil {
-				return fmt.Errorf("failed to create report file with error: %s", err)
-			}
+			Report.WriteFile(output, reportPathVar, cfg)
 		}
 	} else {
 		log.Info().Msg("Scan completed with empty content")

lib/reporting/report.go

@@ -28,18 +28,12 @@ func Init() *Report {
 		Results: make(map[string][]*secrets.Secret),
 	}
 }
-
-func (r *Report) ShowReport(format string, cfg *config.Config) error {
-	output, err := r.GetOutput(format, cfg)
-	if err != nil {
-		return err
-	}
-
+func (r *Report) ShowReport(output string) error {
 	log.Info().Msg("\n" + output)
 	return nil
 }
 
-func (r *Report) WriteFile(reportPath []string, cfg *config.Config) error {
+func (r *Report) WriteFile(output string, reportPath []string, cfg *config.Config) error {
 	for _, path := range reportPath {
 		err := os.MkdirAll(filepath.Dir(path), 0750)
 		if err != nil {

lib/reporting/report_test.go

@@ -213,15 +213,17 @@ JPcHeO7M6FohKgcEHX84koQDN98J/L7pFlSoU7WOl6f8BKavIdeSTPS9qQYWdQuT
 
 func TestWriteReportInNonExistingDir(t *testing.T) {
 	report := Init()
-
 	tempDir := os.TempDir()
-	path := filepath.Join(tempDir, "test_temp_dir", "sub_dir", "report.yaml")
-	err := report.WriteFile([]string{path}, &config.Config{Name: "report", Version: "5"})
+	dirPath := filepath.Join(tempDir, "test_temp_dir", "sub_dir")
+	filePath := filepath.Join(dirPath, "report.yaml")
+	defer os.RemoveAll(filepath.Join(tempDir, "test_temp_dir"))
+	output, err := report.GetOutput("yaml", &config.Config{Name: "report", Version: "5"})
 	if err != nil {
-		t.Error(err)
+		t.Error("Failed to get report output:", err)
+		return
 	}
 
-	os.RemoveAll(filepath.Join(tempDir, "test_temp_dir"))
+	report.WriteFile(output, []string{filePath}, &config.Config{Name: "report", Version: "5"})
 }
 
 func TestGetOutputSarif(t *testing.T) {
@@ -340,7 +342,14 @@ func TestGetOutputYAML(t *testing.T) {
 	testCases := []struct {
 		name   string
 		report Report
-	}{
+	}{{
+		name: "No secrets found",
+		report: Report{
+			TotalItemsScanned: 5,
+			TotalSecretsFound: 0,
+			Results:           map[string][]*secrets.Secret{},
+		},
+	},
 		{
 			name: "Single real secret in hardcodedPassword.go",
 			report: Report{

lib/reporting/yaml.go

@@ -8,43 +8,49 @@ import (
 )
 
 func writeYaml(report *Report) (string, error) {
+	estimatedSize := 1024 + len(report.Results)*512
 	var builder strings.Builder
+	builder.Grow(estimatedSize)
 
-	builder.WriteString(fmt.Sprintf("totalitemsscanned: %d\n", report.TotalItemsScanned))
-	builder.WriteString(fmt.Sprintf("totalsecretsfound: %d\n", report.TotalSecretsFound))
-	builder.WriteString("results:\n")
+	fmt.Fprintf(&builder, "totalitemsscanned: %d\n", report.TotalItemsScanned)
+	fmt.Fprintf(&builder, "totalsecretsfound: %d\n", report.TotalSecretsFound)
+	if report.TotalSecretsFound == 0 {
+		fmt.Fprint(&builder, "results: {}\n")
+	} else {
 
-	for _, secretsList := range report.Results {
-		if len(secretsList) > 0 {
-			builder.WriteString(fmt.Sprintf("  %s:\n", secretsList[0].ID))
-		}
-		for _, s := range secretsList {
-			builder.WriteString("    - id: " + s.ID + "\n")
-			builder.WriteString("      source: " + s.Source + "\n")
-			builder.WriteString("      ruleid: " + s.RuleID + "\n")
-			builder.WriteString(fmt.Sprintf("      startline: %d\n", s.StartLine))
-			builder.WriteString(fmt.Sprintf("      endline: %d\n", s.EndLine))
-			builder.WriteString(fmt.Sprintf("      linecontent: %q\n", s.LineContent))
-			builder.WriteString(fmt.Sprintf("      startcolumn: %d\n", s.StartColumn))
-			builder.WriteString(fmt.Sprintf("      endcolumn: %d\n", s.EndColumn))
-			builder.WriteString("      value: " + s.Value + "\n")
-			builder.WriteString(fmt.Sprintf("      validationstatus: %q\n", fmt.Sprintf("%v", s.ValidationStatus)))
-			builder.WriteString("      ruledescription: " + s.RuleDescription + "\n")
-			if len(s.ExtraDetails) > 0 {
-				builder.WriteString("      extradetails:\n")
-				marshaled, err := yaml.Marshal(s.ExtraDetails)
-				if err != nil {
-					builder.WriteString(fmt.Sprintf("        error: %v\n", err))
-				} else {
-					lines := strings.Split(string(marshaled), "\n")
-					for _, line := range lines {
-						if line != "" {
-							builder.WriteString("        " + line + "\n")
+		builder.WriteString("results:\n")
+		for _, secretsList := range report.Results {
+			if len(secretsList) > 0 {
+				fmt.Fprintf(&builder, "  %s:\n", secretsList[0].ID)
+			}
+			for _, s := range secretsList {
+				fmt.Fprintf(&builder, "    - id: %s\n", s.ID)
+				fmt.Fprintf(&builder, "      source: %s\n", s.Source)
+				fmt.Fprintf(&builder, "      ruleid: %s\n", s.RuleID)
+				fmt.Fprintf(&builder, "      startline: %d\n", s.StartLine)
+				fmt.Fprintf(&builder, "      endline: %d\n", s.EndLine)
+				fmt.Fprintf(&builder, "      linecontent: %q\n", s.LineContent)
+				fmt.Fprintf(&builder, "      startcolumn: %d\n", s.StartColumn)
+				fmt.Fprintf(&builder, "      endcolumn: %d\n", s.EndColumn)
+				fmt.Fprintf(&builder, "      value: %s\n", s.Value)
+				fmt.Fprintf(&builder, "      validationstatus: %q\n", fmt.Sprintf("%v", s.ValidationStatus))
+				fmt.Fprintf(&builder, "      ruledescription: %s\n", s.RuleDescription)
+				if len(s.ExtraDetails) > 0 {
+					builder.WriteString("      extradetails:\n")
+					marshaled, err := yaml.Marshal(s.ExtraDetails)
+					if err != nil {
+						fmt.Fprintf(&builder, "        error: %v\n", err)
+					} else {
+						lines := strings.Split(string(marshaled), "\n")
+						for _, line := range lines {
+							if line != "" {
+								fmt.Fprintf(&builder, "        %s\n", line)
+							}
 						}
 					}
 				}
+				fmt.Fprintf(&builder, "      cvssscore: %.1f\n", s.CvssScore)
 			}
-			builder.WriteString(fmt.Sprintf("      cvssscore: %.1f\n", s.CvssScore))
 		}
 	}