fix run bundle(-upgrade) to no longer stall (#6040)

everettraven · web-flow · commit abdc20ca80cf · 2022-09-26T13:16:26.000-04:00
* fix run bundle(-upgrade) to no longer stall

Signed-off-by: Bryce Palmer &lt;bpalmer@redhat.com&gt;

* add changelog

Signed-off-by: Bryce Palmer &lt;bpalmer@redhat.com&gt;

* add err check and log warning for linter

Signed-off-by: Bryce Palmer &lt;bpalmer@redhat.com&gt;

Signed-off-by: Bryce Palmer &lt;bpalmer@redhat.com&gt;
diff --git a/changelog/fragments/rbu-stall-fix.yaml b/changelog/fragments/rbu-stall-fix.yaml
@@ -0,0 +1,8 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      `operator-sdk run bundle(-upgrade)`: fixed bug causing `operator-sdk run bundle-upgrade` and `operator-sdk run bundle ... --index-image=...` to stall indefinitely.
+    kind: "bugfix"
+    breaking: false
+
diff --git a/internal/olm/fbcutil/util.go b/internal/olm/fbcutil/util.go
@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"strings"
 
 	"github.com/operator-framework/operator-registry/alpha/action"
 	"github.com/operator-framework/operator-registry/alpha/declcfg"
@@ -32,9 +33,10 @@ import (
 )
 
 const (
-	SchemaChannel  = "olm.channel"
-	SchemaPackage  = "olm.package"
-	DefaultChannel = "operator-sdk-run-bundle"
+	SchemaChannel   = "olm.channel"
+	SchemaPackage   = "olm.package"
+	DefaultChannel  = "operator-sdk-run-bundle"
+	DefaultCacheDir = "operator-sdk-run-bundle-cache"
 )
 
 const (
@@ -132,16 +134,26 @@ func NullLogger() *log.Entry {
 // 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, skipTLSVerify bool, useHTTP bool) (*declarativeconfig.DeclarativeConfig, error) {
-
+	cacheDir := strings.ReplaceAll(strings.Join(refs, "_"), "/", "-")
+	if cacheDir == "" {
+		cacheDir = DefaultCacheDir
+	}
 	reg, err := containerdregistry.NewRegistry(
 		containerdregistry.WithLog(NullLogger()),
 		containerdregistry.SkipTLSVerify(skipTLSVerify),
-		containerdregistry.WithPlainHTTP(useHTTP))
-
+		containerdregistry.WithPlainHTTP(useHTTP),
+		containerdregistry.WithCacheDir(cacheDir))
 	if err != nil {
 		return nil, fmt.Errorf("error creating new image registry: %v", err)
 	}
 
+	defer func() {
+		err = reg.Destroy()
+		if err != nil {
+			log.Warn(fmt.Sprintf("Unable to cleanup registry. You may have to manually cleanup by removing the %q directory", cacheDir))
+		}
+	}()
+
 	render := action.Render{
 		Refs:     refs,
 		Registry: reg,
diff --git a/internal/olm/operator/bundle/install.go b/internal/olm/operator/bundle/install.go
@@ -17,17 +17,13 @@ package bundle
 import (
 	"context"
 	"fmt"
-	"io/ioutil"
-	"os"
 	"strings"
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/pflag"
 
 	"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/image/containerdregistry"
 	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"
@@ -191,26 +187,10 @@ func generateFBCContent(ctx context.Context, f *fbcutil.FBCContext, bundleImage,
 // declarative config type.
 func generateExtraFBC(ctx context.Context, indexImage string, bundleDeclConfig fbcutil.BundleDeclcfg, skipTLSVerify bool, useHTTP bool) (*declarativeconfig.DeclarativeConfig, error) {
 	log.Infof("Rendering a File-Based Catalog of the Index Image %q to verify if bundle %q is present", indexImage, bundleDeclConfig.Bundle.Name)
-	log.SetOutput(ioutil.Discard)
-
-	reg, err := containerdregistry.NewRegistry(
-		containerdregistry.WithLog(fbcutil.NullLogger()),
-		containerdregistry.SkipTLSVerify(skipTLSVerify),
-		containerdregistry.WithPlainHTTP(useHTTP))
 
+	imageDeclConfig, err := fbcutil.RenderRefs(ctx, []string{indexImage}, skipTLSVerify, useHTTP)
 	if err != nil {
-		return nil, fmt.Errorf("error creating new image registry: %v", err)
-	}
-
-	render := action.Render{
-		Refs:     []string{indexImage},
-		Registry: reg,
-	}
-
-	imageDeclConfig, err := render.Run(ctx)
-	log.SetOutput(os.Stdout)
-	if err != nil {
-		return nil, fmt.Errorf("error rendering the index image %q: %v", indexImage, err)
+		return nil, err
 	}
 
 	for _, bundle := range imageDeclConfig.Bundles {
