Merge pull request #1571 from dinhxuanvu/ocs-fix-4.3

[release-4.3] Bug 1843694: fix(resolver): don't pick operator from same package when resolve requiredAPI

Author: openshift-merge-robot

pkg/controller/registry/grpc/source.go

@@ -9,8 +9,8 @@ import (
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/connectivity"
 
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver"
-	"github.com/operator-framework/operator-registry/pkg/client"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -190,8 +190,8 @@ func (s *SourceStore) Remove(key resolver.CatalogKey) error {
 	return source.Conn.Close()
 }
 
-func (s *SourceStore) AsClients(globalNamespace, localNamespace string) map[resolver.CatalogKey]client.Interface {
-	refs := map[resolver.CatalogKey]client.Interface{}
+func (s *SourceStore) AsClients(globalNamespace, localNamespace string) map[resolver.CatalogKey]registry.ClientInterface {
+	refs := map[resolver.CatalogKey]registry.ClientInterface{}
 	s.sourcesLock.RLock()
 	defer s.sourcesLock.RUnlock()
 	for key, source := range s.sources {
@@ -201,7 +201,7 @@ func (s *SourceStore) AsClients(globalNamespace, localNamespace string) map[reso
 		if source.LastConnect.IsZero() {
 			continue
 		}
-		refs[key] = client.NewClientFromConn(source.Conn)
+		refs[key] = registry.NewClientFromConn(source.Conn)
 	}
 
 	// TODO : remove unhealthy

pkg/controller/registry/registry_client.go

@@ -0,0 +1,121 @@
+//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -o resolver/fakes/fake_registry_client_interface.go . ClientInterface
+package registry
+
+import (
+	"context"
+	"fmt"
+	"io"
+
+	"google.golang.org/grpc"
+
+	registryapi "github.com/operator-framework/operator-registry/pkg/api"
+	"github.com/operator-framework/operator-registry/pkg/client"
+	opregistry "github.com/operator-framework/operator-registry/pkg/registry"
+)
+
+// ChannelEntryStream interface
+type ChannelEntryStream interface {
+	Recv() (*registryapi.ChannelEntry, error)
+}
+
+// ClientInterface that extends client.Interface
+type ClientInterface interface {
+	client.Interface
+	FindBundleThatProvides(ctx context.Context, group, version, kind, excludedPkgName string) (*registryapi.Bundle, error)
+	GetLatestChannelEntriesThatProvide(ctx context.Context, group, version, kind string) (*ChannelEntryIterator, error)
+}
+
+// ChannelEntryIterator struct
+type ChannelEntryIterator struct {
+	stream ChannelEntryStream
+	error  error
+}
+
+// NewChannelEntryIterator returns a new ChannelEntryIterator
+func NewChannelEntryIterator(stream ChannelEntryStream) *ChannelEntryIterator {
+	return &ChannelEntryIterator{stream: stream}
+}
+
+// Next returns the next Channel Entry in the grpc stream
+func (ceit *ChannelEntryIterator) Next() *registryapi.ChannelEntry {
+	if ceit.error != nil {
+		return nil
+	}
+	next, err := ceit.stream.Recv()
+	if err == io.EOF {
+		return nil
+	}
+	if err != nil {
+		ceit.error = err
+	}
+	return next
+}
+
+func (ceit *ChannelEntryIterator) Error() error {
+	return ceit.error
+}
+
+// Client struct with a registry client embedded
+type Client struct {
+	*client.Client
+}
+
+// NewClientFromConn returns the next Channel Entry in the grpc stream
+func NewClientFromConn(conn *grpc.ClientConn) *Client {
+	return &Client{
+		Client: client.NewClientFromConn(conn),
+	}
+}
+
+var _ ClientInterface = &Client{}
+
+// GetLatestChannelEntriesThatProvide uses registry client to get a list of
+// latest channel entries that provide the requested API (via an iterator)
+func (rc *Client) GetLatestChannelEntriesThatProvide(ctx context.Context, group, version, kind string) (*ChannelEntryIterator, error) {
+	stream, err := rc.Client.Registry.GetLatestChannelEntriesThatProvide(ctx, &registryapi.GetLatestProvidersRequest{Group: group, Version: version, Kind: kind})
+	if err != nil {
+		return nil, err
+	}
+	return NewChannelEntryIterator(stream), nil
+}
+
+// FindBundleThatProvides returns a bundle that provides the request API and
+// doesn't belong to the provided package
+func (rc *Client) FindBundleThatProvides(ctx context.Context, group, version, kind, excludedPkgName string) (*registryapi.Bundle, error) {
+	it, err := rc.GetLatestChannelEntriesThatProvide(ctx, group, version, kind)
+	if err != nil {
+		return nil, err
+	}
+	entry := rc.filterChannelEntries(it, excludedPkgName)
+	if entry == nil {
+		return nil, fmt.Errorf("Unable to find a channel entry which doesn't belong to package %s", excludedPkgName)
+	}
+	bundle, err := rc.Client.Registry.GetBundle(ctx, &registryapi.GetBundleRequest{PkgName: entry.PackageName, ChannelName: entry.ChannelName, CsvName: entry.BundleName})
+	if err != nil {
+		return nil, err
+	}
+	return bundle, nil
+}
+
+// FilterChannelEntries filters out a channel entries that provide the requested
+// API and come from the same package with original operator and returns the
+// first entry on the list
+func (rc *Client) filterChannelEntries(it *ChannelEntryIterator, excludedPkgName string) *opregistry.ChannelEntry {
+	var entries []*opregistry.ChannelEntry
+	for e := it.Next(); e != nil; e = it.Next() {
+		if e.PackageName != excludedPkgName {
+			entry := &opregistry.ChannelEntry{
+				PackageName: e.PackageName,
+				ChannelName: e.ChannelName,
+				BundleName:  e.BundleName,
+				Replaces:    e.Replaces,
+			}
+			entries = append(entries, entry)
+		}
+	}
+
+	if entries != nil {
+		return entries[0]
+	}
+	return nil
+}

pkg/controller/registry/resolver/evolver.go

@@ -130,14 +130,14 @@ func (e *NamespaceGenerationEvolver) queryForRequiredAPIs() error {
 		e.gen.MarkAPIChecked(*api)
 
 		// identify the initialSource
-		initialSource := CatalogKey{}
+		var initialSource *OperatorSourceInfo
 		for _, operator := range e.gen.MissingAPIs()[*api] {
-			initialSource = operator.SourceInfo().Catalog
+			initialSource = operator.SourceInfo()
 			break
 		}
 
 		// attempt to find a bundle that provides that api
-		if bundle, key, err := e.querier.FindProvider(*api, initialSource); err == nil {
+		if bundle, key, err := e.querier.FindProvider(*api, initialSource.Catalog, initialSource.Package); err == nil {
 			// add a bundle that provides the api to the generation
 			o, err := NewOperatorFromBundle(bundle, "", "", *key)
 			if err != nil {