refactor(subs): add objectreference installplan refs

- Add objectreference installplan refs
- Cleanup fake operator configuration
- Surface fake client configurations

Author: njhale

pkg/api/apis/operators/v1alpha1/subscription_types.go

@@ -1,6 +1,7 @@
 package v1alpha1
 
 import (
+	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 )
@@ -36,24 +37,34 @@ type SubscriptionSpec struct {
 	InstallPlanApproval    Approval `json:"installPlanApproval,omitempty"`
 }
 
-// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
-// +genclient
-type Subscription struct {
-	metav1.TypeMeta   `json:",inline"`
-	metav1.ObjectMeta `json:"metadata"`
+type SubscriptionStatus struct {
+	// CurrentCSV is the CSV the Subscription is progressing to.
+	// +optional
+	CurrentCSV string `json:"currentCSV,omitempty"`
 
-	Spec   *SubscriptionSpec  `json:"spec"`
-	Status SubscriptionStatus `json:"status"`
-}
+	// InstalledCSV is the CSV currently installed by the Subscription.
+	// +optional
+	InstalledCSV string `json:"installedCSV,omitempty"`
 
-type SubscriptionStatus struct {
-	CurrentCSV   string                `json:"currentCSV,omitempty"`
-	InstalledCSV string                `json:"installedCSV, omitempty"`
-	Install      *InstallPlanReference `json:"installplan,omitempty"`
+	// Install is a reference to the latest InstallPlan generated for the Subscription.
+	// DEPRECATED: InstallPlanRef
+	// +optional
+	Install *InstallPlanReference `json:"installplan,omitempty"`
+
+	// State represents the current state of the Subscription
+	// +optional
+	State SubscriptionState `json:"state,omitempty"`
+
+	// Reason is the reason the Subscription was transitioned to its current state.
+	// +optional
+	Reason ConditionReason `json:"reason,omitempty"`
+
+	// InstallPlanRef is a reference to the latest InstallPlan that contains the Subscription's current CSV.
+	// +optional
+	InstallPlanRef *corev1.ObjectReference `json:"installPlanRef,omitempty"`
 
-	State       SubscriptionState `json:"state,omitempty"`
-	Reason      ConditionReason   `json:"reason,omitempty"`
-	LastUpdated metav1.Time       `json:"lastUpdated"`
+	// LastUpdated represents the last time that the Subscription status was updated.
+	LastUpdated metav1.Time `json:"lastUpdated"`
 }
 
 type InstallPlanReference struct {
@@ -63,6 +74,16 @@ type InstallPlanReference struct {
 	UID        types.UID `json:"uuid"`
 }
 
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +genclient
+type Subscription struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec   *SubscriptionSpec  `json:"spec"`
+	Status SubscriptionStatus `json:"status"`
+}
+
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type SubscriptionList struct {
 	metav1.TypeMeta `json:",inline"`
@@ -78,3 +99,13 @@ func (s *Subscription) GetInstallPlanApproval() Approval {
 	}
 	return ApprovalAutomatic
 }
+
+// NewInstallPlanReference returns an InstallPlanReference for the given ObjectReference.
+func NewInstallPlanReference(ref *corev1.ObjectReference) *InstallPlanReference {
+	return &InstallPlanReference{
+		APIVersion: ref.APIVersion,
+		Kind:       ref.Kind,
+		Name:       ref.Name,
+		UID:        ref.UID,
+	}
+}

pkg/api/apis/operators/v1alpha1/zz_generated.deepcopy.go

@@ -0,0 +1,78 @@
+/*
+Copyright 2019 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package fake
+
+import (
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/client-go/testing"
+)
+
+// ClientsetDecorator defines decorator methods for a Clientset.
+type ClientsetDecorator interface {
+	// PrependReactor adds a reactor to the beginning of the chain.
+	PrependReactor(verb, resource string, reaction testing.ReactionFunc)
+}
+
+// ReactionForwardingClientsetDecorator wraps a Clientset and "forwards" Action object mutations
+// from all successful non-handling Reactors along the chain to the first handling Reactor. This is
+// is a stopgap until we can upgrade to client-go v11.0, where the behavior is the default
+// (see https://github.com/kubernetes/client-go/blob/6ee68ca5fd8355d024d02f9db0b3b667e8357a0f/testing/fake.go#L130).
+type ReactionForwardingClientsetDecorator struct {
+	Clientset
+	ReactionChain []testing.Reactor // shadow embedded ReactionChain
+	actions       []testing.Action  // these may be castable to other types, but "Action" is the minimum
+}
+
+// NewReactionForwardingClientsetDecorator returns the ReactionForwardingClientsetDecorator wrapped Clientset result
+// of calling NewSimpleClientset with the given objects.
+func NewReactionForwardingClientsetDecorator(objects ...runtime.Object) *ReactionForwardingClientsetDecorator {
+	decorator := &ReactionForwardingClientsetDecorator{
+		Clientset: *NewSimpleClientset(objects...),
+	}
+
+	// Swap out the embedded ReactionChain with a Reactor that reduces over the decorator's ReactionChain.
+	decorator.ReactionChain = decorator.Clientset.ReactionChain
+	decorator.Clientset.ReactionChain = []testing.Reactor{&testing.SimpleReactor{"*", "*", decorator.reduceReactions}}
+
+	return decorator
+}
+
+// reduceReactions reduces over all reactions in the chain while "forwarding" Action object mutations
+// from all successful non-handling Reactors along the chain to the first handling Reactor.
+func (c *ReactionForwardingClientsetDecorator) reduceReactions(action testing.Action) (handled bool, ret runtime.Object, err error) {
+	// The embedded Client set is already locked, so there's no need to lock again
+	actionCopy := action.DeepCopy()
+	c.actions = append(c.actions, action.DeepCopy())
+	for _, reactor := range c.ReactionChain {
+		if !reactor.Handles(actionCopy) {
+			continue
+		}
+
+		handled, ret, err = reactor.React(actionCopy)
+		if !handled {
+			continue
+		}
+
+		return
+	}
+
+	return
+}
+
+// PrependReactor adds a reactor to the beginning of the chain.
+func (c *ReactionForwardingClientsetDecorator) PrependReactor(verb, resource string, reaction testing.ReactionFunc) {
+	c.ReactionChain = append([]testing.Reactor{&testing.SimpleReactor{verb, resource, reaction}}, c.ReactionChain...)
+}

pkg/api/client/clientset/versioned/fake/decorator.go

@@ -25,6 +25,7 @@ import (
 	"k8s.io/client-go/tools/cache"
 	"k8s.io/client-go/util/workqueue"
 
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
@@ -595,11 +596,11 @@ func (o *Operator) syncResolvingNamespace(obj interface{}) error {
 		})
 
 		// ensure the installplan reference is correct
-		sub, changedIp, err := o.ensureSubscriptionInstallPlanState(logger, sub)
+		sub, changedIP, err := o.ensureSubscriptionInstallPlanState(logger, sub)
 		if err != nil {
 			return err
 		}
-		subscriptionUpdated = subscriptionUpdated || changedIp
+		subscriptionUpdated = subscriptionUpdated || changedIP
 
 		// record the current state of the desired corresponding CSV in the status. no-op if we don't know the csv yet.
 		sub, changedCSV, err := o.ensureSubscriptionCSVState(logger, sub, querier)
@@ -756,8 +757,15 @@ func (o *Operator) ensureSubscriptionInstallPlanState(logger *logrus.Entry, sub
 	logger.WithField("installplan", ipName).Debug("found installplan that generated subscription")
 
 	out := sub.DeepCopy()
-	out.Status.Install = o.referenceForInstallPlan(ip)
+	ref, err := operators.GetReference(ip)
+	if err != nil {
+		logger.WithError(err).Warn("unable to generate installplan reference")
+		return nil, false, err
+	}
+	out.Status.InstallPlanRef = ref
+	out.Status.Install = v1alpha1.NewInstallPlanReference(ref)
 	out.Status.State = v1alpha1.SubscriptionStateUpgradePending
+
 	updated, err := o.client.OperatorsV1alpha1().Subscriptions(sub.GetNamespace()).UpdateStatus(out)
 	if err != nil {
 		return nil, false, err
@@ -807,13 +815,14 @@ func (o *Operator) ensureSubscriptionCSVState(logger *logrus.Entry, sub *v1alpha
 	return sub, true, nil
 }
 
-func (o *Operator) updateSubscriptionStatus(namespace string, subs []*v1alpha1.Subscription, installPlanRef *v1alpha1.InstallPlanReference) error {
+func (o *Operator) updateSubscriptionStatus(namespace string, subs []*v1alpha1.Subscription, installPlanRef *corev1.ObjectReference) error {
 	// TODO: parallel, sync waitgroup
 	var err error
 	for _, sub := range subs {
 		sub.Status.LastUpdated = timeNow()
 		if installPlanRef != nil {
-			sub.Status.Install = installPlanRef
+			sub.Status.InstallPlanRef = installPlanRef
+			sub.Status.Install = v1alpha1.NewInstallPlanReference(installPlanRef)
 			sub.Status.State = v1alpha1.SubscriptionStateUpgradePending
 		}
 		if _, subErr := o.client.OperatorsV1alpha1().Subscriptions(namespace).UpdateStatus(sub); subErr != nil {
@@ -823,7 +832,7 @@ func (o *Operator) updateSubscriptionStatus(namespace string, subs []*v1alpha1.S
 	return err
 }
 
-func (o *Operator) ensureInstallPlan(logger *logrus.Entry, namespace string, subs []*v1alpha1.Subscription, installPlanApproval v1alpha1.Approval, steps []*v1alpha1.Step) (*v1alpha1.InstallPlanReference, error) {
+func (o *Operator) ensureInstallPlan(logger *logrus.Entry, namespace string, subs []*v1alpha1.Subscription, installPlanApproval v1alpha1.Approval, steps []*v1alpha1.Step) (*corev1.ObjectReference, error) {
 	if len(steps) == 0 {
 		return nil, nil
 	}
@@ -837,15 +846,15 @@ func (o *Operator) ensureInstallPlan(logger *logrus.Entry, namespace string, sub
 	for _, installPlan := range installPlans {
 		if installPlan.Status.CSVManifestsMatch(steps) {
 			logger.Infof("found InstallPlan with matching manifests: %s", installPlan.GetName())
-			return o.referenceForInstallPlan(installPlan), nil
+			return operators.GetReference(installPlan)
 		}
 	}
 	logger.Warn("no installplan found with matching manifests, creating new one")
 
 	return o.createInstallPlan(namespace, subs, installPlanApproval, steps)
 }
 
-func (o *Operator) createInstallPlan(namespace string, subs []*v1alpha1.Subscription, installPlanApproval v1alpha1.Approval, steps []*v1alpha1.Step) (*v1alpha1.InstallPlanReference, error) {
+func (o *Operator) createInstallPlan(namespace string, subs []*v1alpha1.Subscription, installPlanApproval v1alpha1.Approval, steps []*v1alpha1.Step) (*corev1.ObjectReference, error) {
 	if len(steps) == 0 {
 		return nil, nil
 	}
@@ -896,17 +905,8 @@ func (o *Operator) createInstallPlan(namespace string, subs []*v1alpha1.Subscrip
 	if err != nil {
 		return nil, err
 	}
-	return o.referenceForInstallPlan(res), nil
 
-}
-
-func (o *Operator) referenceForInstallPlan(ip *v1alpha1.InstallPlan) *v1alpha1.InstallPlanReference {
-	return &v1alpha1.InstallPlanReference{
-		UID:        ip.GetUID(),
-		Name:       ip.GetName(),
-		APIVersion: v1alpha1.SchemeGroupVersion.String(),
-		Kind:       v1alpha1.InstallPlanKind,
-	}
+	return operators.GetReference(res)
 }
 
 func (o *Operator) requeueSubscription(name, namespace string) {