fix: add project and snapshot as resultmetadata

Co-authored-by: PeterSchafer <[email protected]>

Author: dotkas

internal/analysis/analysis.go

@@ -344,9 +344,19 @@ func (a *analysisOrchestrator) retrieveTestURL(ctx context.Context, client *test
 			result := &scan.ResultMetaData{
 				FindingsUrl: findingsUrl,
 			}
-			if testCompleted.Results.Webui != nil && testCompleted.Results.Webui.Link != nil {
-				result.WebUiUrl = *testCompleted.Results.Webui.Link
+
+			if testCompleted.Results.Webui != nil {
+				if testCompleted.Results.Webui.Link != nil {
+					result.WebUiUrl = *testCompleted.Results.Webui.Link
+				}
+				if testCompleted.Results.Webui.ProjectId != nil {
+					result.ProjectId = testCompleted.Results.Webui.ProjectId.String()
+				}
+				if testCompleted.Results.Webui.SnapshotId != nil {
+					result.SnapshotId = testCompleted.Results.Webui.SnapshotId.String()
+				}
 			}
+
 			return result, true, nil
 		default:
 			return nil, false, fmt.Errorf("unexpected test status \"%s\"", stateDiscriminator)

internal/analysis/analysis_test.go

@@ -68,13 +68,14 @@ func mockGetDocumentResponse(t *testing.T, sarifResponse sarif.SarifDocument, ex
 	}, mockDeriveErrorFromStatusCode(responseCode))
 }
 
-func mockResultCompletedResponse(t *testing.T, mockHTTPClient *httpmocks.MockHTTPClient, expectedWebuilink string, projectId uuid.UUID, orgId string, testId uuid.UUID, documentPath string, responseCode int) {
+func mockResultCompletedResponse(t *testing.T, mockHTTPClient *httpmocks.MockHTTPClient, expectedWebuilink string, projectId uuid.UUID, snapshotId uuid.UUID, orgId string, testId uuid.UUID, documentPath string, responseCode int) {
 	t.Helper()
 	response := v20241221.NewTestResponse()
 	state := v20241221.NewTestCompleteState()
 	state.Documents.EnrichedSarif = documentPath
 	state.Results.Webui.Link = &expectedWebuilink
 	state.Results.Webui.ProjectId = &projectId
+	state.Results.Webui.SnapshotId = &snapshotId
 	stateBytes, err := json.Marshal(state)
 	assert.NoError(t, err)
 	response.Data.Attributes.UnmarshalJSON(stateBytes)
@@ -150,6 +151,7 @@ func TestAnalysis_RunTest(t *testing.T) {
 
 	orgId := "4a72d1db-b465-4764-99e1-ecedad03b06a"
 	projectId := uuid.New()
+	snapshotId := uuid.New()
 	testId := uuid.New()
 	report := true
 	inputBundle := mocks2.NewMockBundle(ctrl)
@@ -165,7 +167,7 @@ func TestAnalysis_RunTest(t *testing.T) {
 	// Get Test Result Response
 	expectedWebuilink := ""
 	expectedDocumentPath := "/1234"
-	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, orgId, testId, expectedDocumentPath, http.StatusOK)
+	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, snapshotId, orgId, testId, expectedDocumentPath, http.StatusOK)
 
 	// get document
 	sarifResponse := sarif.SarifDocument{
@@ -197,6 +199,8 @@ func TestAnalysis_RunTest(t *testing.T) {
 	assert.NotNil(t, result)
 	assert.NotNil(t, resultMetadata)
 	assert.Equal(t, expectedWebuilink, resultMetadata.WebUiUrl)
+	assert.Equal(t, projectId.String(), resultMetadata.ProjectId)
+	assert.Equal(t, snapshotId.String(), resultMetadata.SnapshotId)
 	assert.Equal(t, sarifResponse.Version, result.Sarif.Version)
 }
 
@@ -207,6 +211,7 @@ func TestAnalysis_RunTestRemote(t *testing.T) {
 
 	orgId := "4a72d1db-b465-4764-99e1-ecedad03b06a"
 	projectId := uuid.New()
+	snapshotId := uuid.New()
 	testId := uuid.New()
 	commitId := "abc123"
 	report := true
@@ -217,7 +222,7 @@ func TestAnalysis_RunTestRemote(t *testing.T) {
 	// Get Test Result Response
 	expectedWebuilink := ""
 	expectedDocumentPath := "/1234"
-	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, orgId, testId, expectedDocumentPath, http.StatusOK)
+	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, snapshotId, orgId, testId, expectedDocumentPath, http.StatusOK)
 
 	// get document
 	sarifResponse := sarif.SarifDocument{
@@ -249,6 +254,8 @@ func TestAnalysis_RunTestRemote(t *testing.T) {
 	assert.NotNil(t, result)
 	assert.NotNil(t, resultMetadata)
 	assert.Equal(t, expectedWebuilink, resultMetadata.WebUiUrl)
+	assert.Equal(t, projectId.String(), resultMetadata.ProjectId)
+	assert.Equal(t, snapshotId.String(), resultMetadata.SnapshotId)
 	assert.Equal(t, sarifResponse.Version, result.Sarif.Version)
 }
 
@@ -308,7 +315,7 @@ func TestAnalysis_RunTestRemote_PollingFailed(t *testing.T) {
 	// Get Test Result Response
 	expectedWebuilink := ""
 	expectedDocumentPath := "/1234"
-	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, orgId, testId, expectedDocumentPath, http.StatusInternalServerError)
+	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, uuid.New(), orgId, testId, expectedDocumentPath, http.StatusInternalServerError)
 
 	analysisOrchestrator := analysis.NewAnalysisOrchestrator(
 		mockConfig,
@@ -352,7 +359,7 @@ func TestAnalysis_RunTestRemote_GetDocumentFailed(t *testing.T) {
 	// Get Test Result Response
 	expectedWebuilink := ""
 	expectedDocumentPath := "/1234"
-	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, orgId, testId, expectedDocumentPath, http.StatusOK)
+	mockResultCompletedResponse(t, mockHTTPClient, expectedWebuilink, projectId, uuid.New(), orgId, testId, expectedDocumentPath, http.StatusOK)
 
 	// get document
 	sarifResponse := sarif.SarifDocument{

sarif/sarif_types.go

@@ -179,6 +179,11 @@ type RunProperties struct {
 		Lang        string `json:"lang"`
 		Type        string `json:"type"`
 	} `json:"coverage"`
+	UploadResult struct {
+		ProjectId  string `json:"projectId"`
+		SnapshotId string `json:"snapshotId"`
+		ReportUrl  string `json:"reportUrl"`
+	} `json:"uploadResult,omitempty"`
 }
 
 type Run struct {

scan/scan_metadata.go

@@ -5,6 +5,8 @@ import "context"
 type ResultMetaData struct {
 	FindingsUrl string
 	WebUiUrl    string
+	ProjectId   string
+	SnapshotId  string
 }
 
 type ScanSource string