refactor: be consistent with report data / output terminology

Bearer · Aug 25, 2023 · 33977ef · 33977ef
1 parent c928a6e
commit 33977ef
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/new/detector/composition/testhelper/testhelper.go b/new/detector/composition/testhelper/testhelper.go
@@ -143,7 +143,7 @@ func (runner *Runner) scanSingleFile(t *testing.T, testDataPath string, fileRela
 	}
 
 	runner.config.Scan.Target = testDataPath
-	output, err := output.GetOutput(
+	reportData, err := output.GetData(
 		types.Report{
 			Path: detectorsReportPath,
 		},
@@ -154,7 +154,7 @@ func (runner *Runner) scanSingleFile(t *testing.T, testDataPath string, fileRela
 		t.Fatalf("failed to get output: %s", err)
 	}
 
-	report, err := util.ReportYAML(output.FindingsBySeverity)
+	report, err := util.ReportYAML(reportData.FindingsBySeverity)
 	if err != nil {
 		t.Fatalf("failed to encoded to yaml: %s", err)
 	}

diff --git a/pkg/commands/artifact/run.go b/pkg/commands/artifact/run.go
@@ -188,12 +188,12 @@ func (r *runner) Scan(ctx context.Context, opts flag.Options) ([]files.File, *ba
 
 		report := types.Report{Path: r.reportPath + ".base", Inputgocloc: r.goclocResult}
 
-		reportOutput, err := reportoutput.GetOutput(report, r.scanSettings, nil)
+		reportData, err := reportoutput.GetData(report, r.scanSettings, nil)
 		if err != nil {
 			return err
 		}
 
-		baseBranchFindings = buildBaseBranchFindings(reportOutput, fileList)
+		baseBranchFindings = buildBaseBranchFindings(reportData, fileList)
 
 		if !opts.Quiet {
 			outputhandler.StdErrLog("\nScanning current branch")
@@ -325,7 +325,7 @@ func (r *runner) Report(
 		outputhandler.StdErrLog("Using cached data")
 	}
 
-	output, err := reportoutput.GetOutput(report, r.scanSettings, baseBranchFindings)
+	reportData, err := reportoutput.GetData(report, r.scanSettings, baseBranchFindings)
 	if err != nil {
 		return false, err
 	}
@@ -339,7 +339,7 @@ func (r *runner) Report(
 
 	if !reportSupported && r.scanSettings.Report.Report != flag.ReportPrivacy {
 		var placeholderStr *strings.Builder
-		placeholderStr, err = getPlaceholderOutput(output, report, r.scanSettings, report.Inputgocloc)
+		placeholderStr, err = getPlaceholderOutput(reportData, report, r.scanSettings, report.Inputgocloc)
 		if err != nil {
 			return false, err
 		}
@@ -349,7 +349,7 @@ func (r *runner) Report(
 	}
 
 	formatStr, err := reportoutput.FormatOutput(
-		output,
+		reportData,
 		r.scanSettings,
 		report.Inputgocloc,
 		startTime,

diff --git a/pkg/report/output/output.go b/pkg/report/output/output.go
@@ -24,7 +24,7 @@ import (
 
 var ErrUndefinedFormat = errors.New("undefined output format")
 
-func GetOutput(
+func GetData(
 	report globaltypes.Report,
 	config settings.Config,
 	baseBranchFindings *basebranchfindings.Findings,

diff --git a/pkg/report/output/privacy/privacy_test.go b/pkg/report/output/privacy/privacy_test.go
@@ -30,7 +30,7 @@ func TestBuildCsvString(t *testing.T) {
 	cupaloy.SnapshotT(t, stringBuilder.String())
 }
 
-func TestGetOutput(t *testing.T) {
+func TestGetData(t *testing.T) {
 	config, err := generateConfig(flag.ReportOptions{Report: "privacy"})
 	config.Rules = map[string]*settings.Rule{
 		"ruby_third_parties_sentry": config.Rules["ruby_third_parties_sentry"],