Merge pull request #1220 from ecordell/packagserver-labels

feat(packageserver): support label queries and copy CSV labels onto the package

Author: openshift-merge-robot

pkg/package-server/provider/interfaces.go

@@ -1,8 +1,11 @@
 package provider
 
-import "github.com/operator-framework/operator-lifecycle-manager/pkg/package-server/apis/operators"
+import (
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/package-server/apis/operators"
+	"k8s.io/apimachinery/pkg/labels"
+)
 
 type PackageManifestProvider interface {
 	Get(namespace, name string) (*operators.PackageManifest, error)
-	List(namespace string) (*operators.PackageManifestList, error)
+	List(namespace string, selector labels.Selector) (*operators.PackageManifestList, error)
 }

pkg/package-server/provider/labels.go

@@ -0,0 +1,30 @@
+package provider
+
+import "strings"
+
+const (
+	OsLabelPrefix    = "operatorframework.io/os"
+	ArchLabelPrefix  = "operatorframework.io/arch"
+	DefaultOsLabel   = "operatorframework.io/os.linux"
+	DefaultArchLabel = "operatorframework.io/arch.amd64"
+	Supported        = "supported"
+)
+
+func setDefaultOsArchLabels(labels map[string]string) {
+	needsOsLabel := true
+	needsArchLabel := true
+	for k := range labels {
+		if strings.HasPrefix(k, OsLabelPrefix) {
+			needsOsLabel = false
+		}
+		if strings.HasPrefix(k, ArchLabelPrefix) {
+			needsArchLabel = false
+		}
+	}
+	if needsOsLabel {
+		labels[DefaultOsLabel] = Supported
+	}
+	if needsArchLabel {
+		labels[DefaultArchLabel] = Supported
+	}
+}

pkg/package-server/provider/labels_test.go

@@ -0,0 +1,59 @@
+package provider
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestSetDefaultOsArchLabels(t *testing.T) {
+	type args struct {
+		labels map[string]string
+	}
+	tests := []struct {
+		name     string
+		args     args
+		expected map[string]string
+	}{
+		{
+			name: "NoneSet",
+			args: args{labels: map[string]string{}},
+			expected: map[string]string{
+				DefaultArchLabel: Supported,
+				DefaultOsLabel:   Supported,
+			},
+		},
+		{
+			name: "OthersPreserved",
+			args: args{labels: map[string]string{"other": "label"}},
+			expected: map[string]string{
+				"other":          "label",
+				DefaultArchLabel: Supported,
+				DefaultOsLabel:   Supported,
+			},
+		},
+		{
+			name: "OsSet",
+			args: args{labels: map[string]string{OsLabelPrefix + ".windows": Supported}},
+			expected: map[string]string{
+				DefaultArchLabel:           Supported,
+				OsLabelPrefix + ".windows": Supported,
+			},
+		},
+		{
+			name: "ArchSet",
+			args: args{labels: map[string]string{ArchLabelPrefix + ".arm": Supported}},
+			expected: map[string]string{
+				ArchLabelPrefix + ".arm": Supported,
+				DefaultOsLabel:           Supported,
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			labels := tt.args.labels
+			setDefaultOsArchLabels(labels)
+			require.Equal(t, tt.expected, labels)
+		})
+	}
+}

pkg/package-server/provider/registry.go

@@ -370,7 +370,7 @@ func (p *RegistryProvider) Get(namespace, name string) (*operators.PackageManife
 		"namespace": namespace,
 	})
 
-	pkgs, err := p.List(namespace)
+	pkgs, err := p.List(namespace, labels.Everything())
 	if err != nil {
 		return nil, fmt.Errorf("could not list packages in namespace %s", namespace)
 	}
@@ -385,7 +385,7 @@ func (p *RegistryProvider) Get(namespace, name string) (*operators.PackageManife
 	return nil, nil
 }
 
