fix(secret): use a synthetic kind instead of an api field to determine

bundle secrets from pull secrets

Author: ecordell

pkg/api/apis/operators/installplan_types.go

@@ -354,10 +354,6 @@ type StepResource struct {
 	Kind                   string
 	Name                   string
 	Manifest               string
-	// BundleSecret is a one-off flag for handling secrets from a user bundle versus from the catalog source.
-	// This field is handled internally by OLM and should not be exposed by the API. 
-	// Longer term StepResources will be refactored.
-	BundleSecret           bool
 }
 
 func (r StepResource) String() string {

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

@@ -322,7 +322,6 @@ type StepResource struct {
 	Kind                   string `json:"kind"`
 	Name                   string `json:"name"`
 	Manifest               string `json:"manifest,omitempty"`
-	BundleSecret           bool   `json:"bundleSecret"`
 }
 
 func (r StepResource) String() string {

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

@@ -1523,22 +1523,20 @@ func (o *Operator) ExecutePlan(plan *v1alpha1.InstallPlan) error {
 
 				plan.Status.Plan[i].Status = status
 
-			case secretKind:
-				if step.Resource.BundleSecret {
-					var s corev1.Secret
-					err := json.Unmarshal([]byte(step.Resource.Manifest), &s)
-					if err != nil {
-						return errorwrap.Wrapf(err, "error parsing step manifest: %s", step.Resource.Name)
-					}
-					status, err := ensurer.EnsureBundleSecret(plan.Namespace, &s)
-					if err != nil {
-						return err
-					}
-
-					plan.Status.Plan[i].Status = status
-					continue
+			case resolver.BundleSecretKind:
+				var s corev1.Secret
+				err := json.Unmarshal([]byte(step.Resource.Manifest), &s)
+				if err != nil {
+					return errorwrap.Wrapf(err, "error parsing step manifest: %s", step.Resource.Name)
+				}
+				status, err := ensurer.EnsureBundleSecret(plan.Namespace, &s)
+				if err != nil {
+					return err
 				}
 
+				plan.Status.Plan[i].Status = status
+
+			case secretKind:
 				status, err := ensurer.EnsureSecret(o.namespace, plan.GetNamespace(), step.Resource.Name)
 				if err != nil {
 					return err

pkg/controller/operators/catalog/operator.go

@@ -434,10 +434,9 @@ func TestExecutePlan(t *testing.T) {
 							CatalogSourceNamespace: namespace,
 							Group:                  "",
 							Version:                "v1",
-							Kind:                   "Secret",
+							Kind:                   "BundleSecret",
 							Name:                   "s",
 							Manifest:               toManifest(t, secret("s", namespace)),
-							BundleSecret:           true,
 						},
 						Status: v1alpha1.StepStatusUnknown,
 					},
@@ -459,7 +458,6 @@ func TestExecutePlan(t *testing.T) {
 							Kind:                   "Secret",
 							Name:                   "s",
 							Manifest:               toManifest(t, secret("s", namespace)),
-							BundleSecret:           false,
 						},
 						Status: v1alpha1.StepStatusUnknown,
 					},

pkg/controller/operators/catalog/operator_test.go

@@ -22,6 +22,7 @@ import (
 
 const (
 	secretKind = "Secret"
+	BundleSecretKind = "BundleSecret"
 )
 
 var (
@@ -75,11 +76,10 @@ func NewStepResourceFromObject(obj runtime.Object, catalogSourceName, catalogSou
 		CatalogSourceNamespace: catalogSourceNamespace,
 	}
 
-	// Treat secret objects with a special case
-	// OLM copies secrets as well as supports creating new ones from the bundle
-	// This boolean determines whether its a user-created secret
+	// BundleSecret is a synthetic kind that OLM uses to distinguish between secrets included in the bundle and
+	// pull secrets included in the installplan
 	if obj.GetObjectKind().GroupVersionKind().Kind == secretKind {
-		resource.BundleSecret = true
+		resource.Kind = BundleSecretKind
 	}
 
 	return resource, nil