Merge pull request vmware-tanzu#912 from TaoZou1/errortype

Add error type in NSXApiError

Author: TaoZou1

pkg/nsx/services/nsxserviceaccount/cluster.go

@@ -196,9 +196,11 @@ func (s *NSXServiceAccountService) RestoreRealizedNSXServiceAccount(ctx context.
 	if err == nil {
 		return fmt.Errorf("CCP store is not synchronized")
 	}
-	switch err.(type) {
-	case vapierrors.NotFound:
-	default:
+	if nsxErr, ok := err.(*nsxutil.NSXApiError); ok {
+		if nsxErr.Type() != vapierrors.ErrorType_NOT_FOUND {
+			return err
+		}
+	} else {
 		return err
 	}
 

pkg/nsx/services/nsxserviceaccount/cluster_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	vapierrors "github.com/vmware/vsphere-automation-sdk-go/lib/vapi/std/errors"
+	"github.com/vmware/vsphere-automation-sdk-go/runtime/data"
 	mpmodel "github.com/vmware/vsphere-automation-sdk-go/services/nsxt-mp/nsx/model"
 	"github.com/vmware/vsphere-automation-sdk-go/services/nsxt/model"
 	v1 "k8s.io/api/core/v1"
@@ -538,6 +539,8 @@ func TestNSXServiceAccountService_RestoreRealizedNSXServiceAccount(t *testing.T)
 	type args struct {
 		obj *v1alpha1.NSXServiceAccount
 	}
+	notFoundErr := vapierrors.NewNotFound()
+	notFoundErr.Data = data.NewStructValue("test", nil)
 	tests := []struct {
 		name        string
 		prepareFunc func(*testing.T, *NSXServiceAccountService, context.Context, *v1alpha1.NSXServiceAccount) *gomonkey.Patches
@@ -764,7 +767,7 @@ func TestNSXServiceAccountService_RestoreRealizedNSXServiceAccount(t *testing.T)
 			name: "GetSecretError",
 			prepareFunc: func(t *testing.T, s *NSXServiceAccountService, ctx context.Context, obj *v1alpha1.NSXServiceAccount) *gomonkey.Patches {
 				patches := gomonkey.ApplyMethodSeq(s.NSXClient.ClusterControlPlanesClient, "Get", []gomonkey.OutputCell{{
-					Values: gomonkey.Params{model.ClusterControlPlane{}, vapierrors.NotFound{}},
+					Values: gomonkey.Params{model.ClusterControlPlane{}, *notFoundErr},
 					Times:  1,
 				}})
 				return patches
@@ -801,7 +804,7 @@ func TestNSXServiceAccountService_RestoreRealizedNSXServiceAccount(t *testing.T)
 				piId := "Id1"
 				uid := "00000000-0000-0000-0000-000000000001"
 				patches := gomonkey.ApplyMethodSeq(s.NSXClient.ClusterControlPlanesClient, "Get", []gomonkey.OutputCell{{
-					Values: gomonkey.Params{model.ClusterControlPlane{}, vapierrors.NotFound{}},
+					Values: gomonkey.Params{model.ClusterControlPlane{}, *notFoundErr},
 					Times:  1,
 				}})
 				secretName := obj.Status.Secrets[0].Name

pkg/nsx/util/utils.go

@@ -327,11 +327,13 @@ func DumpHttpRequest(request *http.Request) {
 
 type NSXApiError struct {
 	*model.ApiError
+	apierrors.ErrorTypeEnum
 }
 
-func NewNSXApiError(apiError *model.ApiError) *NSXApiError {
+func NewNSXApiError(apiError *model.ApiError, errorType apierrors.ErrorTypeEnum) *NSXApiError {
 	return &NSXApiError{
-		ApiError: apiError,
+		ApiError:      apiError,
+		ErrorTypeEnum: errorType,
 	}
 }
 
@@ -345,17 +347,21 @@ func (e *NSXApiError) Error() string {
 	return "SDKError: unknown error"
 }
 
+func (e *NSXApiError) Type() apierrors.ErrorTypeEnum {
+	return e.ErrorTypeEnum
+}
+
 // TransNSXApiError processes an error and returns a formatted NSX API error message if applicable.
 // If the processed API error is nil, return the original error
 func TransNSXApiError(err error) error {
 	if err == nil {
 		return err
 	}
-	apierror, _ := DumpAPIError(err)
+	apierror, errorType := DumpAPIError(err)
 	if apierror == nil {
 		return err
 	}
-	return NewNSXApiError(apierror)
+	return NewNSXApiError(apierror, *errorType)
 }
 
 func relatedErrorToString(err *model.RelatedApiError) string {

pkg/nsx/util/utils_test.go

@@ -20,6 +20,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	apierrors "github.com/vmware/vsphere-automation-sdk-go/lib/vapi/std/errors"
+	"github.com/vmware/vsphere-automation-sdk-go/runtime/data"
 	mpmodel "github.com/vmware/vsphere-automation-sdk-go/services/nsxt-mp/nsx/model"
 	"github.com/vmware/vsphere-automation-sdk-go/services/nsxt/model"
 )
@@ -609,3 +611,47 @@ func TestMergeArraysWithoutDuplicate(t *testing.T) {
 		})
 	}
 }
+
+func TestTransNSXApiError(t *testing.T) {
+	tests := []struct {
+		name    string
+		err     error
+		wantErr bool
+	}{
+		{
+			name:    "Nil error",
+			err:     nil,
+			wantErr: false,
+		},
+		{
+			name:    "Valid NSX API error",
+			err:     apierrors.NewNotFound(),
+			wantErr: true,
+		},
+		{
+			name:    "Unknown error type",
+			err:     errors.New("unknown error"),
+			wantErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := TransNSXApiError(tt.err)
+			if (got != nil) != tt.wantErr {
+				t.Errorf("TransNSXApiError() error = %v, wantErr %v", got, tt.wantErr)
+			}
+		})
+	}
+
+	err := apierrors.NewNotFound()
+	err.Data = data.NewStructValue("test", nil)
+	t.Log(err)
+	got := TransNSXApiError(*err)
+	t.Log(got)
+	gotErr, ok := got.(*NSXApiError)
+	t.Log(gotErr)
+
+	assert.Equal(t, ok, true)
+	assert.Equal(t, gotErr.Type(), apierrors.ErrorType_NOT_FOUND)
+}