add olm variable source

Signed-off-by: perdasilva <[email protected]>

Author: perdasilva

internal/resolution/variable_sources/olm/olm.go

@@ -0,0 +1,37 @@
+package olm
+
+import (
+	"context"
+
+	"github.com/operator-framework/deppy/pkg/deppy"
+	"github.com/operator-framework/deppy/pkg/deppy/input"
+
+	"github.com/operator-framework/operator-controller/internal/resolution/variable_sources/bundles_and_dependencies"
+	"github.com/operator-framework/operator-controller/internal/resolution/variable_sources/global_constraints"
+	"github.com/operator-framework/operator-controller/internal/resolution/variable_sources/required_package"
+)
+
+var _ input.VariableSource = &OLMVariableSource{}
+
+type OLMVariableSource struct {
+	packageNames []string
+}
+
+func NewOLMVariableSource(packageNames ...string) *OLMVariableSource {
+	return &OLMVariableSource{
+		packageNames: packageNames,
+	}
+}
+
+func (o *OLMVariableSource) GetVariables(ctx context.Context, entitySource input.EntitySource) ([]deppy.Variable, error) {
+	var inputVariableSources []input.VariableSource
+
+	// build required package variable sources
+	for _, packageName := range o.packageNames {
+		inputVariableSources = append(inputVariableSources, required_package.NewRequiredPackage(packageName))
+	}
+
+	// build variable source pipeline
+	variableSource := global_constraints.NewGlobalConstraintsVariableSource(bundles_and_dependencies.NewBundlesAndDepsVariableSource(inputVariableSources...))
+	return variableSource.GetVariables(ctx, entitySource)
+}

internal/resolution/variable_sources/olm/olm_test.go

