Refactor FBC-related functions and structs into a utility module

Signed-off-by: Venkat Ramaraju <[email protected]>
Signed-off-by: rashmigottipati <[email protected]>

Author: rashmigottipati

internal/olm/fbcutil/util.go

@@ -0,0 +1,151 @@
+// Copyright 2022 The Operator-SDK Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package fbcutil
+
+import (
+	"bytes"
+	"context"
+	"errors"
+	"fmt"
+	"io/ioutil"
+	"os"
+
+	"github.com/operator-framework/operator-registry/alpha/action"
+	"github.com/operator-framework/operator-registry/alpha/declcfg"
+	declarativeconfig "github.com/operator-framework/operator-registry/alpha/declcfg"
+	"github.com/operator-framework/operator-registry/pkg/containertools"
+	registryutil "github.com/operator-framework/operator-sdk/internal/registry"
+	log "github.com/sirupsen/logrus"
+)
+
+const (
+	SchemaChannel  = "olm.channel"
+	SchemaPackage  = "olm.package"
+	DefaultChannel = "operator-sdk-run"
+)
+
+const (
+	// defaultIndexImageBase is the base for defaultIndexImage. It is necessary to separate
+	// them for string comparison when defaulting bundle add mode.
+	DefaultIndexImageBase = "quay.io/operator-framework/opm:"
+	// DefaultIndexImage is the index base image used if none is specified. It contains no bundles.
+	// TODO(v2.0.0): pin this image tag to a specific version.
+	DefaultIndexImage = DefaultIndexImageBase + "latest"
+)
+
+// BundleDeclcfg represents a minimal File-Based Catalog.
+// This struct only consists of one Package, Bundle, and Channel blob. It is used to
+// represent the bundle image in the File-Based Catalog format.
+type BundleDeclcfg struct {
+	Package declcfg.Package
+	Channel declcfg.Channel
+	Bundle  declcfg.Bundle
+}
+
+// FBCContext is a struct that stores all the required information while constructing
+// a new File-Based Catalog on the fly. The fields from this struct are passed as
+// parameters to Operator Registry API calls to generate declarative config objects.
+type FBCContext struct {
+	Package      string
+	ChannelName  string
+	Refs         []string
+	ChannelEntry declarativeconfig.ChannelEntry
+}
+
+// CreateFBC generates an FBC by creating bundle, package and channel blobs.
+func (f *FBCContext) CreateFBC(ctx context.Context) (BundleDeclcfg, error) {
+	var bundleDC BundleDeclcfg
+	// Rendering the bundle image into a declarative config format.
+	declcfg, err := RenderRefs(ctx, f.Refs)
+	if err != nil {
+		return BundleDeclcfg{}, err
+	}
+
+	// Ensuring a valid bundle size.
+	if len(declcfg.Bundles) != 1 {
+		return BundleDeclcfg{}, fmt.Errorf("bundle image should contain exactly one bundle blob")
+	}
+
+	bundleDC.Bundle = declcfg.Bundles[0]
+
+	// generate package.
+	bundleDC.Package = declarativeconfig.Package{
+		Schema:         SchemaPackage,
+		Name:           f.Package,
+		DefaultChannel: f.ChannelName,
+	}
+
+	// generate channel.
+	bundleDC.Channel = declarativeconfig.Channel{
+		Schema:  SchemaChannel,
+		Name:    f.ChannelName,
+		Package: f.Package,
+		Entries: []declarativeconfig.ChannelEntry{f.ChannelEntry},
+	}
+
+	return bundleDC, nil
+}
+
+// ValidateAndStringify first converts the generated declarative config to a model and validates it.
+// If the declarative config model is valid, it will convert the declarative config to a YAML string and return it.
+func ValidateAndStringify(declcfg *declarativeconfig.DeclarativeConfig) (string, error) {
+	// validates and converts declarative config to model
+	_, err := declarativeconfig.ConvertToModel(*declcfg)
+	if err != nil {
+		return "", fmt.Errorf("error converting the declarative config to model: %v", err)
+	}
+
+	var buf bytes.Buffer
+	err = declarativeconfig.WriteYAML(*declcfg, &buf)
+	if err != nil {
+		return "", fmt.Errorf("error writing generated declarative config to JSON encoder: %v", err)
+	}
+
+	if buf.String() == "" {
+		return "", errors.New("file-based catalog contents cannot be empty")
+	}
+
+	return buf.String(), nil
+}
+
+// RenderRefs will invoke Operator Registry APIs and return a declarative config object representation
+// of the references that are passed in as a string array.
+func RenderRefs(ctx context.Context, refs []string) (*declarativeconfig.DeclarativeConfig, error) {
+	render := action.Render{
+		Refs: refs,
+	}
+
+	log.SetOutput(ioutil.Discard)
+	declcfg, err := render.Run(ctx)
+	log.SetOutput(os.Stdout)
+	if err != nil {
+		return nil, fmt.Errorf("error in rendering the bundle and index image: %v", err)
+	}
+
+	return declcfg, nil
+}
+
+// IsFBC will determine if an index image uses the File-Based Catalog or SQLite index image format.
+// The default index image will adopt the File-Based Catalog format.
+func IsFBC(ctx context.Context, indexImage string) (bool, error) {
+	// adding updates to the IndexImageCatalogCreator if it is an FBC image
+	catalogLabels, err := registryutil.GetImageLabels(ctx, nil, indexImage, false)
+	if err != nil {
+		return false, fmt.Errorf("get index image labels: %v", err)
+	}
+	_, hasFBCLabel := catalogLabels[containertools.ConfigsLocationLabel]
+
+	return hasFBCLabel || indexImage == DefaultIndexImage, nil
+}

