Skip to content

[release-1.10] Filter out GCE operation error codes caused by user errors #1292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion pkg/gce-cloud-provider/compute/gce-compute.go
Original file line number Diff line number Diff line change
Expand Up @@ -859,14 +859,40 @@ func (cloud *CloudProvider) WaitForAttach(ctx context.Context, project string, v
}

func wrapOpErr(name string, opErr *computev1.OperationErrorErrors) error {
if opErr == nil {
return nil
}

if opErr.Code == "UNSUPPORTED_OPERATION" {
if diskType := pdDiskTypeUnsupportedRegex.FindStringSubmatch(opErr.Message); diskType != nil {
return &UnsupportedDiskError{
DiskType: diskType[1],
}
}
}
return fmt.Errorf("operation %v failed (%v): %v", name, opErr.Code, opErr.Message)
grpcErrCode := codeForGCEOpError(*opErr)
return status.Errorf(grpcErrCode, "operation %v failed (%v): %v", name, opErr.Code, opErr.Message)
}

// codeForGCEOpError return the grpc error code for the passed in
// gce operation error.
func codeForGCEOpError(err computev1.OperationErrorErrors) codes.Code {
userErrors := map[string]codes.Code{
"RESOURCE_NOT_FOUND": codes.NotFound,
"RESOURCE_ALREADY_EXISTS": codes.AlreadyExists,
"RESOURCE_IN_USE_BY_ANOTHER_RESOURCE": codes.InvalidArgument,
"OPERATION_CANCELED_BY_USER": codes.Aborted,
"QUOTA_EXCEEDED": codes.ResourceExhausted,
"ZONE_RESOURCE_POOL_EXHAUSTED": codes.Unavailable,
"ZONE_RESOURCE_POOL_EXHAUSTED_WITH_DETAILS": codes.Unavailable,
"REGION_QUOTA_EXCEEDED": codes.ResourceExhausted,
"RATE_LIMIT_EXCEEDED": codes.ResourceExhausted,
"INVALID_USAGE": codes.InvalidArgument,
}
if code, ok := userErrors[err.Code]; ok {
return code
}
return codes.Internal
}

func opIsDone(op *computev1.Operation) (bool, error) {
Expand Down
73 changes: 73 additions & 0 deletions pkg/gce-cloud-provider/compute/gce-compute_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"testing"

computev1 "google.golang.org/api/compute/v1"
"google.golang.org/grpc/codes"
"sigs.k8s.io/gcp-compute-persistent-disk-csi-driver/pkg/common"
)

Expand Down Expand Up @@ -101,3 +102,75 @@ func TestValidateDiskParameters(t *testing.T) {
}
}
}

func TestCodeForGCEOpError(t *testing.T) {
testCases := []struct {
name string
inputErr computev1.OperationErrorErrors
expCode codes.Code
}{
{
name: "RESOURCE_NOT_FOUND error",
inputErr: computev1.OperationErrorErrors{Code: "RESOURCE_NOT_FOUND"},
expCode: codes.NotFound,
},
{
name: "RESOURCE_ALREADY_EXISTS error",
inputErr: computev1.OperationErrorErrors{Code: "RESOURCE_ALREADY_EXISTS"},
expCode: codes.AlreadyExists,
},
{
name: "OPERATION_CANCELED_BY_USER error",
inputErr: computev1.OperationErrorErrors{Code: "OPERATION_CANCELED_BY_USER"},
expCode: codes.Aborted,
},
{
name: "QUOTA_EXCEEDED error",
inputErr: computev1.OperationErrorErrors{Code: "QUOTA_EXCEEDED"},
expCode: codes.ResourceExhausted,
},
{
name: "ZONE_RESOURCE_POOL_EXHAUSTED error",
inputErr: computev1.OperationErrorErrors{Code: "ZONE_RESOURCE_POOL_EXHAUSTED"},
expCode: codes.Unavailable,
},
{
name: "ZONE_RESOURCE_POOL_EXHAUSTED_WITH_DETAILS error",
inputErr: computev1.OperationErrorErrors{Code: "ZONE_RESOURCE_POOL_EXHAUSTED_WITH_DETAILS"},
expCode: codes.Unavailable,
},
{
name: "REGION_QUOTA_EXCEEDED error",
inputErr: computev1.OperationErrorErrors{Code: "REGION_QUOTA_EXCEEDED"},
expCode: codes.ResourceExhausted,
},
{
name: "RATE_LIMIT_EXCEEDED error",
inputErr: computev1.OperationErrorErrors{Code: "RATE_LIMIT_EXCEEDED"},
expCode: codes.ResourceExhausted,
},
{
name: "INVALID_USAGE error",
inputErr: computev1.OperationErrorErrors{Code: "INVALID_USAGE"},
expCode: codes.InvalidArgument,
},
{
name: "RESOURCE_IN_USE_BY_ANOTHER_RESOURCE error",
inputErr: computev1.OperationErrorErrors{Code: "RESOURCE_IN_USE_BY_ANOTHER_RESOURCE"},
expCode: codes.InvalidArgument,
},
{
name: "UNSUPPORTED_OPERATION error",
inputErr: computev1.OperationErrorErrors{Code: "UNSUPPORTED_OPERATION"},
expCode: codes.Internal,
},
}

for _, tc := range testCases {
t.Logf("Running test: %v", tc.name)
errCode := codeForGCEOpError(tc.inputErr)
if errCode != tc.expCode {
t.Errorf("test %v failed: got %v, expected %v", tc.name, errCode, tc.expCode)
}
}
}