fix(review/1): format message

shanduur · shanduur · commit 62613ea65ec3 · 2024-02-13T21:35:36.000+01:00
Signed-off-by: Mateusz Urbanek &lt;mateusz.urbanek.98@gmail.com&gt;
diff --git a/container-object-storage-interface-provisioner-sidecar/pkg/bucket/bucket_controller.go b/container-object-storage-interface-provisioner-sidecar/pkg/bucket/bucket_controller.go
@@ -77,7 +77,7 @@ func (b *BucketListener) Add(ctx context.Context, inputBucket *v1alpha1.Bucket)
 
 	if bucket.Spec.BucketClassName == "" {
 		err = errors.New(fmt.Sprintf("BucketClassName not defined for bucket %s", bucket.ObjectMeta.Name))
-		b.recordEvent(inputBucket, v1.EventTypeWarning, events.ProvisioningFailed, "BucketClassName was not defined in the Bucket")
+		b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "BucketClassName was not defined in the Bucket.")
 		return err
 	}
 
@@ -107,7 +107,7 @@ func (b *BucketListener) Add(ctx context.Context, inputBucket *v1alpha1.Bucket)
 		if bucket.Spec.Parameters == nil {
 			bucketClass, err := b.bucketClasses().Get(ctx, bucket.Spec.BucketClassName, metav1.GetOptions{})
 			if kubeerrors.IsNotFound(err) {
-				b.recordEvent(inputBucket, v1.EventTypeWarning, events.ProvisioningFailed, "BucketClass provided in the BucketClaim does not exist")
+				b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "BucketClass %q provided in the BucketClaim does not exist.", bucket.Spec.BucketClassName)
 				return err
 			} else if err != nil {
 				klog.V(3).ErrorS(err, "Error fetching bucketClass",
@@ -134,7 +134,7 @@ 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.ProvisioningFailed, "Failed to create bucket")
+				b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "Failed to create bucket.")
 				return errors.Wrap(err, "Failed to create bucket")
 			}
 		}
@@ -350,7 +350,7 @@ func (b *BucketListener) deleteBucketOp(ctx context.Context, bucket *v1alpha1.Bu
 
 		if _, err := b.provisionerClient.DriverDeleteBucket(ctx, req); err != nil {
 			if status.Code(err) != codes.NotFound {
-				b.recordEvent(bucket, v1.EventTypeWarning, events.BucketDeleteFailed, "Failed to delete bucket")
+				b.recordEvent(bucket, v1.EventTypeWarning, events.FailedDeleteBucket, "Failed to delete bucket.")
 				return err
 			}
 		}
@@ -413,9 +413,9 @@ func (b *BucketListener) bucketAccesses(namespace string) bucketapi.BucketAccess
 }
 
 // recordEvent during the processing of the objects
-func (b *BucketListener) recordEvent(subject runtime.Object, eventtype, reason, message string) {
+func (b *BucketListener) recordEvent(subject runtime.Object, eventtype, reason, message string, args ...any) {
 	if b.eventRecorder == nil {
 		return
 	}
-	b.eventRecorder.Event(subject, eventtype, reason, message)
+	b.eventRecorder.Event(subject, eventtype, reason, fmt.Sprintf(message, args...))
 }
diff --git a/container-object-storage-interface-provisioner-sidecar/pkg/bucketaccess/bucketaccess_controller.go b/container-object-storage-interface-provisioner-sidecar/pkg/bucketaccess/bucketaccess_controller.go
@@ -96,7 +96,7 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 
 	bucketAccessClass, err := bal.bucketAccessClasses().Get(ctx, bucketAccessClassName, metav1.GetOptions{})
 	if kubeerrors.IsNotFound(err) {
-		bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.GrantingAccessFailed, "BucketAccessClass provided in the BucketAccess does not exist")
+		bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.FailedGrantAccess, "BucketAccessClass %q provided in the BucketAccess does not exist", bucketAccessClass.Name)
 		return err
 	} else if err != nil {
 		klog.ErrorS(err, "Failed to fetch bucketAccessClass", "bucketAccessClass", bucketAccessClassName)
@@ -136,7 +136,7 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 	}
 
 	if authType == cosi.AuthenticationType_IAM && bucketAccess.Spec.ServiceAccountName == "" {
-		bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.GrantingAccessFailed, "Must define ServiceAccountName when AuthenticationType is IAM")
+		bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.FailedCreateBucket, "Must define ServiceAccountName when AuthenticationType is IAM.")
 		return errors.New("Must define ServiceAccountName when AuthenticationType is IAM")
 	}
 
@@ -155,7 +155,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 not in Ready state and without a 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")
 	}
 
@@ -172,7 +172,7 @@ func (bal *BucketAccessListener) Add(ctx context.Context, inputBucketAccess *v1a
 	rsp, err := bal.provisionerClient.DriverGrantBucketAccess(ctx, req)
 	if err != nil {
 		if status.Code(err) != codes.AlreadyExists {
-			bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.GrantingAccessFailed, "Failed to grant access")
+			bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.FailedGrantAccess, "Failed to grant access.")
 			return errors.Wrap(err, "failed to grant access")
 		}
 
