Skip to content

Bug 1989712: Fix for resolution error on channels with deprecated inner entries. #2313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2021
Merged

Bug 1989712: Fix for resolution error on channels with deprecated inner entries. #2313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions pkg/controller/registry/resolver/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,9 +392,6 @@ 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...)
}

Expand Down Expand Up @@ -453,17 +450,6 @@ func WithPackage(pkg string) OperatorPredicate {
}
}

func WithoutDeprecatedProperty() OperatorPredicate {
return func(o *Operator) bool {
for _, p := range o.bundle.GetProperties() {
if p.GetType() == opregistry.DeprecatedType {
return false
}
}
return true
}
}

Comment on lines -456 to -466
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we removing this code block? I might be missing something obvious, but I didn't see anything in the 4.8 PR for removing fields from this cache package. Just want to rule out whether this is an artifact of the cherry-pick failing and rebase being needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to that block of code in the 4.8 PR: https://github.com/operator-framework/operator-lifecycle-manager/pull/2104/files#diff-5311e3f964b627fa6618423cf9e1ce3f7c84530d3045b93365f1102cea3280b8R464.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deprecated properties are handled by the solver instead: https://github.com/operator-framework/operator-lifecycle-manager/pull/2313/files/40187e79db7ab1b5fb4b66bcecce198a03f8313f#diff-2c070869d0e7b6bf96c69fbdcde88e430d5d8781e047c1d96cb22ee0967c0111R64-R72