-func (p *RegistryProvider) List(namespace string) (*operators.PackageManifestList, error) {
+func (p *RegistryProvider) List(namespace string, selector labels.Selector) (*operators.PackageManifestList, error) {
 	var pkgs []*operators.PackageManifest
 	if namespace == metav1.NamespaceAll {
 		all, err := p.pkgLister.List(labels.Everything())
@@ -394,14 +394,14 @@ func (p *RegistryProvider) List(namespace string) (*operators.PackageManifestLis
 		}
 		pkgs = append(pkgs, all...)
 	} else {
-		nsPkgs, err := p.pkgLister.PackageManifests(namespace).List(labels.Everything())
+		nsPkgs, err := p.pkgLister.PackageManifests(namespace).List(selector)
 		if err != nil {
 			return nil, err
 		}
 		pkgs = append(pkgs, nsPkgs...)
 
 		if namespace != p.globalNamespace {
-			globalPkgs, err := p.pkgLister.PackageManifests(p.globalNamespace).List(labels.Everything())
+			globalPkgs, err := p.pkgLister.PackageManifests(p.globalNamespace).List(selector)
 			if err != nil {
 				return nil, err
 			}
@@ -448,6 +448,7 @@ func newPackageManifest(ctx context.Context, logger *logrus.Entry, pkg *api.Pack
 	var (
 		providerSet   bool
 		defaultElided bool
+		defaultCsv    *operatorsv1alpha1.ClusterServiceVersion
 	)
 	for _, pkgChannel := range pkgChannels {
 		bundle, err := client.GetBundleForChannel(ctx, &api.GetBundleInChannelRequest{PkgName: pkg.GetName(), ChannelName: pkgChannel.GetName()})
@@ -464,6 +465,9 @@ func newPackageManifest(ctx context.Context, logger *logrus.Entry, pkg *api.Pack
 			defaultElided = defaultElided || pkgChannel.Name == manifest.Status.DefaultChannel
 			continue
 		}
+		if defaultCsv == nil || pkgChannel.GetName() == manifest.Status.DefaultChannel {
+			defaultCsv = &csv
+		}
 		manifest.Status.Channels = append(manifest.Status.Channels, operators.PackageChannel{
 			Name:           pkgChannel.GetName(),
 			CurrentCSV:     csv.GetName(),
@@ -489,6 +493,11 @@ func newPackageManifest(ctx context.Context, logger *logrus.Entry, pkg *api.Pack
 		logger.Warn("default channel elided, setting as first in packagemanifest")
 		manifest.Status.DefaultChannel = manifest.Status.Channels[0].Name
 	}
-
+	manifestLabels := manifest.GetLabels()
+	for k, v := range defaultCsv.GetLabels() {
+		manifestLabels[k] = v
+	}
+	setDefaultOsArchLabels(manifestLabels)
+	manifest.SetLabels(manifestLabels)
 	return manifest, nil
 }

pkg/package-server/provider/registry_test.go

@@ -4,10 +4,11 @@ import (
 	"context"
 	"fmt"
 
+	"k8s.io/apimachinery/pkg/fields"
+
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	metainternalversion "k8s.io/apimachinery/pkg/apis/meta/internalversion"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/fields"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -73,19 +74,18 @@ func (m *PackageManifestStorage) List(ctx context.Context, options *metainternal
 		return nil, err
 	}
 
-	res, err := m.prov.List(namespace)
+	res, err := m.prov.List(namespace, labelSelector)
 	if err != nil {
 		return nil, k8serrors.NewInternalError(err)
 	}
 
-	// Filter by label selector
 	filtered := []operators.PackageManifest{}
 	for _, manifest := range res.Items {
-		if matches(manifest, name, labelSelector) {
+		if matches(manifest, name) {
 			filtered = append(filtered, manifest)
 		}
 	}
-	// Strip logo icons
+
 	for i := range filtered {
 		for j := range filtered[i].Status.Channels {
 			filtered[i].Status.Channels[j].CurrentCSVDesc.Icon = []operators.Icon{}
@@ -129,9 +129,9 @@ func nameFor(fs fields.Selector) (string, error) {
 	return name, nil
 }
 
-func matches(pm operators.PackageManifest, name string, ls labels.Selector) bool {
+func matches(pm operators.PackageManifest, name string) bool {
 	if name == "" {
 		name = pm.GetName()
 	}
-	return ls.Matches(labels.Set(pm.GetLabels())) && pm.GetName() == name
+	return pm.GetName() == name
 }

pkg/package-server/storage/reststorage.go

@@ -6,6 +6,8 @@ import (
 	"net/http/httptest"
 	"testing"
 
+	"k8s.io/apimachinery/pkg/labels"
+
 	"github.com/stretchr/testify/require"
 
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/package-server/apis/operators"
@@ -25,7 +27,7 @@ func (p *fakeProvider) Get(namespace, name string) (*operators.PackageManifest,
 	return p.packages[0], nil
 }
 
-func (p *fakeProvider) List(namespace string) (*operators.PackageManifestList, error) {
+func (p *fakeProvider) List(namespace string, selector labels.Selector) (*operators.PackageManifestList, error) {
 	return &operators.PackageManifestList{}, nil
 }
 

pkg/package-server/storage/subresources_test.go

@@ -66,7 +66,7 @@ func TestPackageManifestLoading(t *testing.T) {
 	catalogSourceName := genName("mock-ocs")
 	namedStrategy := newNginxInstallStrategy(genName("dep-"), nil, nil)
 	csv := newCSV(packageStable, testNamespace, "", semver.MustParse("0.1.0"), []apiextensions.CustomResourceDefinition{crd}, nil, namedStrategy)
-
+	csv.SetLabels(map[string]string{"projected": "label"})
 	c := newKubeClient(t)
 	crc := newCRClient(t)
 	pmc := newPMClient(t)
@@ -108,6 +108,9 @@ func TestPackageManifestLoading(t *testing.T) {
 	require.NotNil(t, pm)
 	require.Equal(t, packageName, pm.GetName())
 	require.Equal(t, expectedStatus, pm.Status)
+	require.Equal(t, "label", pm.GetLabels()["projected"])
+	require.Equal(t, "supported", pm.GetLabels()["operatorframework.io/arch.amd64"])
+	require.Equal(t, "supported", pm.GetLabels()["operatorframework.io/os.linux"])
 
 	// Get a PackageManifestList and ensure it has the correct items
 	pmList, err := pmc.OperatorsV1().PackageManifests(testNamespace).List(metav1.ListOptions{})