@@ -351,7 +351,7 @@ func (bal *BucketAccessListener) deleteBucketAccessOp(ctx context.Context, bucke
 
 	// First we revoke the bucketAccess from the driver
 	if _, err := bal.provisionerClient.DriverRevokeBucketAccess(ctx, req); err != nil {
-		bal.recordEvent(bucketAccess, v1.EventTypeWarning, events.RevokingAccessFailed, "Failed to revoke bucket access")
+		bal.recordEvent(bucketAccess, v1.EventTypeWarning, events.FailedRevokeAccess, "Failed to revoke bucket access.")
 		return errors.Wrap(err, "failed to revoke access")
 	}
 
@@ -454,9 +454,9 @@ func (bal *BucketAccessListener) InitializeEventRecorder(er record.EventRecorder
 }
 
 // recordEvent during the processing of the objects
-func (bal *BucketAccessListener) recordEvent(subject runtime.Object, eventtype, reason, message string) {
+func (bal *BucketAccessListener) recordEvent(subject runtime.Object, eventtype, reason, message string, args ...any) {
 	if bal.eventRecorder == nil {
 		return
 	}
-	bal.eventRecorder.Event(subject, eventtype, reason, message)
+	bal.eventRecorder.Event(subject, eventtype, reason, fmt.Sprintf(message, args...))
 }

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ func (b BucketListener) Add(ctx context.Context, inputBucket v1alpha1.Bucket)`
`77`	`77`
`78`	`78`	`if bucket.Spec.BucketClassName == "" {`
`79`	`79`	`err = errors.New(fmt.Sprintf("BucketClassName not defined for bucket %s", bucket.ObjectMeta.Name))`
`80`		`- b.recordEvent(inputBucket, v1.EventTypeWarning, events.ProvisioningFailed, "BucketClassName was not defined in the Bucket")`
	`80`	`+ b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "BucketClassName was not defined in the Bucket.")`
`81`	`81`	`return err`
`82`	`82`	`}`
`83`	`83`
`@@ -107,7 +107,7 @@ func (b BucketListener) Add(ctx context.Context, inputBucket v1alpha1.Bucket)`
`107`	`107`	`if bucket.Spec.Parameters == nil {`
`108`	`108`	`bucketClass, err := b.bucketClasses().Get(ctx, bucket.Spec.BucketClassName, metav1.GetOptions{})`
`109`	`109`	`if kubeerrors.IsNotFound(err) {`
`110`		`- b.recordEvent(inputBucket, v1.EventTypeWarning, events.ProvisioningFailed, "BucketClass provided in the BucketClaim does not exist")`
	`110`	`+ b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "BucketClass %q provided in the BucketClaim does not exist.", bucket.Spec.BucketClassName)`
`111`	`111`	`return err`
`112`	`112`	`} else if err != nil {`
`113`	`113`	`klog.V(3).ErrorS(err, "Error fetching bucketClass",`
`@@ -134,7 +134,7 @@ func (b BucketListener) Add(ctx context.Context, inputBucket v1alpha1.Bucket)`
`134`	`134`	`rsp, err := b.provisionerClient.DriverCreateBucket(ctx, req)`
`135`	`135`	`if err != nil {`
`136`	`136`	`if status.Code(err) != codes.AlreadyExists {`
`137`		`- b.recordEvent(inputBucket, v1.EventTypeWarning, events.ProvisioningFailed, "Failed to create bucket")`
	`137`	`+ b.recordEvent(inputBucket, v1.EventTypeWarning, events.FailedCreateBucket, "Failed to create bucket.")`
`138`	`138`	`return errors.Wrap(err, "Failed to create bucket")`
`139`	`139`	`}`
`140`	`140`	`}`
`@@ -350,7 +350,7 @@ func (b BucketListener) deleteBucketOp(ctx context.Context, bucket v1alpha1.Bu`
`350`	`350`
`351`	`351`	`if _, err := b.provisionerClient.DriverDeleteBucket(ctx, req); err != nil {`
`352`	`352`	`if status.Code(err) != codes.NotFound {`
`353`		`- b.recordEvent(bucket, v1.EventTypeWarning, events.BucketDeleteFailed, "Failed to delete bucket")`
	`353`	`+ b.recordEvent(bucket, v1.EventTypeWarning, events.FailedDeleteBucket, "Failed to delete bucket.")`
`354`	`354`	`return err`
`355`	`355`	`}`
`356`	`356`	`}`
`@@ -413,9 +413,9 @@ func (b *BucketListener) bucketAccesses(namespace string) bucketapi.BucketAccess`
`413`	`413`	`}`
`414`	`414`
`415`	`415`	`// recordEvent during the processing of the objects`
`416`		`-func (b *BucketListener) recordEvent(subject runtime.Object, eventtype, reason, message string) {`
	`416`	`+func (b *BucketListener) recordEvent(subject runtime.Object, eventtype, reason, message string, args ...any) {`
`417`	`417`	`if b.eventRecorder == nil {`
`418`	`418`	`return`
`419`	`419`	`}`
`420`		`- b.eventRecorder.Event(subject, eventtype, reason, message)`
	`420`	`+ b.eventRecorder.Event(subject, eventtype, reason, fmt.Sprintf(message, args...))`
`421`	`421`	`}`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ func (bal BucketAccessListener) Add(ctx context.Context, inputBucketAccess v1a`
`96`	`96`
`97`	`97`	`bucketAccessClass, err := bal.bucketAccessClasses().Get(ctx, bucketAccessClassName, metav1.GetOptions{})`
`98`	`98`	`if kubeerrors.IsNotFound(err) {`
`99`		`- bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.GrantingAccessFailed, "BucketAccessClass provided in the BucketAccess does not exist")`
	`99`	`+ bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.FailedGrantAccess, "BucketAccessClass %q provided in the BucketAccess does not exist", bucketAccessClass.Name)`
`100`	`100`	`return err`
`101`	`101`	`} else if err != nil {`
`102`	`102`	`klog.ErrorS(err, "Failed to fetch bucketAccessClass", "bucketAccessClass", bucketAccessClassName)`
`@@ -136,7 +136,7 @@ func (bal BucketAccessListener) Add(ctx context.Context, inputBucketAccess v1a`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`if authType == cosi.AuthenticationType_IAM && bucketAccess.Spec.ServiceAccountName == "" {`
`139`		`- bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.GrantingAccessFailed, "Must define ServiceAccountName when AuthenticationType is IAM")`
	`139`	`+ bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.FailedCreateBucket, "Must define ServiceAccountName when AuthenticationType is IAM.")`
`140`	`140`	`return errors.New("Must define ServiceAccountName when AuthenticationType is IAM")`
`141`	`141`	`}`
`142`	`142`
`@@ -155,7 +155,7 @@ func (bal BucketAccessListener) Add(ctx context.Context, inputBucketAccess v1a`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`if bucket.Status.BucketReady != true \|\| bucket.Status.BucketID == "" {`
`158`		`- bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.WaitingForBucket, "BucketAccess can't be granted to bucket not in Ready state and without a bucketID")`
	`158`	`+ 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 == "")`
`159`	`159`	`return errors.New("BucketAccess can't be granted to bucket not in Ready state and without a bucketID")`
`160`	`160`	`}`
`161`	`161`
`@@ -172,7 +172,7 @@ func (bal BucketAccessListener) Add(ctx context.Context, inputBucketAccess v1a`
`172`	`172`	`rsp, err := bal.provisionerClient.DriverGrantBucketAccess(ctx, req)`
`173`	`173`	`if err != nil {`
`174`	`174`	`if status.Code(err) != codes.AlreadyExists {`
`175`		`- bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.GrantingAccessFailed, "Failed to grant access")`
	`175`	`+ bal.recordEvent(inputBucketAccess, v1.EventTypeWarning, events.FailedGrantAccess, "Failed to grant access.")`
`176`	`176`	`return errors.Wrap(err, "failed to grant access")`
`177`	`177`	`}`
`178`	`178`
`@@ -351,7 +351,7 @@ func (bal *BucketAccessListener) deleteBucketAccessOp(ctx context.Context, bucke`
`351`	`351`
`352`	`352`	`// First we revoke the bucketAccess from the driver`
`353`	`353`	`if _, err := bal.provisionerClient.DriverRevokeBucketAccess(ctx, req); err != nil {`
`354`		`- bal.recordEvent(bucketAccess, v1.EventTypeWarning, events.RevokingAccessFailed, "Failed to revoke bucket access")`
	`354`	`+ bal.recordEvent(bucketAccess, v1.EventTypeWarning, events.FailedRevokeAccess, "Failed to revoke bucket access.")`
`355`	`355`	`return errors.Wrap(err, "failed to revoke access")`
`356`	`356`	`}`
`357`	`357`
`@@ -454,9 +454,9 @@ func (bal *BucketAccessListener) InitializeEventRecorder(er record.EventRecorder`
`454`	`454`	`}`
`455`	`455`
`456`	`456`	`// recordEvent during the processing of the objects`
`457`		`-func (bal *BucketAccessListener) recordEvent(subject runtime.Object, eventtype, reason, message string) {`
	`457`	`+func (bal *BucketAccessListener) recordEvent(subject runtime.Object, eventtype, reason, message string, args ...any) {`
`458`	`458`	`if bal.eventRecorder == nil {`
`459`	`459`	`return`
`460`	`460`	`}`
`461`		`- bal.eventRecorder.Event(subject, eventtype, reason, message)`
	`461`	`+ bal.eventRecorder.Event(subject, eventtype, reason, fmt.Sprintf(message, args...))`
`462`	`462`	`}`