@@ -0,0 +1,156 @@
+package olm_test
+
+import (
+	"context"
+	"fmt"
+	"sort"
+	"strings"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	"github.com/operator-framework/deppy/pkg/deppy"
+	"github.com/operator-framework/deppy/pkg/deppy/input"
+	"github.com/operator-framework/operator-controller/internal/resolution/variable_sources/bundles_and_dependencies"
+	"github.com/operator-framework/operator-controller/internal/resolution/variable_sources/global_constraints"
+	"github.com/operator-framework/operator-controller/internal/resolution/variable_sources/olm"
+	"github.com/operator-framework/operator-controller/internal/resolution/variable_sources/required_package"
+)
+
+func TestGlobalConstraints(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "OLMVariableSource Suite")
+}
+
+var testEntityCache = map[deppy.Identifier]input.Entity{
+	"operatorhub/prometheus/0.37.0": *input.NewEntity("operatorhub/prometheus/0.37.0", map[string]string{
+		"olm.bundle.path": `"quay.io/operatorhubio/prometheus@sha256:3e281e587de3d03011440685fc4fb782672beab044c1ebadc42788ce05a21c35"`,
+		"olm.channel":     "{\"channelName\":\"beta\",\"priority\":0,\"replaces\":\"prometheusoperator.0.32.0\"}",
+		"olm.gvk":         "[{\"group\":\"monitoring.coreos.com\",\"kind\":\"Alertmanager\",\"version\":\"v1\"}, {\"group\":\"monitoring.coreos.com\",\"kind\":\"Prometheus\",\"version\":\"v1\"}]",
+		"olm.package":     "{\"packageName\":\"prometheus\",\"version\":\"0.37.0\"}",
+	}),
+	"operatorhub/prometheus/0.47.0": *input.NewEntity("operatorhub/prometheus/0.47.0", map[string]string{
+		"olm.bundle.path": `"quay.io/operatorhubio/prometheus@sha256:5b04c49d8d3eff6a338b56ec90bdf491d501fe301c9cdfb740e5bff6769a21ed"`,
+		"olm.channel":     "{\"channelName\":\"beta\",\"priority\":0,\"replaces\":\"prometheusoperator.0.37.0\"}",
+		"olm.gvk":         "[{\"group\":\"monitoring.coreos.com\",\"kind\":\"Alertmanager\",\"version\":\"v1\"}, {\"group\":\"monitoring.coreos.com\",\"kind\":\"Prometheus\",\"version\":\"v1alpha1\"}]",
+		"olm.package":     "{\"packageName\":\"prometheus\",\"version\":\"0.47.0\"}",
+	}),
+	"operatorhub/packageA/2.0.0": *input.NewEntity("operatorhub/packageA/2.0.0", map[string]string{
+		"olm.bundle.path": `"foo.io/packageA/packageA:v2.0.0"`,
+		"olm.channel":     "{\"channelName\":\"stable\",\"priority\":0}",
+		"olm.gvk":         "[{\"group\":\"foo.io\",\"kind\":\"Foo\",\"version\":\"v1\"}]",
+		"olm.package":     "{\"packageName\":\"packageA\",\"version\":\"2.0.0\"}",
+	}),
+}
+
+func entityFromCache(name string) *input.Entity {
+	entity := testEntityCache[deppy.IdentifierFromString(name)]
+	return &entity
+}
+
+var _ = Describe("OLMVariableSource", func() {
+	var testEntitySource input.EntitySource
+
+	BeforeEach(func() {
+		testEntitySource = input.NewCacheQuerier(testEntityCache)
+	})
+
+	It("should produce RequiredPackage variables", func() {
+		olmVariableSource := olm.NewOLMVariableSource("prometheus", "packageA")
+		variables, err := olmVariableSource.GetVariables(context.Background(), testEntitySource)
+		Expect(err).ToNot(HaveOccurred())
+
+		packageRequiredVariables := filterVariables[*required_package.RequiredPackageVariable](variables)
+		Expect(packageRequiredVariables).To(HaveLen(2))
+		Expect(packageRequiredVariables[0].Identifier()).To(Equal(deppy.IdentifierFromString("required package prometheus")))
+		Expect(packageRequiredVariables[0].BundleEntities()).To(HaveLen(2))
+		Expect(packageRequiredVariables[1].Identifier()).To(Equal(deppy.IdentifierFromString("required package packageA")))
+		Expect(packageRequiredVariables[1].BundleEntities()).To(HaveLen(1))
+	})
+
+	It("should produce BundleVariables variables", func() {
+		olmVariableSource := olm.NewOLMVariableSource("prometheus", "packageA")
+		variables, err := olmVariableSource.GetVariables(context.Background(), testEntitySource)
+		Expect(err).ToNot(HaveOccurred())
+
+		bundleVariables := filterVariables[*bundles_and_dependencies.BundleVariable](variables)
+		Expect(bundleVariables).To(HaveLen(3))
+		Expect(bundleVariables).To(WithTransform(func(bvars []*bundles_and_dependencies.BundleVariable) []*input.Entity {
+			var out []*input.Entity
+			for _, variable := range bvars {
+				out = append(out, variable.BundleEntity().Entity)
+			}
+			return out
+		}, Equal([]*input.Entity{
+			entityFromCache("operatorhub/prometheus/0.47.0"),
+			entityFromCache("operatorhub/prometheus/0.37.0"),
+			entityFromCache("operatorhub/packageA/2.0.0"),
+		})))
+	})
+
+	It("should produce GlobalConstraints variables", func() {
+		olmVariableSource := olm.NewOLMVariableSource("prometheus", "packageA")
+		variables, err := olmVariableSource.GetVariables(context.Background(), testEntitySource)
+		Expect(err).ToNot(HaveOccurred())
+
+		globalConstraintsVariables := filterVariables[*global_constraints.GlobalConstraintsVariable](variables)
+		Expect(globalConstraintsVariables).To(HaveLen(6))
+
+		// check global variables have the right names
+		Expect(globalConstraintsVariables).To(WithTransform(func(gvars []*global_constraints.GlobalConstraintsVariable) []string {
+			var out []string
+			for _, variable := range gvars {
+				out = append(out, string(variable.Identifier()))
+			}
+			sort.SliceStable(out, func(i, j int) bool {
+				return strings.Compare(out[i], out[j]) < 0
+			})
+			return out
+		}, Equal([]string{
+			"group:\"foo.io\" version:\"v1\" kind:\"Foo\" gvk uniqueness",
+			"group:\"monitoring.coreos.com\" version:\"v1\" kind:\"Alertmanager\" gvk uniqueness",
+			"group:\"monitoring.coreos.com\" version:\"v1\" kind:\"Prometheus\" gvk uniqueness",
+			"group:\"monitoring.coreos.com\" version:\"v1alpha1\" kind:\"Prometheus\" gvk uniqueness",
+			"packageA package uniqueness",
+			"prometheus package uniqueness",
+		})))
+	})
+
+	It("should return an errors when they occur", func() {
+		olmVariableSource := olm.NewOLMVariableSource("prometheus", "packageA")
+		_, err := olmVariableSource.GetVariables(context.Background(), FailEntitySource{})
+		Expect(err).To(HaveOccurred())
+	})
+})
+
+var _ input.EntitySource = &FailEntitySource{}
+
+type FailEntitySource struct {
+}
+
+func (f FailEntitySource) Get(ctx context.Context, id deppy.Identifier) *input.Entity {
+	return nil
+}
+
+func (f FailEntitySource) Filter(ctx context.Context, filter input.Predicate) (input.EntityList, error) {
+	return nil, fmt.Errorf("error executing filter")
+}
+
+func (f FailEntitySource) GroupBy(ctx context.Context, fn input.GroupByFunction) (input.EntityListMap, error) {
+	return nil, fmt.Errorf("error executing group by")
+}
+
+func (f FailEntitySource) Iterate(ctx context.Context, fn input.IteratorFunction) error {
+	return fmt.Errorf("error executing iterate")
+}
+
+func filterVariables[D deppy.Variable](variables []deppy.Variable) []D {
+	var out []D
+	for _, variable := range variables {
+		switch v := variable.(type) {
+		case D:
+			out = append(out, v)
+		}
+	}
+	return out
+}