Skip to content

Bug 1841171: Update PkgManifest upon catsrc update #1556

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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: 11 additions & 3 deletions pkg/package-server/provider/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"sync"
"time"

"github.com/operator-framework/operator-registry/pkg/api"
"github.com/sirupsen/logrus"
"google.golang.org/grpc"
"google.golang.org/grpc/connectivity"
Expand All @@ -29,6 +28,7 @@ import (
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/queueinformer"
"github.com/operator-framework/operator-lifecycle-manager/pkg/package-server/apis/operators"
pkglisters "github.com/operator-framework/operator-lifecycle-manager/pkg/package-server/client/listers/operators/internalversion"
"github.com/operator-framework/operator-registry/pkg/api"
)

const (
Expand Down Expand Up @@ -189,9 +189,17 @@ func (p *RegistryProvider) syncCatalogSource(obj interface{}) (syncError error)
Namespace: source.GetNamespace(),
Name: source.GetName(),
}

if sourceMeta := p.sources.GetMeta(key); sourceMeta != nil && sourceMeta.Address == address {
// If the address hasn't changed, don't bother creating a new source
logger.Debug("catalog address unchanged, skipping source creation")
logger.Infof("updating PackageManifest based on CatalogSource changes: %v", key)
timeout, cancel := context.WithTimeout(context.Background(), cacheTimeout)
defer cancel()
var client *registryClient
client, syncError = p.registryClient(key)
if syncError != nil {
return
}
syncError = p.refreshCache(timeout, client)
return
}

Expand Down
58 changes: 58 additions & 0 deletions test/e2e/packagemanifest_e2e_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,61 @@ func TestPackageManifestLoading(t *testing.T) {
require.NotNil(t, pmList.ListMeta, "package manifest list metadata empty")
require.NotNil(t, pmList.Items)
}

func TestPkgManifestsFromCatsrc(t *testing.T) {
defer cleaner.NotifyTestComplete(t, true)

sourceName := genName("catalog-")
packageName := "etcd-test"
displayName := "etcd test catalog"
image := "quay.io/olmtest/catsrc-update-test:related"
crc := newCRClient(t)
pmc := newPMClient(t)

catalogSource := &v1alpha1.CatalogSource{
TypeMeta: metav1.TypeMeta{
Kind: v1alpha1.CatalogSourceKind,
APIVersion: v1alpha1.CatalogSourceCRDAPIVersion,
},
ObjectMeta: metav1.ObjectMeta{
Name: sourceName,
Namespace: testNamespace,
Labels: map[string]string{"olm.catalogSource": sourceName},
},
Spec: v1alpha1.CatalogSourceSpec{
SourceType: v1alpha1.SourceTypeGrpc,
Image: image,
DisplayName: displayName,
},
}

catalogSource, err := crc.OperatorsV1alpha1().CatalogSources(catalogSource.GetNamespace()).Create(catalogSource)
require.NoError(t, err, "error creating Catalog Sources")
require.NotNil(t, catalogSource)

pm, err := fetchPackageManifest(t, pmc, testNamespace, packageName, packageManifestHasStatus)
require.NoError(t, err, "error getting package manifest")
require.NotNil(t, pm)
require.Equal(t, packageName, pm.GetName())
require.Equal(t, displayName, pm.Status.CatalogSourceDisplayName)

catalogSource, err = crc.OperatorsV1alpha1().CatalogSources(testNamespace).Get(catalogSource.GetName(), metav1.GetOptions{})
require.NoError(t, err, "error getting catalogSource")

displayName = "updated Name"
catalogSource.Spec.DisplayName = displayName
catalogSource, err = crc.OperatorsV1alpha1().CatalogSources(testNamespace).Update(catalogSource)
require.NoError(t, err, "error updating catalogSource")
require.Equal(t, displayName, catalogSource.Spec.DisplayName)

// waiting for the update to complete
err = wait.Poll(pollInterval, 1*time.Minute, func() (bool, error) {
t.Logf("Polling package-server...")
pm, err := fetchPackageManifest(t, pmc, testNamespace, packageName, packageManifestHasStatus)
if err != nil {
return false, err
}
return pm.Status.CatalogSourceDisplayName == displayName, nil
})
require.NoError(t, err, "error package manifest Status.CatalogSourceDisplayName is not updated to catsrc Spec.DisplayName")
}