fix: handle custom test error interpretation (#128)

Author: PeterSchafer

go.mod

@@ -12,6 +12,7 @@ require (
 	github.com/pkg/errors v0.9.1
 	github.com/puzpuzpuz/xsync v1.5.2
 	github.com/rs/zerolog v1.32.0
+	github.com/snyk/error-catalog-golang-public v0.0.0-20251008132755-b542bb643649
 	github.com/stretchr/testify v1.10.0
 	golang.org/x/net v0.35.0
 )

go.sum

@@ -165,6 +165,8 @@ github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3/go.mod h1:A0bzQcvG
 github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/skeema/knownhosts v1.3.1 h1:X2osQ+RAjK76shCbvhHHHVl3ZlgDm8apHEHFqRjnBY8=
 github.com/skeema/knownhosts v1.3.1/go.mod h1:r7KTdC8l4uxWRyK2TpQZ/1o5HaSzh06ePQNxPwTcfiY=
+github.com/snyk/error-catalog-golang-public v0.0.0-20251008132755-b542bb643649 h1:kS6bSbjvfMTc8vqIZzHXzTHKh4kLKt27m0tsJ8T3WQc=
+github.com/snyk/error-catalog-golang-public v0.0.0-20251008132755-b542bb643649/go.mod h1:Ytttq7Pw4vOCu9NtRQaOeDU2dhBYUyNBe6kX4+nIIQ4=
 github.com/speakeasy-api/openapi-overlay v0.9.0 h1:Wrz6NO02cNlLzx1fB093lBlYxSI54VRhy1aSutx0PQg=
 github.com/speakeasy-api/openapi-overlay v0.9.0/go.mod h1:f5FloQrHA7MsxYg9djzMD5h6dxrHjVVByWKh7an8TRc=
 github.com/spf13/afero v1.12.0 h1:UcOPyRBYczmFn6yvphxkn9ZEOY65cpwGKb5mL36mrqs=

internal/analysis/analysis.go

@@ -21,6 +21,7 @@ import (
 	"context"
 	_ "embed"
 	"encoding/json"
+	goerrors "errors"
 	"fmt"
 	"io"
 	"net/http"
@@ -29,7 +30,7 @@ import (
 
 	"github.com/google/uuid"
 	openapi_types "github.com/oapi-codegen/runtime/types"
-	"github.com/pkg/errors"
+	errors "github.com/pkg/errors"
 	"github.com/rs/zerolog"
 
 	"github.com/snyk/code-client-go/bundle"
@@ -40,6 +41,7 @@ import (
 	"github.com/snyk/code-client-go/observability"
 	"github.com/snyk/code-client-go/sarif"
 	"github.com/snyk/code-client-go/scan"
+	"github.com/snyk/error-catalog-golang-public/cli"
 )
 
 //go:generate go tool github.com/golang/mock/mockgen -destination=mocks/analysis.go -source=analysis.go -package mocks
@@ -352,6 +354,9 @@ func (a *analysisOrchestrator) retrieveTestURL(ctx context.Context, client *test
 			}
 
 			return components, true, nil
+		case string(testModels.Error):
+			testError := parseTestError(parsedResponse, method)
+			return nil, false, testError
 		default:
 			return nil, false, fmt.Errorf("unexpected test status \"%s\"", stateDiscriminator)
 		}
@@ -360,6 +365,40 @@ func (a *analysisOrchestrator) retrieveTestURL(ctx context.Context, client *test
 	}
 }
 
+func parseTestError(parsedResponse *testApi.GetTestResultResponse, method string) error {
+	errorResponse, stateErrorStateError := parsedResponse.ApplicationvndApiJSON200.Data.Attributes.AsTestErrorState()
+
+	if stateErrorStateError != nil {
+		return stateErrorStateError
+	}
+
+	if errorResponse.Errors == nil {
+		return fmt.Errorf("%s: test error state has no errors", method)
+	}
+
+	var testError error
+	for _, error := range *errorResponse.Errors {
+		// since the error is only partially defined, we to create an existing generic error and fill it with the available information
+		tmp := cli.NewGeneralCLIFailureError(error.Message)
+		tmp.Level = "error"
+		tmp.ErrorCode = error.ErrorCode
+		tmp.Title = error.Title
+		tmp.StatusCode = parsedResponse.StatusCode()
+		tmp.Classification = error.Classification
+
+		if error.InfoUrl != nil {
+			tmp.Type = *error.InfoUrl
+			tmp.Links = []string{}
+		}
+		testError = goerrors.Join(testError, tmp)
+	}
+
+	if testError == nil {
+		testError = fmt.Errorf("%s: test error state has no errors", method)
+	}
+	return testError
+}
+
 func (a *analysisOrchestrator) retrieveTestComponents(ctx context.Context, client *testApi.Client, org uuid.UUID, testId openapi_types.UUID) (*scan.ResultMetaData, error) {
 	method := "analysis.retrieveTestComponents"
 	logger := a.logger.With().Str("method", method).Logger()

internal/analysis/analysis_private_test.go

@@ -0,0 +1,76 @@
+package analysis
+
+import (
+	"bytes"
+	"io"
+	"net/http"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/google/uuid"
+	confMocks "github.com/snyk/code-client-go/config/mocks"
+	httpmocks "github.com/snyk/code-client-go/http/mocks"
+	testApi "github.com/snyk/code-client-go/internal/api/test/2025-04-07"
+	"github.com/snyk/error-catalog-golang-public/snyk_errors"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestAnalysis_retrieveTestURL_TestResultError(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	config := confMocks.NewMockConfig(ctrl)
+	mockHTTPClient := httpmocks.NewMockHTTPClient(ctrl)
+	apiClient, err := testApi.NewClient("http://localhost", testApi.WithHTTPClient(mockHTTPClient))
+	assert.NoError(t, err)
+
+	analysisOrchestrator, ok := NewAnalysisOrchestrator(
+		config,
+		mockHTTPClient,
+	).(*analysisOrchestrator)
+
+	assert.True(t, ok)
+
+	mockHTTPClient.EXPECT().Do(gomock.Any()).Return(&http.Response{
+		StatusCode: http.StatusOK,
+		Header: http.Header{
+			"Content-Type": []string{"application/json"},
+		},
+		Body: io.NopCloser(bytes.NewBufferString(`{
+    "data": {
+        "id": "8afb6fed-b2a9-48cd-9097-8cebd80935e2",
+        "type": "test",
+        "attributes": {
+            "status": "error",
+            "created_at": "2025-10-09T08:42:07.462607Z",
+            "errors": [
+                {
+                    "title": "Analysis result size limit exceeded",
+                    "classification": "UNSUPPORTED",
+                    "message": "Analysis result sarif size is too large",
+                    "error_code": "SNYK-CODE-0002",
+                    "info_url": "https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-code-0002"
+                }
+            ]
+        }
+    },
+    "jsonapi": {
+        "version": "1.0"
+    },
+    "links": {
+        "self": "/hidden/orgs/***/tests/8afb6fed-b2a9-48cd-9097-8cebd80935e2"
+    }
+}`)),
+	}, nil)
+
+	resultMetaData, completed, err := analysisOrchestrator.retrieveTestURL(t.Context(), apiClient, uuid.New(), uuid.New())
+	assert.Error(t, err)
+	assert.False(t, completed)
+	assert.Nil(t, resultMetaData)
+
+	expectedError := snyk_errors.Error{}
+	assert.ErrorAs(t, err, &expectedError)
+	assert.Equal(t, expectedError.ErrorCode, "SNYK-CODE-0002")
+	assert.Equal(t, expectedError.Title, "Analysis result size limit exceeded")
+	assert.Equal(t, expectedError.Detail, "Analysis result sarif size is too large")
+	assert.Equal(t, expectedError.Classification, "UNSUPPORTED")
+	assert.Equal(t, expectedError.Type, "https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-code-0002")
+}