internal/olm/operator/bundle/install.go

@@ -27,11 +27,10 @@ import (
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
 	"github.com/operator-framework/operator-registry/alpha/action"
 	declarativeconfig "github.com/operator-framework/operator-registry/alpha/declcfg"
-	"github.com/operator-framework/operator-registry/pkg/containertools"
 	registrybundle "github.com/operator-framework/operator-registry/pkg/lib/bundle"
+	fbcutil "github.com/operator-framework/operator-sdk/internal/olm/fbcutil"
 	"github.com/operator-framework/operator-sdk/internal/olm/operator"
 	"github.com/operator-framework/operator-sdk/internal/olm/operator/registry"
-	registryutil "github.com/operator-framework/operator-sdk/internal/registry"
 )
 
 type Install struct {
@@ -54,7 +53,7 @@ func NewInstall(cfg *operator.Configuration) Install {
 }
 
 func (i *Install) BindFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&i.IndexImage, "index-image", registry.DefaultIndexImage, "index image in which to inject bundle")
+	fs.StringVar(&i.IndexImage, "index-image", fbcutil.DefaultIndexImage, "index image in which to inject bundle")
 	fs.Var(&i.InstallMode, "install-mode", "install mode")
 
 	// --mode is hidden so only users who know what they're doing can alter add mode.
@@ -95,15 +94,15 @@ func (i *Install) setup(ctx context.Context) error {
 		return err
 	}
 
-	// get index image labels.
-	catalogLabels, err := registryutil.GetImageLabels(ctx, nil, i.IndexImageCatalogCreator.IndexImage, false)
+	// check if index image adopts File-Based Catalog or SQLite index image format
+	isFBCImage, err := fbcutil.IsFBC(ctx, i.IndexImageCatalogCreator.IndexImage)
 	if err != nil {
-		return fmt.Errorf("get index image labels: %v", err)
+		return fmt.Errorf("error in upgrading the bundle %q that was installed traditionally", i.IndexImageCatalogCreator.BundleImage)
 	}
+	i.IndexImageCatalogCreator.HasFBCLabel = isFBCImage
 
 	// set the field to true if FBC label is on the image or for a default index image.
