chore: errors cleanup

Author: shanduur

container-object-storage-interface-provisioner-sidecar/pkg/bucket/bucket_controller.go

@@ -76,9 +76,8 @@ func (b *BucketListener) Add(ctx context.Context, inputBucket *v1alpha1.Bucket)
 		"name", bucket.ObjectMeta.Name)
 
 	if bucket.Spec.BucketClassName == "" {
-		err = errors.New(fmt.Sprintf("BucketClassName not defined for bucket %s", bucket.ObjectMeta.Name))
-		b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "BucketClassName was not defined in the Bucket.")
-		return err
+		b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "BucketClassName was not defined in the Bucket %q.", bucket.Name)
+		return errors.Wrapf(consts.ErrUndefinedBucketClassName, "Bucket %q", bucket.Name)
 	}
 
 	if !strings.EqualFold(bucket.Spec.DriverName, b.driverName) {
@@ -134,16 +133,17 @@ func (b *BucketListener) Add(ctx context.Context, inputBucket *v1alpha1.Bucket)
 		rsp, err := b.provisionerClient.DriverCreateBucket(ctx, req)
 		if err != nil {
 			if status.Code(err) != codes.AlreadyExists {
-				b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "Failed to create bucket.")
-				return errors.Wrap(err, "Failed to create bucket")
+				err = errors.Wrapf(err, "Failed to create Bucket %q", bucket.Name)
+				b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, err.Error())
+				return err
 			}
 		}
 
 		if rsp == nil {
-			err = errors.New(fmt.Sprintf("DriverCreateBucket returned a nil response for bucket: %s", bucket.ObjectMeta.Name))
+			err = consts.ErrInternal
 			klog.V(3).ErrorS(err, "Internal Error from driver",
 				"bucket", bucket.ObjectMeta.Name)
-			return err
+			return errors.Wrapf(err, "Bucket %q", bucket.Name)
 		}
 
 		if rsp.BucketId != "" {
@@ -152,8 +152,7 @@ func (b *BucketListener) Add(ctx context.Context, inputBucket *v1alpha1.Bucket)
 		} else {
 			klog.V(3).ErrorS(err, "DriverCreateBucket returned an empty bucketID",
 				"bucket", bucket.ObjectMeta.Name)
-			err = errors.New(fmt.Sprintf("DriverCreateBucket returned an empty bucketID for bucket: %s", bucket.ObjectMeta.Name))
-			return err
+			return errors.Wrapf(consts.ErrEmptyBucketID, "Bucket %q", bucket.Name)
 		}
 
 		// Now we update the BucketReady status of BucketClaim

container-object-storage-interface-provisioner-sidecar/pkg/bucketaccess/bucketaccess_controller.go

@@ -91,7 +91,7 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 
 	secretCredName := bucketAccess.Spec.CredentialsSecretName
 	if secretCredName == "" {
-		return errors.New("CredentialsSecretName not defined in the BucketAccess")
+		return consts.ErrUndefinedSecretName
 	}
 
 	bucketAccessClass, err := bal.bucketAccessClasses().Get(ctx, bucketAccessClassName, metav1.GetOptions{})
@@ -119,7 +119,7 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 	}
 
 	if bucketClaim.Status.BucketName == "" || bucketClaim.Status.BucketReady != true {
-		err := errors.New("BucketName cannot be empty or BucketNotReady in bucketClaim")
+		err := consts.ErrInvalidBucketState
 		klog.V(3).ErrorS(err,
 			"Invalid arguments",
 			"bucketClaim", bucketClaim.Name,
@@ -156,7 +156,7 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 
 	if bucket.Status.BucketReady != true || bucket.Status.BucketID == "" {
 		bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.WaitingForBucket, "BucketAccess can't be granted to Bucket %q not in Ready state (isReady? %t) or without a bucketID (ID empty? %t).", bucket.Name, bucket.Status.BucketReady, bucket.Status.BucketID == "")
-		return errors.New("BucketAccess can't be granted to bucket not in Ready state and without a bucketID")
+		return consts.ErrInvalidBucketState
 	}
 
 	accountName := consts.AccountNamePrefix + string(bucketAccess.UID)
@@ -179,14 +179,14 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 	}
 
 	if rsp.AccountId == "" {
-		err = errors.New("AccountId not defined in DriverGrantBucketAccess")
+		err = consts.ErrUndefinedAccountID
 		klog.V(3).ErrorS(err, "BucketAccess", bucketAccess.ObjectMeta.Name)
 		return errors.Wrap(err, fmt.Sprintf("BucketAccess %s", bucketAccess.ObjectMeta.Name))
 	}
 
 	credentials := rsp.Credentials
 	if len(credentials) != 1 {
-		err = errors.New("Credentials returned in DriverGrantBucketAccessResponse should be of length 1")
+		err = consts.ErrInvalidCredentials
 		klog.V(3).ErrorS(err, "BucketAccess", bucketAccess.ObjectMeta.Name)
 		return errors.Wrap(err, fmt.Sprintf("BucketAccess %s", bucketAccess.ObjectMeta.Name))
 	}
@@ -230,7 +230,7 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 
 	stringData, err := json.Marshal(bucketInfo)
 	if err != nil {
-		return errors.New("Error converting bucketinfo into secret")
+		return consts.ErrBucketInfoConversionFailed
 	}
 
 	if _, err := bal.secrets(namespace).Get(ctx, secretCredName, metav1.GetOptions{}); err != nil {

container-object-storage-interface-provisioner-sidecar/pkg/consts/consts.go

@@ -15,6 +15,8 @@
 
 package consts
 
+import "errors"
+
 const (
 	AccountNamePrefix = "ba-"
 	BucketInfoPrefix  = "bc-"
@@ -35,3 +37,14 @@ const (
 	AzureSecretExpiryTimeStamp = "expiryTs"
 	DefaultTimeFormat          = "2006-01-02 15:04:05.999999999 -0700 MST"
 )
+
+var (
+	ErrInternal                   = errors.New("driverCreateBucket returned a nil response")
+	ErrBucketInfoConversionFailed = errors.New("error converting bucketInfo into Secret")
+	ErrEmptyBucketID              = errors.New("driverCreateBucket returned an empty bucketID")
+	ErrUndefinedBucketClassName   = errors.New("BucketClassName not defined")
+	ErrUndefinedAccountID         = errors.New("AccountId not defined in DriverGrantBucketAccess")
+	ErrUndefinedSecretName        = errors.New("CredentialsSecretName not defined in the BucketAccess")
+	ErrInvalidBucketState         = errors.New("BucketName cannot be empty or BucketNotReady in bucketClaim")
+	ErrInvalidCredentials         = errors.New("Credentials returned in DriverGrantBucketAccessResponse should be of length 1")
+)