Fix deprecated installPlan step resource test

Author: awgreene

Makefile

@@ -146,7 +146,7 @@ e2e:
 
 # See workflows/e2e-tests.yml See test/e2e/README.md for details.
 .PHONY: e2e-local
-e2e-local: BUILD_TAGS="json1 experimental_metrics"
+e2e-local: BUILD_TAGS="json1 e2e experimental_metrics"
 e2e-local: extra_args=-kind.images=../test/e2e-local.image.tar -test-data-dir=../test/e2e/testdata -gather-artifacts-script-path=../test/e2e/collect-ci-artifacts.sh
 e2e-local: run=bin/e2e-local.test
 e2e-local: bin/e2e-local.test test/e2e-local.image.tar

go.mod

@@ -3,6 +3,7 @@ module github.com/operator-framework/operator-lifecycle-manager
 go 1.19
 
 require (
+	github.com/awgreene/deprecated-crd v0.0.0-20221104113733-9325d365f338
 	github.com/blang/semver/v4 v4.0.0
 	github.com/coreos/go-semver v0.3.0
 	github.com/davecgh/go-spew v1.1.1

go.sum

@@ -167,6 +167,8 @@ github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:l
 github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY=
 github.com/asaskevich/govalidator v0.0.0-20200428143746-21a406dcc535 h1:4daAzAu0S6Vi7/lbWECcX0j45yZReDZ56BQsrVBOEEY=
 github.com/asaskevich/govalidator v0.0.0-20200428143746-21a406dcc535/go.mod h1:oGkLhpf+kjZl6xBf758TQhh5XrAeiJv/7FRz/2spLIg=
+github.com/awgreene/deprecated-crd v0.0.0-20221104113733-9325d365f338 h1:JZazVWBz5gdejxNSvwD06pxlthcAMOup2omxy40LN74=
+github.com/awgreene/deprecated-crd v0.0.0-20221104113733-9325d365f338/go.mod h1:PmWqI9F1lHf+XbJcXbWWA+g6RisiVzk/RdFr1UFjCi8=
 github.com/aws/aws-sdk-go v1.15.11/go.mod h1:mFuSZ37Z9YOHbQEwBWztmVzqXrEkub65tZoCYDt7FT0=
 github.com/aws/aws-sdk-go v1.17.7/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
 github.com/benbjohnson/clock v1.0.3/go.mod h1:bGMdMPoPVvcYyt1gHDf4J2KE153Yf9BuiUKYMaxlTDM=

pkg/controller/operators/catalog/operator.go

@@ -2532,33 +2532,3 @@ func (o *Operator) apiresourceFromGVK(gvk schema.GroupVersionKind) (metav1.APIRe
 	logger.Info("couldn't find GVK in api discovery")
 	return metav1.APIResource{}, olmerrors.GroupVersionKindNotFoundError{Group: gvk.Group, Version: gvk.Version, Kind: gvk.Kind}
 }
-
-const (
-	PrometheusRuleKind        = "PrometheusRule"
-	ServiceMonitorKind        = "ServiceMonitor"
-	PodDisruptionBudgetKind   = "PodDisruptionBudget"
-	PriorityClassKind         = "PriorityClass"
-	VerticalPodAutoscalerKind = "VerticalPodAutoscaler"
-	ConsoleYAMLSampleKind     = "ConsoleYAMLSample"
-	ConsoleQuickStartKind     = "ConsoleQuickStart"
-	ConsoleCLIDownloadKind    = "ConsoleCLIDownload"
-	ConsoleLinkKind           = "ConsoleLink"
-)
-
-var supportedKinds = map[string]struct{}{
-	PrometheusRuleKind:        {},
-	ServiceMonitorKind:        {},
-	PodDisruptionBudgetKind:   {},
-	PriorityClassKind:         {},
-	VerticalPodAutoscalerKind: {},
-	ConsoleYAMLSampleKind:     {},
-	ConsoleQuickStartKind:     {},
-	ConsoleCLIDownloadKind:    {},
-	ConsoleLinkKind:           {},
-}
-
-// isSupported returns true if OLM supports this type of CustomResource.
-func isSupported(kind string) bool {
-	_, ok := supportedKinds[kind]
-	return ok
-}

pkg/controller/operators/catalog/supportedresources.go

@@ -0,0 +1,31 @@
+package catalog
+
+const (
+	PrometheusRuleKind        = "PrometheusRule"
+	ServiceMonitorKind        = "ServiceMonitor"
+	PodDisruptionBudgetKind   = "PodDisruptionBudget"
+	PriorityClassKind         = "PriorityClass"
+	VerticalPodAutoscalerKind = "VerticalPodAutoscaler"
+	ConsoleYAMLSampleKind     = "ConsoleYAMLSample"
+	ConsoleQuickStartKind     = "ConsoleQuickStart"
+	ConsoleCLIDownloadKind    = "ConsoleCLIDownload"
+	ConsoleLinkKind           = "ConsoleLink"
+)
+
+var supportedKinds = map[string]struct{}{
+	PrometheusRuleKind:        {},
+	ServiceMonitorKind:        {},
+	PodDisruptionBudgetKind:   {},
+	PriorityClassKind:         {},
+	VerticalPodAutoscalerKind: {},
+	ConsoleYAMLSampleKind:     {},
+	ConsoleQuickStartKind:     {},
+	ConsoleCLIDownloadKind:    {},
+	ConsoleLinkKind:           {},
+}
+
+// isSupported returns true if OLM supports this type of CustomResource.
+func isSupported(kind string) bool {
+	_, ok := supportedKinds[kind]
+	return ok
+}

pkg/controller/operators/catalog/supportedresourcesoveride.go

@@ -0,0 +1,9 @@
+package catalog
+
+const (
+	DeprecatedKind = "Deprecated"
+)
+
+func init() {
+	supportedKinds[DeprecatedKind] = struct{}{}
+}

test/e2e/installplan_e2e_test.go

@@ -20,7 +20,6 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	authorizationv1 "k8s.io/api/authorization/v1"
 	corev1 "k8s.io/api/core/v1"
-	policyv1beta1 "k8s.io/api/policy/v1beta1"
 	rbacv1 "k8s.io/api/rbac/v1"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
@@ -48,6 +47,9 @@ import (
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorclient"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
 	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/ctx"
+	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/util"
+
+	deprecatedv1 "github.com/awgreene/deprecated-crd/api/v1"
 )
 
 var _ = Describe("Install Plan", func() {
@@ -76,11 +78,11 @@ var _ = Describe("Install Plan", func() {
 
 	When("an InstallPlan step contains a deprecated resource version", func() {
 		var (
-			csv      operatorsv1alpha1.ClusterServiceVersion
-			plan     operatorsv1alpha1.InstallPlan
-			pdb      policyv1beta1.PodDisruptionBudget
-			manifest string
-			counter  float64
+			csv        operatorsv1alpha1.ClusterServiceVersion
+			plan       operatorsv1alpha1.InstallPlan
+			deprecated deprecatedv1.Deprecated
+			manifest   string
+			counter    float64
 		)
 
 		BeforeEach(func() {
@@ -90,13 +92,8 @@ var _ = Describe("Install Plan", func() {
 			v, err := dc.ServerVersion()
 			Expect(err).ToNot(HaveOccurred())
 
-			if minor, err := strconv.Atoi(v.Minor); err == nil && minor < 21 {
-				// This is a tactical can-kick with
-				// the expectation that the
-				// event-emitting behavior being
-				// tested in this context will have
-				// moved by the time 1.25 arrives.
-				Skip("hack: test is dependent on 1.21+ behavior")
+			if minor, err := strconv.Atoi(v.Minor); err == nil && minor < 16 {
+				Skip("test is dependent on CRD v1 introduced at 1.16")
 			}
 		})
 
@@ -107,26 +104,30 @@ var _ = Describe("Install Plan", func() {
 					counter = metric.Value
 				}
 			}
+			deprecatedCRD, err := util.DecodeFile("./testdata/deprecated-crd/deprecated.crd.yaml", &apiextensionsv1.CustomResourceDefinition{})
+			Expect(err).NotTo(HaveOccurred())
+
+			Expect(ctx.Ctx().Client().Create(context.Background(), deprecatedCRD)).To(Succeed())
 
 			csv = newCSV(genName("test-csv-"), ns.GetName(), "", semver.Version{}, nil, nil, nil)
 			Expect(ctx.Ctx().Client().Create(context.Background(), &csv)).To(Succeed())
 
-			pdb = policyv1beta1.PodDisruptionBudget{
-				ObjectMeta: metav1.ObjectMeta{
-					Name: genName("test-pdb-"),
-				},
+			deprecated = deprecatedv1.Deprecated{
 				TypeMeta: metav1.TypeMeta{
-					Kind:       "PodDisruptionBudget",
-					APIVersion: policyv1beta1.SchemeGroupVersion.String(),
+					APIVersion: "operators.io.operator-framework/v1",
+					Kind:       "Deprecated",
+				},
+				ObjectMeta: metav1.ObjectMeta{
+					Namespace: ns.GetName(),
+					Name:      "foo",
 				},
-				Spec: policyv1beta1.PodDisruptionBudgetSpec{},
 			}
 
 			scheme := runtime.NewScheme()
-			Expect(policyv1beta1.AddToScheme(scheme)).To(Succeed())
+			Expect(deprecatedv1.AddToScheme(scheme)).To(Succeed())
 			{
 				var b bytes.Buffer
-				Expect(k8sjson.NewSerializer(k8sjson.DefaultMetaFactory, scheme, scheme, false).Encode(&pdb, &b)).To(Succeed())
+				Expect(k8sjson.NewSerializer(k8sjson.DefaultMetaFactory, scheme, scheme, false).Encode(&deprecated, &b)).To(Succeed())
 				manifest = b.String()
 			}
 
@@ -150,9 +151,9 @@ var _ = Describe("Install Plan", func() {
 						Resolving: csv.GetName(),
 						Status:    operatorsv1alpha1.StepStatusUnknown,
 						Resource: operatorsv1alpha1.StepResource{
-							Name:     pdb.GetName(),
-							Version:  pdb.APIVersion,
-							Kind:     pdb.Kind,
+							Name:     deprecated.GetName(),
+							Version:  "v1",
+							Kind:     "Deprecated",
 							Manifest: manifest,
 						},
 					},
@@ -168,6 +169,14 @@ var _ = Describe("Install Plan", func() {
 			Eventually(func() error {
 				return client.IgnoreNotFound(ctx.Ctx().Client().Delete(context.Background(), &csv))
 			}).Should(Succeed())
+			Eventually(func() error {
+				deprecatedCRD := &apiextensionsv1.CustomResourceDefinition{
+					ObjectMeta: metav1.ObjectMeta{
+						Name: "deprecateds.operators.io.operator-framework",
+					},
+				}
+				return client.IgnoreNotFound(ctx.Ctx().Client().Delete(context.Background(), deprecatedCRD))
+			}).Should(Succeed())
 		})
 
 		It("creates an Event surfacing the deprecation warning", func() {
@@ -200,9 +209,8 @@ var _ = Describe("Install Plan", func() {
 					FieldPath:  "status.plan[0]",
 				},
 				Reason:  "AppliedWithWarnings",
-				Message: fmt.Sprintf("1 warning(s) generated during installation of operator \"%s\" (PodDisruptionBudget \"%s\"): policy/v1beta1 PodDisruptionBudget is deprecated in v1.21+, unavailable in v1.25+; use policy/v1 PodDisruptionBudget", csv.GetName(), pdb.GetName()),
+				Message: fmt.Sprintf("1 warning(s) generated during installation of operator \"%s\" (Deprecated \"%s\"): operators.io.operator-framework/v1 Deprecated is deprecated", csv.GetName(), deprecated.GetName()),
 			}))
-
 		})
 
 		It("increments a metric counting the warning", func() {

test/e2e/testdata/deprecated-crd/deprecated.crd.yaml

@@ -0,0 +1,35 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    e2e.testName: Install Plan when an InstallPlan step contains a deprecated resource
+      version increments a metric counting the warning
+  name: deprecateds.operators.io.operator-framework
+spec:
+  conversion:
+    strategy: None
+  group: operators.io.operator-framework
+  names:
+    kind: Deprecated
+    listKind: DeprecatedList
+    plural: deprecateds
+    singular: deprecated
+  scope: Namespaced
+  versions:
+  - deprecated: true
+    name: v1
+    schema:
+      openAPIV3Schema:
+        properties:
+          spec:
+            description: Spec of a test object.
+            properties:
+              foo:
+                type: string
+            type: object
+          status:
+            description: Spec of a test object.
+            type: object
+        type: object
+    served: true
+    storage: true

test/e2e/util/decode.go

@@ -0,0 +1,27 @@
+package util
+
+import (
+	"os"
+	"strings"
+
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/controller-runtime/client"
+	utilyaml "k8s.io/apimachinery/pkg/util/yaml"
+)
+
+func DecodeFile(file string, to client.Object) (client.Object, error) {
+	manifest, err := yamlFromFilePath(file)
+	if err != nil {
+		return nil, err
+	}
+	dec := utilyaml.NewYAMLOrJSONDecoder(strings.NewReader(manifest), 10)
+	if err := dec.Decode(to); err != nil {
+		return nil, err
+	}
+
+	return to, nil
+}
+
+func yamlFromFilePath(fileName string) (string, error) {
+	yaml, err := os.ReadFile(fileName)
+	return string(yaml), err
+}