-	if _, hasFBCLabel := catalogLabels[containertools.ConfigsLocationLabel]; hasFBCLabel || i.IndexImageCatalogCreator.IndexImage == registry.DefaultIndexImage {
-		i.IndexImageCatalogCreator.HasFBCLabel = true
+	if i.IndexImageCatalogCreator.HasFBCLabel {
 		if i.IndexImageCatalogCreator.BundleAddMode != "" {
 			return fmt.Errorf("specifying the bundle add mode is not supported for File-Based Catalog bundles and index images")
 		}
@@ -115,7 +114,7 @@ func (i *Install) setup(ctx context.Context) error {
 
 	if i.IndexImageCatalogCreator.HasFBCLabel {
 		// FBC variables
-		f := &registry.FBCContext{
+		f := &fbcutil.FBCContext{
 			Package: labels[registrybundle.PackageLabel],
 			Refs:    []string{i.BundleImage},
 			ChannelEntry: declarativeconfig.ChannelEntry{
@@ -126,7 +125,7 @@ func (i *Install) setup(ctx context.Context) error {
 		if _, hasChannelMetadata := labels[registrybundle.ChannelsLabel]; hasChannelMetadata {
 			f.ChannelName = strings.Split(labels[registrybundle.ChannelsLabel], ",")[0]
 		} else {
-			f.ChannelName = registry.DefaultChannel
+			f.ChannelName = fbcutil.DefaultChannel
 		}
 
 		// generate an fbc if an fbc specific label is found on the image or for a default index image.
@@ -151,7 +150,7 @@ func (i *Install) setup(ctx context.Context) error {
 }
 
 // generateFBCContent creates a File-Based Catalog using the bundle image and index image from the run bundle command.
-func generateFBCContent(ctx context.Context, f *registry.FBCContext, bundleImage, indexImage string) (string, error) {
+func generateFBCContent(ctx context.Context, f *fbcutil.FBCContext, bundleImage, indexImage string) (string, error) {
 	log.Infof("Creating a File-Based Catalog of the bundle %q", bundleImage)
 	// generate a File-Based Catalog representation of the bundle image
 	bundleDeclcfg, err := f.CreateFBC(ctx)
@@ -165,7 +164,7 @@ func generateFBCContent(ctx context.Context, f *registry.FBCContext, bundleImage
 		Channels: []declarativeconfig.Channel{bundleDeclcfg.Channel},
 	}
 
-	if indexImage != registry.DefaultIndexImage { // non-default index image was specified.
+	if indexImage != fbcutil.DefaultIndexImage { // non-default index image was specified.
 		// since an index image is specified, the bundle image will be added to the index image.
 		// addBundleToIndexImage will ensure that the bundle is not already present in the index image and error out if it does.
 		declcfg, err = addBundleToIndexImage(ctx, indexImage, bundleDeclcfg)
@@ -176,7 +175,7 @@ func generateFBCContent(ctx context.Context, f *registry.FBCContext, bundleImage
 
 	// validate the declarative config and convert it to a string
 	var content string
-	if content, err = registry.ValidateAndStringify(declcfg); err != nil {
+	if content, err = fbcutil.ValidateAndStringify(declcfg); err != nil {
 		return "", fmt.Errorf("error validating and converting the declarative config object to a string format: %v", err)
 	}
 
@@ -186,7 +185,7 @@ func generateFBCContent(ctx context.Context, f *registry.FBCContext, bundleImage
 }
 
 // addBundleToIndexImage adds the bundle to an existing index image if the bundle is not already present in the index image.
-func addBundleToIndexImage(ctx context.Context, indexImage string, bundleDeclConfig registry.BundleDeclcfg) (*declarativeconfig.DeclarativeConfig, error) {
+func addBundleToIndexImage(ctx context.Context, indexImage string, bundleDeclConfig fbcutil.BundleDeclcfg) (*declarativeconfig.DeclarativeConfig, error) {
 	log.Infof("Rendering a File-Based Catalog of the Index Image %q", indexImage)
 	log.SetOutput(ioutil.Discard)
 	render := action.Render{

internal/olm/operator/bundleupgrade/upgrade.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
 	registrybundle "github.com/operator-framework/operator-registry/pkg/lib/bundle"
+	fbcutil "github.com/operator-framework/operator-sdk/internal/olm/fbcutil"
 	"github.com/operator-framework/operator-sdk/internal/olm/operator"
 	"github.com/operator-framework/operator-sdk/internal/olm/operator/registry"
 	"github.com/spf13/pflag"
@@ -84,12 +85,12 @@ func (u *Upgrade) setup(ctx context.Context) error {
 	// defer defaulting the bundle add mode to after the existing CatalogSource is retrieved.
 	u.IndexImageCatalogCreator.PackageName = u.OperatorInstaller.PackageName
 	u.IndexImageCatalogCreator.BundleImage = u.BundleImage
-	u.IndexImageCatalogCreator.IndexImage = registry.DefaultIndexImage
+	u.IndexImageCatalogCreator.IndexImage = fbcutil.DefaultIndexImage
 
 	if _, hasChannelMetadata := labels[registrybundle.ChannelsLabel]; hasChannelMetadata {
 		u.IndexImageCatalogCreator.ChannelName = strings.Split(labels[registrybundle.ChannelsLabel], ",")[0]
 	} else {
-		u.IndexImageCatalogCreator.ChannelName = registry.DefaultChannel
+		u.IndexImageCatalogCreator.ChannelName = fbcutil.DefaultChannel
 	}
 
 	return nil