Merge pull request #1699 from dinhxuanvu/deprecated-filter

feat(resolver): filtering deprecated bundles in resolver

Author: openshift-merge-robot

pkg/controller/registry/resolver/cache.go

@@ -371,6 +371,9 @@ type OperatorPredicate func(*Operator) bool
 func (s *CatalogSnapshot) Find(p ...OperatorPredicate) []*Operator {
 	s.m.RLock()
 	defer s.m.RUnlock()
+	if len(p) > 0 {
+		p = append(p, WithoutDeprecatedProperty())
+	}
 	return Filter(s.operators, p...)
 }
 
@@ -416,6 +419,17 @@ func WithPackage(pkg string) OperatorPredicate {
 	}
 }
 
+func WithoutDeprecatedProperty() OperatorPredicate {
+	return func(o *Operator) bool {
+		for _, p := range o.bundle.GetProperties() {
+			if p.GetType() == string(opregistry.DeprecatedType) {
+				return false
+			}
+		}
+		return true
+	}
+}
+
 func WithVersionInRange(r semver.Range) OperatorPredicate {
 	return func(o *Operator) bool {
 		return o.version != nil && r(*o.version)

pkg/controller/registry/resolver/cache_test.go

@@ -314,7 +314,7 @@ func TestStripPluralRequiredAndProvidedAPIKeys(t *testing.T) {
 						Kind:    "K",
 						Plural:  "ks",
 					}: {},
-				}, nil),
+				}, nil, false),
 				Dependencies: apiSetToDependencies(map[opregistry.APIKey]struct{}{
 					{
 						Group:   "g2",

pkg/controller/registry/resolver/resolver.go

@@ -297,6 +297,7 @@ func (r *SatResolver) getBundleInstallables(catalog registry.CatalogKey, predica
 			errs = append(errs, err)
 			continue
 		}
+
 		for _, d := range dependencyPredicates {
 			// errors ignored; this will build an empty/unsatisfiable dependency if no candidates are found
 			candidateBundles, _ := AtLeast(1, namespacedCache.FindPreferred(&bundle.sourceInfo.Catalog, d))

pkg/controller/registry/resolver/resolver_test.go

@@ -215,7 +215,7 @@ func apiSetToDependencies(crds, apis APISet) (out []*api.Dependency) {
 	return
 }
 
-func apiSetToProperties(crds, apis APISet) (out []*api.Property) {
+func apiSetToProperties(crds, apis APISet, deprecated bool) (out []*api.Property) {
 	out = make([]*api.Property, 0)
 	for a := range crds {
 		val, err := json.Marshal(opregistry.GVKProperty{
@@ -245,6 +245,16 @@ func apiSetToProperties(crds, apis APISet) (out []*api.Property) {
 			Value: string(val),
 		})
 	}
+	if deprecated {
+		val, err := json.Marshal(opregistry.DeprecatedProperty{})
+		if err != nil {
+			panic(err)
+		}
+		out = append(out, &api.Property{
+			Type:  opregistry.DeprecatedType,
+			Value: string(val),
+		})
+	}
 	if len(out) == 0 {
 		return nil
 	}
@@ -297,7 +307,7 @@ func bundle(name, pkg, channel, replaces string, providedCRDs, requiredCRDs, pro
 		RequiredApis: apiSetToGVK(requiredCRDs, requiredAPIServices),
 		Replaces:     replaces,
 		Dependencies: apiSetToDependencies(requiredCRDs, requiredAPIServices),
-		Properties:   apiSetToProperties(providedCRDs, providedAPIServices),
+		Properties:   apiSetToProperties(providedCRDs, providedAPIServices, false),
 	}
 	for _, f := range opts {
 		f(b)

pkg/controller/registry/resolver/util_test.go

@@ -4,11 +4,12 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/ctx"
 	"strings"
 	"sync"
 	"time"
 
+	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/ctx"
+
 	"github.com/blang/semver"
 	. "github.com/onsi/ginkgo"
 	"github.com/onsi/ginkgo/extensions/table"