chore: fix breaking changes from api version update

Author: j-luong

.gitignore

@@ -53,4 +53,5 @@ scripts/__pycache__/
 internal/workspace/**/**/*.yaml
 !internal/workspace/**/**/*.config.yaml
 internal/orchestration/**/**/*.yaml
-!internal/orchestration/**/**/*.config.yaml
+!internal/orchestration/**/**/*.config.yaml
+.cursor

internal/analysis/analysis.go

@@ -66,7 +66,7 @@ type analysisOrchestrator struct {
 	logger         *zerolog.Logger
 	trackerFactory scan.TrackerFactory
 	config         config.Config
-	testType       testModels.Scan
+	testType       testModels.ResultType
 }
 
 var _ AnalysisOrchestrator = (*analysisOrchestrator)(nil)
@@ -97,7 +97,7 @@ func WithTrackerFactory(factory scan.TrackerFactory) func(*analysisOrchestrator)
 	}
 }
 
-func WithResultType(t testModels.Scan) func(*analysisOrchestrator) {
+func WithResultType(t testModels.ResultType) func(*analysisOrchestrator) {
 	return func(a *analysisOrchestrator) {
 		a.testType = t
 	}
@@ -237,8 +237,9 @@ func (a *analysisOrchestrator) RunTest(ctx context.Context, orgId string, b bund
 		repoUrl = &tmp
 	}
 
+	commitId := target.GetCommitId()
 	body := testApi.NewCreateTestApplicationBody(
-		testApi.WithInputBundle(b.GetBundleHash(), target.GetPath(), repoUrl, b.GetLimitToFiles()),
+		testApi.WithInputBundle(b.GetBundleHash(), target.GetPath(), repoUrl, b.GetLimitToFiles(), &commitId),
 		testApi.WithScanType(a.testType),
 		testApi.WithProjectName(reportingConfig.ProjectName),
 		testApi.WithTargetName(reportingConfig.TargetName),
@@ -300,11 +301,11 @@ func (a *analysisOrchestrator) retrieveTestURL(ctx context.Context, client *test
 	logger := a.logger.With().Str("method", method).Logger()
 	logger.Debug().Msg("retrieving Test URL")
 
-	httpResponse, err := client.GetTestResult(
+	httpResponse, err := client.GetComponents(
 		ctx,
 		org,
 		testId,
-		&testApi.GetTestResultParams{Version: testApi.ApiVersion},
+		&testApi.GetComponentsParams{Version: testApi.ApiVersion},
 	)
 	if err != nil {
 		logger.Err(err).Str("testId", testId.String()).Msg("error requesting the ScanJobResult")
@@ -317,50 +318,50 @@ func (a *analysisOrchestrator) retrieveTestURL(ctx context.Context, client *test
 		}
 	}()
 
-	parsedResponse, err := testApi.ParseGetTestResultResponse(httpResponse)
+	parsedResponse, err := testApi.ParseGetComponentsResponse(httpResponse)
 	if err != nil {
 		return nil, false, err
 	}
 
 	switch parsedResponse.StatusCode() {
 	case 200:
-		stateDiscriminator, stateError := parsedResponse.ApplicationvndApiJSON200.Data.Attributes.Discriminator()
-		if stateError != nil {
-			return nil, false, stateError
+		data := parsedResponse.ApplicationvndApiJSON200.Data
+		var sastComponent *testModels.GetComponentsResponseItem
+		for _, component := range data {
+			if component.Attributes.Type == "sast" {
+				a.logger.Debug().Msgf("inner component: %+v", component)
+				sastComponent = &component
+				break
+			}
 		}
-
-		switch stateDiscriminator {
-		case string(testModels.TestAcceptedStateStatusAccepted):
-			fallthrough
-		case string(testModels.TestInProgressStateStatusInProgress):
+		if sastComponent == nil {
+			a.logger.Debug().Msg("no sast component found")
 			return nil, false, nil
-		case string(testModels.TestCompletedStateStatusCompleted):
-			testCompleted, stateCompleteError := parsedResponse.ApplicationvndApiJSON200.Data.Attributes.AsTestCompletedState()
-			if stateCompleteError != nil {
-				return nil, false, stateCompleteError
-			}
+		}
 
-			findingsUrl := a.host(true) + testCompleted.Documents.EnrichedSarif + "?version=" + testApi.DocumentApiVersion
-			result := &scan.ResultMetaData{
-				FindingsUrl: findingsUrl,
-			}
+		result := &scan.ResultMetaData{}
+		attributes := sastComponent.Attributes
+
+		if attributes.FindingsDocumentType != nil && *attributes.FindingsDocumentType == testModels.Sarif {
+			// TODO: adjustedUrl is a workaround for the fact that a breaking change was introduced to the findings document path
+			// see https://github.com/snyk/test-service/pull/683
+			adjustedUrl := strings.Split(*attributes.FindingsDocumentPath, "v2")[0]
+			findingsUrl := a.host(true) + adjustedUrl + "documents/enriched-findings/blob?version=" + testApi.DocumentApiVersion
+			result.FindingsUrl = findingsUrl
 
-			if testCompleted.Results.Webui != nil {
-				if testCompleted.Results.Webui.Link != nil {
-					result.WebUiUrl = *testCompleted.Results.Webui.Link
+			if attributes.Webui != nil {
+				if attributes.Webui.Link != nil {
+					result.WebUiUrl = *attributes.Webui.Link
 				}
-				if testCompleted.Results.Webui.ProjectId != nil {
-					result.ProjectId = testCompleted.Results.Webui.ProjectId.String()
+				if attributes.Webui.ProjectId != nil {
+					result.ProjectId = attributes.Webui.ProjectId.String()
 				}
-				if testCompleted.Results.Webui.SnapshotId != nil {
-					result.SnapshotId = testCompleted.Results.Webui.SnapshotId.String()
+				if attributes.Webui.SnapshotId != nil {
+					result.SnapshotId = attributes.Webui.SnapshotId.String()
 				}
 			}
-
-			return result, true, nil
-		default:
-			return nil, false, fmt.Errorf("unexpected test status \"%s\"", stateDiscriminator)
 		}
+		return result, true, nil
 	default:
 		return nil, false, fmt.Errorf("unexpected response status \"%d\"", parsedResponse.StatusCode())
 	}

internal/analysis/analysis_test.go

@@ -37,6 +37,7 @@ import (
 	httpmocks "github.com/snyk/code-client-go/http/mocks"
 	"github.com/snyk/code-client-go/internal/analysis"
 	v20250407 "github.com/snyk/code-client-go/internal/api/test/2025-04-07"
+	v20250407Models "github.com/snyk/code-client-go/internal/api/test/2025-04-07/models"
 	"github.com/snyk/code-client-go/observability/mocks"
 	"github.com/snyk/code-client-go/sarif"
 	"github.com/snyk/code-client-go/scan"
@@ -70,18 +71,20 @@ func mockGetDocumentResponse(t *testing.T, sarifResponse sarif.SarifDocument, ex
 
 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 := v20250407.NewTestResponse()
-	state := v20250407.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)
-	responseBodyBytes, err := json.Marshal(response)
+	state := v20250407.NewGetComponentsState()
+	state.Data[0].Attributes.Type = "sast"
+	state.Data[0].Attributes.FindingsDocumentPath = &documentPath
+	findingsDocumentType := v20250407Models.Sarif
+	state.Data[0].Attributes.FindingsDocumentType = &findingsDocumentType
+	state.Data[0].Attributes.Success = true
+	state.Data[0].Attributes.Webui = &v20250407Models.WebUI{
+		Link:       &expectedWebuilink,
+		ProjectId:  &projectId,
+		SnapshotId: &snapshotId,
+	}
+	responseBodyBytes, err := json.Marshal(state)
 	assert.NoError(t, err)
-	expectedRetrieveTestUrl := fmt.Sprintf("http://localhost/hidden/orgs/%s/tests/%s?version=%s", orgId, testId, v20250407.ApiVersion)
+	expectedRetrieveTestUrl := fmt.Sprintf("http://localhost/hidden/orgs/%s/tests/%s/components?version=%s", orgId, testId, v20250407.ApiVersion)
 	mockHTTPClient.EXPECT().Do(mock.MatchedBy(func(i interface{}) bool {
 		req := i.(*http.Request)
 		return req.URL.String() == expectedRetrieveTestUrl

internal/api/test/2025-04-07/helper.go

@@ -0,0 +1,153 @@
+package v20250407
+
+import (
+	openapi_types "github.com/oapi-codegen/runtime/types"
+
+	externalRef0 "github.com/snyk/code-client-go/internal/api/test/2025-04-07/common"
+	v20250407 "github.com/snyk/code-client-go/internal/api/test/2025-04-07/models"
+)
+
+const ApiVersion = "2025-04-07"
+const DocumentApiVersion = "2024-10-15~experimental"
+
+type CreateTestOption func(*CreateTestApplicationVndAPIPlusJSONRequestBody)
+
+func WithInputBundle(id string, localFilePath string, repoUrl *string, limitTestToFiles []string, commitId *string) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		bundleInput := v20250407.TestInputSourceBundle{
+			BundleId: id,
+			Type:     v20250407.SourceBundle,
+			Metadata: struct {
+				CommitId         *string   `json:"commit_id,omitempty"`
+				LimitTestToFiles *[]string `json:"limit_test_to_files,omitempty"`
+				LocalFilePath    string    `json:"local_file_path"`
+				RepoUrl          *string   `json:"repo_url,omitempty"`
+			}{LocalFilePath: localFilePath, RepoUrl: repoUrl, CommitId: commitId},
+		}
+
+		if len(limitTestToFiles) > 0 {
+			bundleInput.Metadata.LimitTestToFiles = &limitTestToFiles
+		}
+
+		body.Data.Attributes.Input.FromTestInputSourceBundle(bundleInput)
+	}
+}
+
+func WithInputLegacyScmProject(project v20250407.TestInputLegacyScmProject) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		body.Data.Attributes.Input.FromTestInputLegacyScmProject(project)
+	}
+}
+
+func WithScanType(t v20250407.ResultType) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		body.Data.Attributes.Configuration.Scan = &v20250407.ScanConfig{
+			ResultType: &t,
+		}
+	}
+}
+
+func ensureOutput(body *CreateTestApplicationVndAPIPlusJSONRequestBody) *v20250407.OutputConfig {
+	if body.Data.Attributes.Configuration.Output == nil {
+		body.Data.Attributes.Configuration.Output = &v20250407.OutputConfig{}
+	}
+	return body.Data.Attributes.Configuration.Output
+}
+
+func WithProjectName(name *string) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		if name == nil {
+			return
+		}
+		out := ensureOutput(body)
+		out.ProjectName = name
+	}
+}
+
+func WithProjectId(id openapi_types.UUID) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		out := ensureOutput(body)
+		out.ProjectId = &id
+	}
+}
+
+func WithTargetName(name *string) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		if name == nil || len(*name) == 0 {
+			return
+		}
+		out := ensureOutput(body)
+		out.TargetName = name
+	}
+}
+
+func WithTargetReference(targetRef *string) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		if targetRef == nil || len(*targetRef) == 0 {
+			return
+		}
+		out := ensureOutput(body)
+		out.TargetReference = targetRef
+	}
+}
+
+func WithReporting(report *bool) CreateTestOption {
+	return func(body *CreateTestApplicationVndAPIPlusJSONRequestBody) {
+		if report == nil {
+			return
+		}
+		out := ensureOutput(body)
+		out.Report = report
+	}
+}
+
+func NewCreateTestApplicationBody(options ...CreateTestOption) *CreateTestApplicationVndAPIPlusJSONRequestBody {
+	result := &CreateTestApplicationVndAPIPlusJSONRequestBody{}
+	result.Data.Type = v20250407.CreateTestRequestBodyDataTypeTest
+	result.Data.Attributes.Input = &v20250407.TestAttributes_Input{}
+	result.Data.Attributes.Configuration = &v20250407.TestConfiguration{}
+
+	for _, option := range options {
+		option(result)
+	}
+
+	return result
+}
+
+func NewTestInputLegacyScmProject(projectId openapi_types.UUID, commitId string) v20250407.TestInputLegacyScmProject {
+	return v20250407.TestInputLegacyScmProject{
+		ProjectId: projectId,
+		CommitId:  commitId,
+		Type:      v20250407.LegacyScmProject,
+	}
+}
+
+func NewTestResponse() *v20250407.TestResult {
+	return &v20250407.TestResult{
+		Data: struct {
+			Attributes v20250407.TestState          `json:"attributes"`
+			Id         openapi_types.UUID           `json:"id"`
+			Type       v20250407.TestResultDataType `json:"type"`
+		}{},
+	}
+}
+
+func NewGetComponentsState() *v20250407.GetComponentsResponse {
+	return &v20250407.GetComponentsResponse{
+		Data: []v20250407.GetComponentsResponseItem{
+			{
+				Attributes: v20250407.ComponentAttributes{},
+				Id:         "1",
+				Type:       v20250407.Component,
+			},
+		},
+		Jsonapi: externalRef0.JsonApi{
+			Version: ApiVersion,
+		},
+		Links: struct {
+			Next *externalRef0.LinkProperty `json:"next,omitempty"`
+			Prev *externalRef0.LinkProperty `json:"prev,omitempty"`
+			Self *externalRef0.LinkProperty `json:"self,omitempty"`
+		}{},
+	}
+}

internal/util/repository.go

@@ -46,6 +46,22 @@ func GetRepositoryUrl(path string) (string, error) {
 	return repoUrl, err
 }
 
+func GetCommitId(path string) (string, error) {
+	repo, err := git.PlainOpenWithOptions(path, &git.PlainOpenOptions{
+		DetectDotGit: true,
+	})
+	if err != nil {
+		return "", fmt.Errorf("open local repository: %w", err)
+	}
+
+	commitId, err := repo.Head()
+	if err != nil {
+		return "", fmt.Errorf("get commit id: %w", err)
+	}
+
+	return commitId.Hash().String(), nil
+}
+
 func SanitiseCredentials(rawUrl string) (string, error) {
 	parsedURL, err := url.Parse(rawUrl)
 	if err != nil {

scan.go

@@ -46,7 +46,7 @@ type codeScanner struct {
 	trackerFactory       scan.TrackerFactory
 	logger               *zerolog.Logger
 	config               config.Config
-	resultTypes          testModels.Scan
+	resultTypes          testModels.ResultType
 }
 
 type CodeScanner interface {