chore: update func options for analyze functions

Author: PeterSchafer

internal/analysis/analysis.go

@@ -52,12 +52,12 @@ type AnalysisOrchestrator interface {
 	RunAnalysis(ctx context.Context, orgId string, rootPath string, workspaceId string) (*sarif.SarifResponse, error)
 	RunIncrementalAnalysis(ctx context.Context, orgId string, rootPath string, workspaceId string, limitToFiles []string) (*sarif.SarifResponse, error)
 
-	RunTest(ctx context.Context, orgId string, b bundle.Bundle, target scan.Target, reportingOptions ReportingConfig) (*sarif.SarifResponse, error)
-	RunTestRemote(ctx context.Context, orgId string, interactionId string, reportingOptions ReportingConfig) (*sarif.SarifResponse, error)
+	RunTest(ctx context.Context, orgId string, b bundle.Bundle, target scan.Target, reportingOptions AnalysisConfig) (*sarif.SarifResponse, error)
+	RunTestRemote(ctx context.Context, orgId string, interactionId string, reportingOptions AnalysisConfig) (*sarif.SarifResponse, error)
 }
 
-type ReportingConfig struct {
-	Report      *bool
+type AnalysisConfig struct {
+	Report      bool
 	ProjectName *string
 	TargetName  *string
 	ProjectId   *uuid.UUID
@@ -485,7 +485,7 @@ func (a *analysisOrchestrator) host(isHidden bool) string {
 	return fmt.Sprintf("%s/%s", apiUrl, path)
 }
 
-func (a *analysisOrchestrator) RunTest(ctx context.Context, orgId string, b bundle.Bundle, target scan.Target, reportingConfig ReportingConfig) (*sarif.SarifResponse, error) {
+func (a *analysisOrchestrator) RunTest(ctx context.Context, orgId string, b bundle.Bundle, target scan.Target, reportingConfig AnalysisConfig) (*sarif.SarifResponse, error) {
 	tracker := a.trackerFactory.GenerateTracker()
 	tracker.Begin("Snyk Code analysis for "+target.GetPath(), "Retrieving results...")
 
@@ -508,7 +508,7 @@ func (a *analysisOrchestrator) RunTest(ctx context.Context, orgId string, b bund
 		testApi.WithScanType(a.testType),
 		testApi.WithProjectName(reportingConfig.ProjectName),
 		testApi.WithTargetName(reportingConfig.TargetName),
-		testApi.WithReporting(reportingConfig.Report),
+		testApi.WithReporting(&reportingConfig.Report),
 	)
 
 	// create test
@@ -540,7 +540,7 @@ func (a *analysisOrchestrator) RunTest(ctx context.Context, orgId string, b bund
 	}
 }
 
-func (a *analysisOrchestrator) RunTestRemote(ctx context.Context, orgId string, interactionId string, cfg ReportingConfig) (*sarif.SarifResponse, error) {
+func (a *analysisOrchestrator) RunTestRemote(ctx context.Context, orgId string, interactionId string, cfg AnalysisConfig) (*sarif.SarifResponse, error) {
 	tracker := a.trackerFactory.GenerateTracker()
 	tracker.Begin("Snyk Code analysis for remote project", "Retrieving results...")
 
@@ -562,10 +562,9 @@ func (a *analysisOrchestrator) RunTestRemote(ctx context.Context, orgId string,
 	legacyScmProject := testApi.NewTestInputLegacyScmProject(*projectId, *commitId)
 	body := testApi.NewCreateTestApplicationBody(
 		testApi.WithInputLegacyScmProject(legacyScmProject),
-		testApi.WithReporting(cfg.Report),
+		testApi.WithReporting(&cfg.Report),
 		testApi.WithScanType(a.testType),
 		testApi.WithProjectId(*projectId),
-
 	)
 	// create test
 	bodyBytes, err := json.Marshal(body)

internal/analysis/analysis_test.go

@@ -784,10 +784,10 @@ func TestAnalysis_RunTestRemote(t *testing.T) {
 		context.Background(),
 		"4a72d1db-b465-4764-99e1-ecedad03b06a",
 		"b372d1db-b465-4764-99e1-ecedad03b06a",
-		analysis.ReportingConfig{
+		analysis.AnalysisConfig{
 			ProjectId: &projectId,
 			CommitId:  &commitId,
-			Report:    &report,
+			Report:    report,
 		},
 	)
 
@@ -816,7 +816,7 @@ func TestAnalysis_RunTestRemote_MissingRequiredParams(t *testing.T) {
 			context.Background(),
 			"4a72d1db-b465-4764-99e1-ecedad03b06a",
 			"b372d1db-b465-4764-99e1-ecedad03b06a",
-			analysis.ReportingConfig{},
+			analysis.AnalysisConfig{},
 		)
 
 		assert.Error(t, err)
@@ -830,7 +830,7 @@ func TestAnalysis_RunTestRemote_MissingRequiredParams(t *testing.T) {
 			context.Background(),
 			"4a72d1db-b465-4764-99e1-ecedad03b06a",
 			"b372d1db-b465-4764-99e1-ecedad03b06a",
-			analysis.ReportingConfig{
+			analysis.AnalysisConfig{
 				CommitId: &commitId,
 			},
 		)
@@ -846,7 +846,7 @@ func TestAnalysis_RunTestRemote_MissingRequiredParams(t *testing.T) {
 			context.Background(),
 			"4a72d1db-b465-4764-99e1-ecedad03b06a",
 			"b372d1db-b465-4764-99e1-ecedad03b06a",
-			analysis.ReportingConfig{
+			analysis.AnalysisConfig{
 				ProjectId: &projectId,
 			},
 		)

internal/analysis/mocks/analysis.go

@@ -54,7 +54,7 @@ type CodeScanner interface {
 		target scan.Target,
 		files <-chan string,
 		changedFiles map[string]bool,
-		options ...ReportingOption,
+		options ...AnalysisOption,
 	) (*sarif.SarifResponse, string, error)
 }
 
@@ -97,23 +97,21 @@ func WithTrackerFactory(trackerFactory scan.TrackerFactory) OptionFunc {
 	}
 }
 
-type ReportingOption func(*analysis.ReportingConfig)
+type AnalysisOption func(*analysis.AnalysisConfig)
 
-func WithReportingConfig(report bool, config map[string]interface{}) ReportingOption {
-	return func(c *analysis.ReportingConfig) {
-		c.Report = &report
-		if projectName, ok := config["projectName"].(*string); ok {
-			c.ProjectName = projectName
-		}
-		if targetName, ok := config["targetName"].(*string); ok {
-			c.TargetName = targetName
-		}
-		if projectId, ok := config["projectId"].(*uuid.UUID); ok {
-			c.ProjectId = projectId
-		}
-		if commitId, ok := config["commitId"].(*string); ok {
-			c.CommitId = commitId
-		}
+func ReportLocalTest(projectName string, targetName string) AnalysisOption {
+	return func(c *analysis.AnalysisConfig) {
+		c.Report = true
+		c.ProjectName = &projectName
+		c.TargetName = &targetName
+	}
+}
+
+func ReportRemoteTest(projectId uuid.UUID, commitId string) AnalysisOption {
+	return func(c *analysis.AnalysisConfig) {
+		c.Report = true
+		c.ProjectId = &projectId
+		c.CommitId = &commitId
 	}
 }
 
@@ -191,9 +189,9 @@ func (c *codeScanner) UploadAndAnalyze(
 	target scan.Target,
 	files <-chan string,
 	changedFiles map[string]bool,
-	options ...ReportingOption,
+	options ...AnalysisOption,
 ) (*sarif.SarifResponse, string, error) {
-	cfg := analysis.ReportingConfig{}
+	cfg := analysis.AnalysisConfig{}
 	for _, opt := range options {
 		opt(&cfg)
 	}
@@ -247,8 +245,8 @@ func (c *codeScanner) UploadAndAnalyze(
 	return response, bundleHash, err
 }
 
-func (c *codeScanner) AnalyzeRemote(ctx context.Context, interactionId string, options ...ReportingOption) (*sarif.SarifResponse, error) {
-	cfg := analysis.ReportingConfig{}
+func (c *codeScanner) AnalyzeRemote(ctx context.Context, interactionId string, options ...AnalysisOption) (*sarif.SarifResponse, error) {
+	cfg := analysis.AnalysisConfig{}
 	for _, opt := range options {
 		opt(&cfg)
 	}