Improved error messages for enforced backup/restore spec

Enforced backup/restore spec validation errors now include the enforced value in addition to the field name.
migtools · Feb 6, 2025 · a1ea7c8 · a1ea7c8
1 parent 720430d
commit a1ea7c8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/internal/common/function/function.go b/internal/common/function/function.go
@@ -110,8 +110,9 @@ func ValidateBackupSpec(nonAdminBackup *nacv1alpha1.NonAdminBackup, enforcedBack
 			field, _ := reflect.TypeOf(nonAdminBackup.Spec.BackupSpec).Elem().FieldByName(enforcedFieldName)
 			tagName, _, _ := strings.Cut(field.Tag.Get(constant.JSONTagString), constant.CommaString)
 			return fmt.Errorf(
-				"NonAdminBackup spec.backupSpec.%v field value is enforced by admin user, can not override it",
+				"the administrator has restricted spec.backupSpec.%v field value to %v",
 				tagName,
+				reflect.Indirect(enforcedField),
 			)
 		}
 	}
@@ -158,8 +159,9 @@ func ValidateRestoreSpec(ctx context.Context, clientInstance client.Client, nonA
 			field, _ := reflect.TypeOf(nonAdminRestore.Spec.RestoreSpec).Elem().FieldByName(enforcedFieldName)
 			tagName, _, _ := strings.Cut(field.Tag.Get(constant.JSONTagString), constant.CommaString)
 			return fmt.Errorf(
-				"NonAdminRestore spec.restoreSpec.%v field value is enforced by admin user, can not override it",
+				"the administrator has restricted spec.restoreSpec.%v field value to %v",
 				tagName,
+				reflect.Indirect(enforcedField),
 			)
 		}
 	}

diff --git a/internal/controller/nonadminbackup_controller_test.go b/internal/controller/nonadminbackup_controller_test.go
@@ -1007,7 +1007,7 @@ var _ = ginkgo.Describe("Test full reconcile loop of NonAdminBackup Controller",
 						Type:    "Accepted",
 						Status:  metav1.ConditionFalse,
 						Reason:  "InvalidBackupSpec",
-						Message: "spec.backupSpec.snapshotVolumes field value is enforced by admin user",
+						Message: "the administrator has restricted spec.backupSpec.snapshotVolumes field value to false",
 					},
 				},
 			},