func WithVersionInRange(r semver.Range) OperatorPredicate {
return func(o *Operator) bool {
for _, p := range o.Properties() {
Expand Down
19 changes: 19 additions & 0 deletions pkg/controller/registry/resolver/installabletypes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (

"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/solver"
operatorregistry "github.com/operator-framework/operator-registry/pkg/registry"
)

type BundleInstallable struct {
Expand Down Expand Up @@ -54,6 +55,24 @@ func bundleId(bundle, channel string, catalog registry.CatalogKey) solver.Identi
return solver.IdentifierFromString(fmt.Sprintf("%s/%s/%s", catalog.String(), channel, bundle))
}

func NewBundleInstallableFromOperator(o *Operator) (BundleInstallable, error) {
src := o.SourceInfo()
if src == nil {
return BundleInstallable{}, fmt.Errorf("unable to resolve the source of bundle %s", o.Identifier())
}
var constraints []solver.Constraint
for _, p := range o.bundle.GetProperties() {
if p.GetType() == operatorregistry.DeprecatedType {
constraints = append(constraints, PrettyConstraint(
solver.Prohibited(),
fmt.Sprintf("bundle %s is deprecated", bundleId(o.Identifier(), o.Channel(), src.Catalog)),
))
break
}
}
return NewBundleInstallable(o.Identifier(), o.Channel(), src.Catalog, constraints...), nil
}

func NewBundleInstallable(bundle, channel string, catalog registry.CatalogKey, constraints ...solver.Constraint) BundleInstallable {
return BundleInstallable{
identifier: bundleId(bundle, channel, catalog),
Expand Down
19 changes: 7 additions & 12 deletions pkg/controller/registry/resolver/resolver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,19 +294,17 @@ func (r *SatResolver) getBundleInstallables(catalog registry.CatalogKey, predica
bundle := bundleStack[len(bundleStack)-1]
bundleStack = bundleStack[:len(bundleStack)-1]

bundleSource := bundle.SourceInfo()
if bundleSource == nil {
err := fmt.Errorf("unable to resolve the source of bundle %s, invalid cache", bundle.Identifier())
errs = append(errs, err)
if b, ok := visited[bundle]; ok {
installables[b.identifier] = b
continue
}

if b, ok := visited[bundle]; ok {
installables[b.identifier] = b
bundleInstallable, err := NewBundleInstallableFromOperator(bundle)
if err != nil {
errs = append(errs, err)
continue
}

bundleInstallable := NewBundleInstallable(bundle.Identifier(), bundle.Channel(), bundleSource.Catalog)
visited[bundle] = &bundleInstallable

dependencyPredicates, err := bundle.DependencyPredicates()
Expand Down Expand Up @@ -348,14 +346,11 @@ func (r *SatResolver) getBundleInstallables(catalog registry.CatalogKey, predica
// (after sorting) to remove all bundles that
// don't satisfy the dependency.
for _, b := range Filter(sortedBundles, d) {
src := b.SourceInfo()
if src == nil {
err := fmt.Errorf("unable to resolve the source of bundle %s, invalid cache", bundle.Identifier())
i, err := NewBundleInstallableFromOperator(b)
if err != nil {
errs = append(errs, err)
continue
}

i := NewBundleInstallable(b.Identifier(), b.Channel(), src.Catalog)
installables[i.Identifier()] = &i
bundleDependencies = append(bundleDependencies, i.Identifier())
bundleStack = append(bundleStack, b)
Expand Down
38 changes: 33 additions & 5 deletions pkg/controller/registry/resolver/resolver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1335,19 +1335,18 @@ func stripBundle(o *Operator) *Operator {
}

func TestSolveOperators_WithoutDeprecated(t *testing.T) {
namespace := "olm"
catalog := registry.CatalogKey{"community", namespace}
catalog := registry.CatalogKey{Name: "catalog", Namespace: "namespace"}

subs := []*v1alpha1.Subscription{
newSub(namespace, "packageA", "alpha", catalog),
newSub(catalog.Namespace, "packageA", "alpha", catalog),
}

fakeNamespacedOperatorCache := NamespacedOperatorCache{
snapshots: map[registry.CatalogKey]*CatalogSnapshot{
catalog: {
key: catalog,
operators: []*Operator{
genOperator("packageA.v1", "0.0.1", "packageA.v1", "packageA", "alpha", "community", "olm", nil, nil, nil, "", true),
genOperator("packageA.v1", "0.0.1", "packageA.v1", "packageA", "alpha", catalog.Name, catalog.Namespace, nil, nil, nil, "", true),
},
},
},
Expand All @@ -1357,11 +1356,40 @@ func TestSolveOperators_WithoutDeprecated(t *testing.T) {
log: logrus.New(),
}

operators, err := satResolver.SolveOperators([]string{"olm"}, nil, subs)
operators, err := satResolver.SolveOperators([]string{catalog.Namespace}, nil, subs)
assert.Empty(t, operators)
assert.IsType(t, solver.NotSatisfiable{}, err)
}

func TestSolveOperatorsWithDeprecatedInnerChannelEntry(t *testing.T) {
catalog := registry.CatalogKey{Name: "catalog", Namespace: "namespace"}

subs := []*v1alpha1.Subscription{
newSub(catalog.Namespace, "a", "c", catalog),
}
logger, _ := test.NewNullLogger()
resolver := SatResolver{
cache: getFakeOperatorCache(NamespacedOperatorCache{
snapshots: map[registry.CatalogKey]*CatalogSnapshot{
catalog: {
key: catalog,
operators: []*Operator{
genOperator("a-1", "1.0.0", "", "a", "c", catalog.Name, catalog.Namespace, nil, nil, nil, "", false),
genOperator("a-2", "2.0.0", "a-1", "a", "c", catalog.Name, catalog.Namespace, nil, nil, nil, "", true),
genOperator("a-3", "3.0.0", "a-2", "a", "c", catalog.Name, catalog.Namespace, nil, nil, nil, "", false),
},
},
},
}),
log: logger,
}

operators, err := resolver.SolveOperators([]string{catalog.Namespace}, nil, subs)
assert.NoError(t, err)
assert.Len(t, operators, 1)
assert.Contains(t, operators, "a-3")
}

func TestSolveOperators_WithSkipsAndStartingCSV(t *testing.T) {
APISet := APISet{opregistry.APIKey{"g", "v", "k", "ks"}: struct{}{}}
Provides := APISet
Expand Down