rename corev1alpha1.LogicalClusterFinalizer to LogicalClusterFinalizerName

This is required so we can use the LogicalClusterFinalizer as a custom
string type like we do it with LogicalClusterInitializer

On-behalf-of: SAP <[email protected]>
Signed-off-by: Simon Bein <[email protected]>

Author: SimonTheLeg

pkg/reconciler/tenancy/workspace/workspace_reconcile_deletion.go

@@ -52,7 +52,7 @@ func (r *deletionReconciler) reconcile(ctx context.Context, workspace *tenancyv1
 	finSet := sets.New(workspace.Finalizers...)
 
 	// we want our finalizer to be removed last, so check if other finalizers exist
-	if finSet.Has(corev1alpha1.LogicalClusterFinalizer) && finSet.Len() > 1 {
+	if finSet.Has(corev1alpha1.LogicalClusterFinalizerName) && finSet.Len() > 1 {
 		return reconcileStatusContinue, nil
 	}
 
@@ -64,7 +64,7 @@ func (r *deletionReconciler) reconcile(ctx context.Context, workspace *tenancyv1
 		// if the logicalcluster was never created, we can directly remove the
 		// workspace finalizer
 		if !ok {
-			workspace.Finalizers = sets.List(finSet.Delete(corev1alpha1.LogicalClusterFinalizer))
+			workspace.Finalizers = sets.List(finSet.Delete(corev1alpha1.LogicalClusterFinalizerName))
 			return reconcileStatusContinue, nil
 		}
 
@@ -100,9 +100,9 @@ func (r *deletionReconciler) reconcile(ctx context.Context, workspace *tenancyv1
 		// fall-through
 	}
 	if apierrors.IsNotFound(getErr) {
-		if finSet.Has(corev1alpha1.LogicalClusterFinalizer) {
-			logger.Info(fmt.Sprintf("Removing finalizer %s", corev1alpha1.LogicalClusterFinalizer))
-			workspace.Finalizers = sets.List(finSet.Delete(corev1alpha1.LogicalClusterFinalizer))
+		if finSet.Has(corev1alpha1.LogicalClusterFinalizerName) {
+			logger.Info(fmt.Sprintf("Removing finalizer %s", corev1alpha1.LogicalClusterFinalizerName))
+			workspace.Finalizers = sets.List(finSet.Delete(corev1alpha1.LogicalClusterFinalizerName))
 			return reconcileStatusStopAndRequeue, nil // spec change
 		}
 		return reconcileStatusContinue, nil

pkg/reconciler/tenancy/workspace/workspace_reconcile_deletion_test.go

@@ -93,13 +93,13 @@ func TestReconcile(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					DeletionTimestamp: ptr.To(metav1.Now()),
 					Finalizers: []string{
-						corev1alpha1.LogicalClusterFinalizer,
+						corev1alpha1.LogicalClusterFinalizerName,
 						"other-finalizer",
 					},
 				},
 			},
 			expFinalizers: []string{
-				corev1alpha1.LogicalClusterFinalizer,
+				corev1alpha1.LogicalClusterFinalizerName,
 				"other-finalizer",
 			},
 		},
@@ -110,7 +110,7 @@ func TestReconcile(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					DeletionTimestamp: ptr.To(metav1.Now()),
 					Finalizers: []string{
-						corev1alpha1.LogicalClusterFinalizer,
+						corev1alpha1.LogicalClusterFinalizerName,
 					},
 				},
 				Status: tenancyv1alpha1.WorkspaceStatus{
@@ -128,7 +128,7 @@ func TestReconcile(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					DeletionTimestamp: ptr.To(metav1.Now()),
 					Finalizers: []string{
-						corev1alpha1.LogicalClusterFinalizer,
+						corev1alpha1.LogicalClusterFinalizerName,
 					},
 					Annotations: map[string]string{
 						workspaceClusterAnnotationKey: "test",
@@ -144,7 +144,7 @@ func TestReconcile(t *testing.T) {
 			// we do not remove our finalizers in this case, as we wait
 			// for another reconciliation loop
 			expFinalizers: []string{
-				corev1alpha1.LogicalClusterFinalizer,
+				corev1alpha1.LogicalClusterFinalizerName,
 			},
 			// we do expect our logicalCluster to be removed
 			expLogicalClusters: map[string]*corev1alpha1.LogicalCluster{},
@@ -156,7 +156,7 @@ func TestReconcile(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					DeletionTimestamp: ptr.To(metav1.Now()),
 					Finalizers: []string{
-						corev1alpha1.LogicalClusterFinalizer,
+						corev1alpha1.LogicalClusterFinalizerName,
 					},
 				},
 			},

pkg/reconciler/tenancy/workspace/workspace_reconcile_scheduling.go

@@ -141,7 +141,7 @@ func (r *schedulingReconciler) reconcile(ctx context.Context, workspace *tenancy
 		shardNameHash, hasShard := workspace.Annotations[WorkspaceShardHashAnnotationKey]
 		clusterNameString, hasCluster := workspace.Annotations[workspaceClusterAnnotationKey]
 		clusterName := logicalcluster.Name(clusterNameString)
-		hasFinalizer := sets.New[string](workspace.Finalizers...).Has(corev1alpha1.LogicalClusterFinalizer)
+		hasFinalizer := sets.New[string](workspace.Finalizers...).Has(corev1alpha1.LogicalClusterFinalizerName)
 
 		parentThis, err := r.getLogicalCluster(logicalcluster.From(workspace))
 		if err != nil && !apierrors.IsNotFound(err) {
@@ -180,7 +180,7 @@ func (r *schedulingReconciler) reconcile(ctx context.Context, workspace *tenancy
 			workspace.Annotations[workspaceClusterAnnotationKey] = cluster.String()
 		}
 		if !hasFinalizer {
-			workspace.Finalizers = append(workspace.Finalizers, corev1alpha1.LogicalClusterFinalizer)
+			workspace.Finalizers = append(workspace.Finalizers, corev1alpha1.LogicalClusterFinalizerName)
 		}
 		if !hasShard || !hasCluster || !hasFinalizer {
 			// this is the first part of our two-phase commit

sdk/apis/core/v1alpha1/logicalcluster_types.go

@@ -52,9 +52,9 @@ const (
 	// LogicalClusterName is the name of the LogicalCluster singleton.
 	LogicalClusterName = "cluster"
 
-	// LogicalClusterFinalizer attached to the owner of the LogicalCluster resource (usually a Workspace) so that we can control
+	// LogicalClusterFinalizerName attached to the owner of the LogicalCluster resource (usually a Workspace) so that we can control
 	// deletion of LogicalCluster resources.
-	LogicalClusterFinalizer = "core.kcp.io/logicalcluster"
+	LogicalClusterFinalizerName = "core.kcp.io/logicalcluster"
 )
 
 // LogicalClusterPhaseType is the type of the current phase of the logical cluster.

test/e2e/workspace/deletion_test.go

@@ -96,7 +96,7 @@ func TestWorkspaceLogicalClusterRelationship(t *testing.T) {
 		ws, err := clientset.Cluster(fixtureRoot).TenancyV1alpha1().Workspaces().Get(ctx, wsName, v1.GetOptions{})
 		require.NoError(c, err, "error getting workspace")
 		require.NotEqual(c, nil, ws.DeletionTimestamp)
-		require.Contains(c, ws.Finalizers, corev1alpha1.LogicalClusterFinalizer)
+		require.Contains(c, ws.Finalizers, corev1alpha1.LogicalClusterFinalizerName)
 	}, wait.ForeverTestTimeout, 100*time.Millisecond, "waiting for workspace to be marked for deletion")
 
 	// remove the custom finalizer from the logicalcluster object