Skip to content

Commit e317c24

Browse files
committed
Rephrase some controller comments
1 parent df0c630 commit e317c24

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

controllers/rabbitmqcluster_controller.go

+7-8
Original file line numberDiff line numberDiff line change
@@ -103,28 +103,27 @@ func (r *RabbitmqClusterReconciler) Reconcile(req ctrl.Request) (ctrl.Result, er
103103
return ctrl.Result{}, nil
104104
}
105105

106-
// Resource has been marked for deletion
106+
// Check if the resource has been marked for deletion
107107
if !rabbitmqCluster.ObjectMeta.DeletionTimestamp.IsZero() {
108108
logger.Info("Deleting RabbitmqCluster",
109109
"namespace", rabbitmqCluster.Namespace,
110110
"name", rabbitmqCluster.Name)
111-
// Stop reconciliation as the item is being deleted
112111
return ctrl.Result{}, r.prepareForDeletion(ctx, rabbitmqCluster)
113112
}
114113

114+
// Ensure the resource have a deletion marker
115+
if err := r.addFinalizerIfNeeded(ctx, rabbitmqCluster); err != nil {
116+
return ctrl.Result{}, err
117+
}
118+
115119
// TLS: check if specified, and if secret exists
116120
if rabbitmqCluster.TLSEnabled() {
117121
if result, err := r.checkTLSSecrets(ctx, rabbitmqCluster); err != nil {
118122
return result, err
119123
}
120124
}
121125

122-
if err := r.addFinalizerIfNeeded(ctx, rabbitmqCluster); err != nil {
123-
return ctrl.Result{}, err
124-
}
125-
126126
childResources, err := r.getChildResources(ctx, *rabbitmqCluster)
127-
128127
if err != nil {
129128
return ctrl.Result{}, err
130129
}
@@ -600,8 +599,8 @@ func (r *RabbitmqClusterReconciler) addRabbitmqDeletionLabel(ctx context.Context
600599
return nil
601600
}
602601

602+
// addFinalizerIfNeeded adds a deletion finalizer if the RabbitmqCluster does not have one yet and is not marked for deletion
603603
func (r *RabbitmqClusterReconciler) addFinalizerIfNeeded(ctx context.Context, rabbitmqCluster *rabbitmqv1beta1.RabbitmqCluster) error {
604-
// The RabbitmqCluster is not marked for deletion (no deletion timestamp) but does not have the deletion finalizer
605604
if rabbitmqCluster.ObjectMeta.DeletionTimestamp.IsZero() && !controllerutil.ContainsFinalizer(rabbitmqCluster, deletionFinalizer) {
606605
controllerutil.AddFinalizer(rabbitmqCluster, deletionFinalizer)
607606
if err := r.Client.Update(ctx, rabbitmqCluster); err != nil {

controllers/rabbitmqcluster_controller_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1572,7 +1572,7 @@ var _ = Describe("RabbitmqClusterController", func() {
15721572
})
15731573
})
15741574

1575-
When("the cluster is only 1 node large", func() {
1575+
When("the cluster is a single node cluster", func() {
15761576
BeforeEach(func() {
15771577
cluster = &rabbitmqv1beta1.RabbitmqCluster{
15781578
ObjectMeta: metav1.ObjectMeta{

0 commit comments

Comments
 (0)