Add scan id flag to risk management command (AST-000)

Author: cx-daniel-greenspan

internal/commands/result.go

@@ -234,13 +234,14 @@ func riskManagementSubCommand(riskManagement wrappers.RiskManagementWrapper, fea
 		Long:  "The risk-management command displays risk management results for a specific project in Checkmarx One",
 		Example: heredoc.Doc(
 			`
-			$ cx results risk-management --project-id <project Id> --limit <limit> (1-50, default: 50)
+			$ cx results risk-management --project-id <project Id> --scan-id <scan ID> --limit <limit> (1-50, default: 50)
 		`,
 		),
 		RunE: runRiskManagementCommand(riskManagement, featureFlagsWrapper),
 	}
 
 	riskManagementCmd.PersistentFlags().String(commonParams.ProjectIDFlag, "", "Project ID")
+	riskManagementCmd.PersistentFlags().String(commonParams.ScanIDFlag, "", "Scan ID")
 	riskManagementCmd.PersistentFlags().Int(commonParams.LimitFlag, -1, "Limit")
 
 	addFormatFlag(riskManagementCmd, printer.FormatJSON, printer.FormatTable, printer.FormatList)
@@ -355,14 +356,16 @@ func runRiskManagementCommand(riskManagement wrappers.RiskManagementWrapper, fea
 ) func(cmd *cobra.Command, args []string) error {
 	return func(cmd *cobra.Command, args []string) error {
 		projectID, _ := cmd.Flags().GetString(commonParams.ProjectIDFlag)
+		scanID, _ := cmd.Flags().GetString(commonParams.ScanIDFlag)
+
 		limit, _ := cmd.Flags().GetInt(commonParams.LimitFlag)
 
 		flagResponse, _ := wrappers.GetSpecificFeatureFlag(featureFlagsWrapper, wrappers.RiskManagementEnabled)
 		ASPMEnabled := flagResponse.Status
 		if !ASPMEnabled {
 			return errors.Errorf("%s", "Risk management results are currently unavailable for your tenant.")
 		}
-		results, err := getRiskManagementResults(riskManagement, projectID)
+		results, err := getRiskManagementResults(riskManagement, projectID, scanID)
 		if err != nil {
 			return err
 		}
@@ -372,8 +375,8 @@ func runRiskManagementCommand(riskManagement wrappers.RiskManagementWrapper, fea
 	}
 }
 
-func getRiskManagementResults(riskManagement wrappers.RiskManagementWrapper, projectID string) (*wrappers.ASPMResult, error) {
-	ASPMResult, errorModel, err := riskManagement.GetTopVulnerabilitiesByProjectID(projectID)
+func getRiskManagementResults(riskManagement wrappers.RiskManagementWrapper, projectID, scanID string) (*wrappers.ASPMResult, error) {
+	ASPMResult, errorModel, err := riskManagement.GetTopVulnerabilitiesByProjectID(projectID, scanID)
 	if err != nil {
 		return nil, errors.Wrapf(err, "%s", failedListingResults)
 	}

internal/wrappers/mock/risk-management-mock.go

@@ -6,14 +6,15 @@ import (
 
 type RiskManagementMockWrapper struct{}
 
-func (r *RiskManagementMockWrapper) GetTopVulnerabilitiesByProjectID(projectID string) (*wrappers.ASPMResult, *wrappers.WebError, error) {
+func (r *RiskManagementMockWrapper) GetTopVulnerabilitiesByProjectID(projectID string, scanID string) (*wrappers.ASPMResult, *wrappers.WebError, error) {
 	mockResults := []wrappers.RiskManagementResult{
-		{ID: "1", Name: "Vuln1", Severity: "High", Traits: map[string]string{wrappers.ExplPathKey: wrappers.ExplPathValue}},
+		{ID: "1", Name: "Vuln1", Severity: "High", Traits: map[string]string{wrappers.ExpPathKey: wrappers.ExpPathValue}},
 		{ID: "2", Name: "Vuln2", Severity: "Medium", Traits: map[string]string{wrappers.SuspMalwareKey: wrappers.SuspMalwareValue}},
 	}
 
 	mockASPMResult := &wrappers.ASPMResult{
 		ProjectID: projectID,
+		ScanID:    scanID,
 		Results:   mockResults,
 	}
 

internal/wrappers/risk-management-http.go

@@ -1,6 +1,7 @@
 package wrappers
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"net/http"
@@ -20,14 +21,14 @@ func NewHTTPRiskManagementWrapper(path string) RiskManagementWrapper {
 	}
 }
 
-func (r *RiskManagementHTTPWrapper) GetTopVulnerabilitiesByProjectID(projectID string) (
-	*ASPMResult,
-	*WebError,
-	error,
-) {
+func (r *RiskManagementHTTPWrapper) GetTopVulnerabilitiesByProjectID(projectID string, scanID string) (*ASPMResult, *WebError, error) {
 	clientTimeout := viper.GetUint(commonParams.ClientTimeoutKey)
+
+	model := GetASPMResultRequest{ScanId: scanID}
+	jsonBytes, err := json.Marshal(model)
+
 	path := fmt.Sprintf(r.path, projectID)
-	resp, err := SendHTTPRequest(http.MethodGet, path, http.NoBody, true, clientTimeout)
+	resp, err := SendHTTPRequest(http.MethodGet, path, bytes.NewBuffer(jsonBytes), true, clientTimeout)
 	if err != nil {
 		return nil, nil, err
 	}

internal/wrappers/risk-management.go

@@ -4,18 +4,22 @@ import "time"
 
 const (
 	SuspMalwareKey = "suspMalware"
-	ExplPathKey    = "explPath"
-	PubExposedKey  = "pubExposed"
-	RuntimeKey     = "runtime"
+	ExpPathKey     = "explPath"
+	//PubExposedKey  = "pubExposed"
+	//RuntimeKey     = "runtime"
 
 	SuspMalwareValue = "Suspected Malware"
-	ExplPathValue    = "Exploitable Path"
-	PubExposedValue  = "Public Exposed"
-	RuntimeValue     = "Runtime"
+	ExpPathValue     = "Exploitable Path"
+	//PubExposedValue  = "Public Exposed"
+	//RuntimeValue     = "Runtime"
 )
 
 type RiskManagementWrapper interface {
-	GetTopVulnerabilitiesByProjectID(projectID string) (*ASPMResult, *WebError, error)
+	GetTopVulnerabilitiesByProjectID(projectID string, scanID string) (*ASPMResult, *WebError, error)
+}
+
+type GetASPMResultRequest struct {
+	ScanId string `json:"scanID"`
 }
 
 type ApplicationScore struct {