Using subscription reconciliation to clean installplan status instead

Signed-off-by: Vu Dinh <[email protected]>

Author: dinhxuanvu

pkg/controller/operators/catalog/operator.go

@@ -831,12 +831,6 @@ func (o *Operator) syncResolvingNamespace(obj interface{}) error {
 		return err
 	}
 
-	ips, err := o.listInstallPlansMap(namespace)
-	if err != nil {
-		logger.WithError(err).Debug("couldn't list installplan")
-		return err
-	}
-
 	// TODO: parallel
 	maxGeneration := 0
 	subscriptionUpdated := false
@@ -853,7 +847,7 @@ func (o *Operator) syncResolvingNamespace(obj interface{}) error {
 		}
 
 		// ensure the installplan reference is correct
-		sub, changedIP, err := o.ensureSubscriptionInstallPlanState(logger, sub, ips)
+		sub, changedIP, err := o.ensureSubscriptionInstallPlanState(logger, sub)
 		if err != nil {
 			logger.Debugf("error ensuring installplan state: %v", err)
 			return err
@@ -958,29 +952,9 @@ func (o *Operator) nothingToUpdate(logger *logrus.Entry, sub *v1alpha1.Subscript
 	return false
 }
 
-// checkMissingInstallPlan checks if the installplan is missing or not when
-// the subscription is in pending upgrade state
-func (o *Operator) checkMissingInstallPlan(sub *v1alpha1.Subscription, ips map[string]struct{}) (*v1alpha1.Subscription, bool, error) {
-	_, ok := ips[sub.Status.InstallPlanRef.Name]
-	if !ok && sub.Status.State == v1alpha1.SubscriptionStateUpgradePending {
-		out := sub.DeepCopy()
-		out.Status.InstallPlanRef = nil
-		out.Status.Install = nil
-		out.Status.CurrentCSV = ""
-		out.Status.State = v1alpha1.SubscriptionStateNone
-		out.Status.LastUpdated = o.now()
-		updated, err := o.client.OperatorsV1alpha1().Subscriptions(sub.GetNamespace()).UpdateStatus(context.TODO(), out, metav1.UpdateOptions{})
-		if err != nil {
-			return out, false, nil
-		}
-		return updated, true, nil
-	}
-	return sub, false, nil
-}
-
-func (o *Operator) ensureSubscriptionInstallPlanState(logger *logrus.Entry, sub *v1alpha1.Subscription, ips map[string]struct{}) (*v1alpha1.Subscription, bool, error) {
+func (o *Operator) ensureSubscriptionInstallPlanState(logger *logrus.Entry, sub *v1alpha1.Subscription) (*v1alpha1.Subscription, bool, error) {
 	if sub.Status.InstallPlanRef != nil || sub.Status.Install != nil {
-		return o.checkMissingInstallPlan(sub, ips)
+		return sub, false, nil
 	}
 
 	logger.Debug("checking for existing installplan")
@@ -2046,20 +2020,6 @@ func (o *Operator) listInstallPlans(namespace string) (ips []*v1alpha1.InstallPl
 	return
 }
 
-func (o *Operator) listInstallPlansMap(namespace string) (ips map[string]struct{}, err error) {
-	list, err := o.client.OperatorsV1alpha1().InstallPlans(namespace).List(context.TODO(), metav1.ListOptions{})
-	if err != nil {
-		return
-	}
-
-	ips = make(map[string]struct{})
-	for i := range list.Items {
-		ips[list.Items[i].GetName()] = struct{}{}
-	}
-
-	return
-}
-
 // competingCRDOwnersExist returns true if there exists a CSV that owns at least one of the given CSVs owned CRDs (that's not the given CSV)
 func competingCRDOwnersExist(namespace string, csv *v1alpha1.ClusterServiceVersion, existingOwners map[string][]string) (bool, error) {
 	// Attempt to find a pre-existing owner in the namespace for any owned crd

pkg/controller/operators/catalog/subscription/reconciler_test.go

@@ -1171,6 +1171,63 @@ func TestInstallPlanReconcile(t *testing.T) {
 				}),
 			},
 		},
+		{
+			description: "SubscriptionExistsToInstallPlanNotFound/SubscriptionStateUpgradePending/Changes",
+			fields: fields{
+				config: &fakeReconcilerConfig{
+					now: nowFunc,
+					existingObjs: existingObjs{
+						clientObjs: []runtime.Object{
+							&v1alpha1.Subscription{
+								ObjectMeta: metav1.ObjectMeta{
+									Name:      "sub",
+									Namespace: "ns",
+								},
+								Status: v1alpha1.SubscriptionStatus{
+									InstallPlanRef: &corev1.ObjectReference{
+										Namespace: "ns",
+										Name:      "ip",
+									},
+									LastUpdated: earlier,
+									State:       v1alpha1.SubscriptionStateUpgradePending,
+								},
+							},
+						},
+					},
+				},
+			},
+			args: args{
+				in: newSubscriptionExistsState(&v1alpha1.Subscription{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "sub",
+						Namespace: "ns",
+					},
+					Status: v1alpha1.SubscriptionStatus{
+						InstallPlanRef: &corev1.ObjectReference{
+							Namespace: "ns",
+							Name:      "ip",
+						},
+						LastUpdated: earlier,
+						Conditions: []v1alpha1.SubscriptionCondition{
+							planPendingCondition(corev1.ConditionTrue, string(v1alpha1.InstallPlanPhaseInstalling), "", &earlier),
+						},
+						State: v1alpha1.SubscriptionStateUpgradePending,
+					},
+				}),
+			},
+			want: want{
+				out: newInstallPlanMissingState(&v1alpha1.Subscription{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "sub",
+						Namespace: "ns",
+					},
+					Status: v1alpha1.SubscriptionStatus{
+						LastUpdated: now,
+						State:       v1alpha1.SubscriptionStateNone,
+					},
+				}),
+			},
+		},
 		{
 			description: "SubscriptionExistsToInstallPlanPending/Installing/Conditions/NoChanges",
 			fields: fields{

pkg/controller/operators/catalog/subscription/state.go

@@ -385,12 +385,22 @@ func (i *installPlanReferencedState) InstallPlanNotFound(now *metav1.Time, clien
 	// Remove pending and failed conditions
 	out.Status.RemoveConditions(v1alpha1.SubscriptionInstallPlanPending, v1alpha1.SubscriptionInstallPlanFailed)
 
-	// Set missing condition to true
-	missingCond := out.Status.GetCondition(v1alpha1.SubscriptionInstallPlanMissing)
-	missingCond.Status = corev1.ConditionTrue
-	missingCond.Reason = v1alpha1.ReferencedInstallPlanNotFound
-	missingCond.LastTransitionTime = now
-	out.Status.SetCondition(missingCond)
+	// If the installplan is missing when subscription is in pending upgrade,
+	// clear the installplan ref so the resolution can happen again
+	if in.Status.State == v1alpha1.SubscriptionStateUpgradePending {
+		out.Status.InstallPlanRef = nil
+		out.Status.Install = nil
+		out.Status.CurrentCSV = ""
+		out.Status.State = v1alpha1.SubscriptionStateNone
+		out.Status.LastUpdated = *now
+	} else {
+		// Set missing condition to true
+		cond := out.Status.GetCondition(v1alpha1.SubscriptionInstallPlanMissing)
+		cond.Status = corev1.ConditionTrue
+		cond.Reason = v1alpha1.ReferencedInstallPlanNotFound
+		cond.LastTransitionTime = now
+		out.Status.SetCondition(cond)
+	}
 
 	// Build missing state
 	missingState := &installPlanMissingState{

test/e2e/subscription_e2e_test.go

@@ -243,7 +243,12 @@ var _ = Describe("Subscription", func() {
 		require.Equal(GinkgoT(), v1alpha1.ApprovalManual, newInstallPlan.Spec.Approval)
 		require.Equal(GinkgoT(), v1alpha1.InstallPlanPhaseRequiresApproval, newInstallPlan.Status.Phase)
 
-		newInstallPlan.Spec.Approved = true
+		// Set the InstallPlan's approved to True
+		Eventually(Apply(newInstallPlan, func(p *v1alpha1.InstallPlan) error {
+			p.Spec.Approved = true
+			return nil
+		})).Should(Succeed())
+
 		_, err = crc.OperatorsV1alpha1().InstallPlans(testNamespace).Update(context.Background(), newInstallPlan, metav1.UpdateOptions{})
 		require.NoError(GinkgoT(), err)