Adding new fields to analytics finalize event report

commands/audit/audit.go

@@ -286,7 +286,7 @@ func RunJasScans(auditParallelRunner *utils.SecurityParallelRunner, auditParams
 		auditParams.minSeverityFilter,
 		jas.GetAnalyzerManagerXscEnvVars(
 			auditParams.GetMultiScanId(),
-			jas.GetGitRepoUrlKey(auditParams.resultsContext.GitRepoHttpsCloneUrl),
+			utils.GetGitRepoUrlKey(auditParams.resultsContext.GitRepoHttpsCloneUrl),
 			auditParams.resultsContext.ProjectKey,
 			auditParams.resultsContext.Watches,
 			scanResults.GetTechnologies()...,

jas/common.go

@@ -25,7 +25,6 @@ import (
 	"github.com/jfrog/jfrog-client-go/utils/log"
 	"github.com/jfrog/jfrog-client-go/xray"
 	"github.com/jfrog/jfrog-client-go/xray/services"
-	xscutils "github.com/jfrog/jfrog-client-go/xsc/services/utils"
 	"github.com/owenrumney/go-sarif/v2/sarif"
 	"github.com/stretchr/testify/assert"
 	"golang.org/x/exp/slices"
@@ -374,14 +373,6 @@ func CheckForSecretValidation(xrayManager *xray.XrayServicesManager, xrayVersion
 	return err == nil && isEnabled
 }
 
-// Analyzer Manager expect the git repo url to be in the env vars in a specific way, this function will return the key for the git repo url
-func GetGitRepoUrlKey(gitRepoHttpsCloneUrl string) string {
-	if gitRepoHttpsCloneUrl == "" {
-		return ""
-	}
-	return xscutils.GetGitRepoUrlKey(gitRepoHttpsCloneUrl)
-}
-
 func GetAnalyzerManagerXscEnvVars(msi string, gitRepoUrl, projectKey string, watches []string, technologies ...techutils.Technology) map[string]string {
 	envVars := map[string]string{utils.JfMsiEnvVariable: msi}
 	if gitRepoUrl != "" {

utils/utils.go

@@ -6,6 +6,7 @@ import (
 	"encoding/hex"
 	"encoding/json"
 	"fmt"
+	xscutils "github.com/jfrog/jfrog-client-go/xsc/services/utils"
 	orderedJson "github.com/virtuald/go-ordered-json"
 	"os"
 	"path/filepath"
@@ -279,3 +280,11 @@ func DumpContentToFile(fileContent []byte, scanResultsOutputDir string, scanType
 	}
 	return
 }
+
+// Returns the key for the git reop Url, as expected by the Analyzer Manager and the Analytics event report
+func GetGitRepoUrlKey(gitRepoHttpsCloneUrl string) string {
+	if gitRepoHttpsCloneUrl == "" {
+		return ""
+	}
+	return xscutils.GetGitRepoUrlKey(gitRepoHttpsCloneUrl)
+}

utils/xsc/analyticsmetrics.go

@@ -2,6 +2,7 @@ package xsc
 
 import (
 	"fmt"
+	"github.com/jfrog/jfrog-cli-security/utils"
 	"strings"
 	"time"
 
@@ -51,7 +52,7 @@ func SendNewScanEvent(xrayVersion, xscVersion string, serviceDetails *config.Ser
 	return
 }
 
-func SendScanEndedEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, multiScanId string, startTime time.Time, totalFindings int, scanError error) {
+func SendScanEndedEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, multiScanId string, startTime time.Time, totalFindings int, resultsContext *results.ResultContext, scanError error) {
 	if !shouldReportEvents(xscVersion) {
 		return
 	}
@@ -66,7 +67,7 @@ func SendScanEndedEvent(xrayVersion, xscVersion string, serviceDetails *config.S
 		return
 	}
 
-	event := CreateFinalizedEvent(multiScanId, startTime, totalFindings, scanError)
+	event := CreateFinalizedEvent(multiScanId, startTime, totalFindings, resultsContext, scanError)
 
 	if err = xscService.UpdateAnalyticsGeneralEvent(event); err != nil {
 		log.Debug(fmt.Sprintf("failed updating general event in XSC service for multi_scan_id %s, error: %s \"", multiScanId, err.Error()))
@@ -86,18 +87,26 @@ func SendScanEndedWithResults(serviceDetails *config.ServerDetails, cmdResults *
 		cmdResults.MultiScanId,
 		cmdResults.StartTime,
 		getTotalFindings(cmdResults),
+		&cmdResults.ResultContext,
 		cmdResults.GetErrors(),
 	)
 }
 
-func CreateFinalizedEvent(multiScanId string, startTime time.Time, totalFindings int, err error) xscservices.XscAnalyticsGeneralEventFinalize {
+func CreateFinalizedEvent(multiScanId string, startTime time.Time, totalFindings int, resultsContext *results.ResultContext, err error) xscservices.XscAnalyticsGeneralEventFinalize {
 	totalDuration := time.Since(startTime)
 	eventStatus := xscservices.Completed
 	if err != nil {
 		eventStatus = xscservices.Failed
 	}
+
+	var gitRepoUrlKey string
+	if resultsContext != nil {
+		gitRepoUrlKey = utils.GetGitRepoUrlKey(resultsContext.GitRepoHttpsCloneUrl)
+	}
+
 	return xscservices.XscAnalyticsGeneralEventFinalize{
 		MultiScanId: multiScanId,
+		GitRepoUrl:  gitRepoUrlKey,
 		XscAnalyticsBasicGeneralEvent: xscservices.XscAnalyticsBasicGeneralEvent{
 			EventStatus:       eventStatus,
 			TotalFindings:     totalFindings,
@@ -107,7 +116,7 @@ func CreateFinalizedEvent(multiScanId string, startTime time.Time, totalFindings
 }
 
 func createFinalizedEvent(cmdResults *results.SecurityCommandResults) xscservices.XscAnalyticsGeneralEventFinalize {
-	return CreateFinalizedEvent(cmdResults.MultiScanId, cmdResults.StartTime, getTotalFindings(cmdResults), cmdResults.GetErrors())
+	return CreateFinalizedEvent(cmdResults.MultiScanId, cmdResults.StartTime, getTotalFindings(cmdResults), &cmdResults.ResultContext, cmdResults.GetErrors())
 }
 
 func GetScanEvent(xrayVersion, xscVersion, multiScanId string, serviceDetails *config.ServerDetails) (*xscservices.XscAnalyticsGeneralEvent, error) {

utils/xsc/analyticsmetrics_test.go

@@ -145,27 +145,43 @@ func TestCreateFinalizedEvent(t *testing.T) {
 	testCases := []struct {
 		name         string
 		auditResults *results.SecurityCommandResults
-		expected     xscservices.XscAnalyticsBasicGeneralEvent
+		expected     xscservices.XscAnalyticsGeneralEventFinalize
 	}{
 		{
 			name:         "No audit results",
 			auditResults: &results.SecurityCommandResults{MultiScanId: "msi", StartTime: time},
-			expected:     xscservices.XscAnalyticsBasicGeneralEvent{EventStatus: xscservices.Completed},
+			expected: xscservices.XscAnalyticsGeneralEventFinalize{
+				XscAnalyticsBasicGeneralEvent: xscservices.XscAnalyticsBasicGeneralEvent{EventStatus: xscservices.Completed},
+			},
 		},
 		{
 			name:         "Valid audit result",
-			auditResults: getDummyContentForGeneralEvent(true, false),
-			expected:     xscservices.XscAnalyticsBasicGeneralEvent{TotalFindings: 7, EventStatus: xscservices.Completed},
+			auditResults: getDummyContentForGeneralEvent(true, false, false),
+			expected: xscservices.XscAnalyticsGeneralEventFinalize{
+				XscAnalyticsBasicGeneralEvent: xscservices.XscAnalyticsBasicGeneralEvent{TotalFindings: 7, EventStatus: xscservices.Completed},
+			},
+		},
+		{
+			name:         "Scan failed with findings",
+			auditResults: getDummyContentForGeneralEvent(false, true, false),
+			expected: xscservices.XscAnalyticsGeneralEventFinalize{
+				XscAnalyticsBasicGeneralEvent: xscservices.XscAnalyticsBasicGeneralEvent{TotalFindings: 1, EventStatus: xscservices.Failed},
+			},
 		},
 		{
-			name:         "Scan failed with findings.",
-			auditResults: getDummyContentForGeneralEvent(false, true),
-			expected:     xscservices.XscAnalyticsBasicGeneralEvent{TotalFindings: 1, EventStatus: xscservices.Failed},
+			name:         "Valid audit results with Watches and GitRepoUrl",
+			auditResults: getDummyContentForGeneralEvent(false, false, true),
+			expected: xscservices.XscAnalyticsGeneralEventFinalize{
+				XscAnalyticsBasicGeneralEvent: xscservices.XscAnalyticsBasicGeneralEvent{TotalFindings: 1, EventStatus: xscservices.Completed},
+				GitRepoUrl:                    "github.com/my-user/my-repo.git",
+			},
 		},
 		{
 			name:         "Scan failed no findings.",
 			auditResults: &results.SecurityCommandResults{MultiScanId: "msi", StartTime: time, Targets: []*results.TargetResults{{Errors: []error{errors.New("an error")}}}},
-			expected:     xscservices.XscAnalyticsBasicGeneralEvent{TotalFindings: 0, EventStatus: xscservices.Failed},
+			expected: xscservices.XscAnalyticsGeneralEventFinalize{
+				XscAnalyticsBasicGeneralEvent: xscservices.XscAnalyticsBasicGeneralEvent{TotalFindings: 0, EventStatus: xscservices.Failed},
+			},
 		},
 	}
 
@@ -174,6 +190,7 @@ func TestCreateFinalizedEvent(t *testing.T) {
 			event := createFinalizedEvent(testCase.auditResults)
 			assert.Equal(t, testCase.expected.TotalFindings, event.TotalFindings)
 			assert.Equal(t, testCase.expected.EventStatus, event.EventStatus)
+			assert.Equal(t, testCase.expected.GitRepoUrl, event.GitRepoUrl)
 			assert.Equal(t, testCase.auditResults.MultiScanId, event.MultiScanId)
 			assert.NotEmpty(t, event.TotalScanDuration)
 		})
@@ -183,7 +200,7 @@ func TestCreateFinalizedEvent(t *testing.T) {
 // Create a dummy content for general event. 1 SCA scan with 1 vulnerability
 // withJas - Add 2 JAS results for each scan type.
 // withErr - Add an error to the results.
-func getDummyContentForGeneralEvent(withJas, withErr bool) *results.SecurityCommandResults {
+func getDummyContentForGeneralEvent(withJas, withErr, withResultContext bool) *results.SecurityCommandResults {
 	vulnerabilities := []services.Vulnerability{{IssueId: "XRAY-ID", Severity: "medium", Cves: []services.Cve{{Id: "CVE-123"}}, Components: map[string]services.Component{"issueId_2_direct_dependency": {}}}}
 
 	cmdResults := results.NewCommandResults(utils.SourceCode).SetEntitledForJas(true).SetSecretValidation(true)
@@ -213,5 +230,11 @@ func getDummyContentForGeneralEvent(withJas, withErr bool) *results.SecurityComm
 		scanResults.Errors = []error{errors.New("an error")}
 	}
 
+	if withResultContext {
+		cmdResults.SetResultsContext(results.ResultContext{
+			GitRepoHttpsCloneUrl: "https://github.com/my-user/my-repo",
+		})
+	}
+
 	return cmdResults
 }

xsc_test.go

@@ -209,7 +209,7 @@ func getAuditCommandWithXscGitContext(gitInfoContext xscservices.XscGitInfoConte
 				auditCmd.SetGitRepoHttpsCloneUrl(gitInfoContext.GitRepoHttpsCloneUrl)
 				err = progressbar.ExecWithProgress(auditCmd)
 				// Send the final event to the platform.
-				xsc.SendScanEndedEvent(xrayVersion, xscVersion, serverDetails, multiScanId, startTime, 0, err)
+				xsc.SendScanEndedEvent(xrayVersion, xscVersion, serverDetails, multiScanId, startTime, 0, nil, err)
 				return err
 			},
 		}