Add command to delete an existing olmv1 catalog

Signed-off-by: Artur Zych <[email protected]>

Author: azych

internal/cmd/internal/olmv1/catalog_delete.go

@@ -0,0 +1,32 @@
+package olmv1
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/operator-framework/kubectl-operator/internal/cmd/internal/log"
+	v1action "github.com/operator-framework/kubectl-operator/internal/pkg/v1/action"
+	"github.com/operator-framework/kubectl-operator/pkg/action"
+)
+
+// NewCatalogDeleteCmd allows deleting a specified, existing catalog
+func NewCatalogDeleteCmd(cfg *action.Configuration) *cobra.Command {
+	i := v1action.NewCatalogDelete(cfg)
+	i.Logf = log.Printf
+
+	cmd := &cobra.Command{
+		Use:     "catalog <catalog_name>",
+		Aliases: []string{"catalogs <catalog_name>"},
+		Args:    cobra.ExactArgs(1),
+		Short:   "Delete an existing catalog",
+		Run: func(cmd *cobra.Command, args []string) {
+			i.CatalogName = args[0]
+
+			if err := i.Run(cmd.Context()); err != nil {
+				log.Fatalf("failed to delete catalog %q: %v", i.CatalogName, err)
+			}
+			log.Printf("catalog %q deleted", i.CatalogName)
+		},
+	}
+
+	return cmd
+}

internal/cmd/olmv1.go

@@ -24,10 +24,18 @@ func newOlmV1Cmd(cfg *action.Configuration) *cobra.Command {
 		olmv1.NewCatalogInstalledGetCmd(cfg),
 	)
 
+	deleteCmd := &cobra.Command{
+		Use:   "delete",
+		Short: "Delete an OLMv1 resource",
+		Long:  "Delete an OLMv1 resource",
+	}
+	deleteCmd.AddCommand(olmv1.NewCatalogDeleteCmd(cfg))
+
 	cmd.AddCommand(
 		olmv1.NewOperatorInstallCmd(cfg),
 		olmv1.NewOperatorUninstallCmd(cfg),
 		getCmd,
+		deleteCmd,
 	)
 
 	return cmd

internal/pkg/v1/action/action_suite_test.go

@@ -1,13 +1,34 @@
 package action_test
 
 import (
+	"fmt"
 	"testing"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	olmv1catalogd "github.com/operator-framework/catalogd/api/v1"
 )
 
 func TestCommand(t *testing.T) {
 	RegisterFailHandler(Fail)
-	RunSpecs(t, "Internal action Suite")
+	RunSpecs(t, "Internal v1 action Suite")
+}
+
+func setupTestCatalogs(n int) []client.Object {
+	var result []client.Object
+	for i := 1; i <= n; i++ {
+		result = append(result, newClusterCatalog(fmt.Sprintf("cat%d", i)))
+	}
+
+	return result
+}
+
+func newClusterCatalog(name string) *olmv1catalogd.ClusterCatalog {
+	return &olmv1catalogd.ClusterCatalog{
+		ObjectMeta: metav1.ObjectMeta{Name: name},
+	}
 }

internal/pkg/v1/action/catalog_delete.go

@@ -0,0 +1,34 @@
+package action
+
+import (
+	"context"
+
+	olmv1catalogd "github.com/operator-framework/catalogd/api/v1"
+
+	"github.com/operator-framework/kubectl-operator/pkg/action"
+)
+
+type CatalogDelete struct {
+	config      *action.Configuration
+	CatalogName string
+
+	Logf func(string, ...interface{})
+}
+
+func NewCatalogDelete(cfg *action.Configuration) *CatalogDelete {
+	return &CatalogDelete{
+		config: cfg,
+		Logf:   func(string, ...interface{}) {},
+	}
+}
+
+func (i *CatalogDelete) Run(ctx context.Context) error {
+	op := &olmv1catalogd.ClusterCatalog{}
+	op.SetName(i.CatalogName)
+
+	if err := i.config.Client.Delete(ctx, op); err != nil {
+		return err
+	}
+
+	return waitForDeletion(ctx, i.config.Client, op)
+}

internal/pkg/v1/action/catalog_delete_test.go

@@ -0,0 +1,71 @@
+package action_test
+
+import (
+	"context"
+	"slices"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+
+	olmv1catalogd "github.com/operator-framework/catalogd/api/v1"
+
+	internalaction "github.com/operator-framework/kubectl-operator/internal/pkg/v1/action"
+	"github.com/operator-framework/kubectl-operator/pkg/action"
+)
+
+var _ = Describe("CatalogInstalledGet", func() {
+	setupEnv := func(catalogs ...client.Object) action.Configuration {
+		var cfg action.Configuration
+
+		sch, err := action.NewScheme()
+		Expect(err).To(BeNil())
+
+		cl := fake.NewClientBuilder().
+			WithObjects(catalogs...).
+			WithScheme(sch).
+			Build()
+		cfg.Scheme = sch
+		cfg.Client = cl
+
+		return cfg
+	}
+
+	It("fails deleting a non-existing catalog", func() {
+		cfg := setupEnv(setupTestCatalogs(2)...)
+
+		deleter := internalaction.NewCatalogDelete(&cfg)
+		deleter.CatalogName = "does-not-exist"
+		err := deleter.Run(context.TODO())
+		Expect(err).NotTo(BeNil())
+
+		validateExistingCatalogs(cfg.Client, []string{"cat1", "cat2"})
+	})
+
+	It("successfully deletes an existing catalog", func() {
+		cfg := setupEnv(setupTestCatalogs(3)...)
+
+		deleter := internalaction.NewCatalogDelete(&cfg)
+		deleter.CatalogName = "cat2"
+		err := deleter.Run(context.TODO())
+		Expect(err).To(BeNil())
+
+		validateExistingCatalogs(cfg.Client, []string{"cat1", "cat3"})
+	})
+})
+
+func validateExistingCatalogs(c client.Client, wantedNames []string) {
+	var catalogsList olmv1catalogd.ClusterCatalogList
+	err := c.List(context.TODO(), &catalogsList)
+	Expect(err).To(BeNil())
+
+	catalogs := catalogsList.Items
+	Expect(catalogs).To(HaveLen(len(wantedNames)))
+	for _, wantedName := range wantedNames {
+		Expect(slices.ContainsFunc(catalogs, func(cat olmv1catalogd.ClusterCatalog) bool {
+			return cat.Name == wantedName
+		})).To(BeTrue())
+	}
+}

internal/pkg/v1/action/catalog_installed_get_test.go

@@ -2,13 +2,11 @@ package action_test
 
 import (
 	"context"
-	"fmt"
 	"slices"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
@@ -82,18 +80,3 @@ var _ = Describe("CatalogInstalledGet", func() {
 		Expect(operators).To(BeEmpty())
 	})
 })
-
-func setupTestCatalogs(n int) []client.Object {
-	var result []client.Object
-	for i := 1; i <= n; i++ {
-		result = append(result, newClusterCatalog(fmt.Sprintf("cat%d", i)))
-	}
-
-	return result
-}
-
-func newClusterCatalog(name string) *olmv1catalogd.ClusterCatalog {
-	return &olmv1catalogd.ClusterCatalog{
-		ObjectMeta: metav1.ObjectMeta{Name: name},
-	}
-}

internal/pkg/v1/action/helpers.go

@@ -0,0 +1,37 @@
+package action
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/wait"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+const pollInterval = 250 * time.Millisecond
+
+func objectKeyForObject(obj client.Object) types.NamespacedName {
+	return types.NamespacedName{
+		Namespace: obj.GetNamespace(),
+		Name:      obj.GetName(),
+	}
+}
+
+func waitForDeletion(ctx context.Context, cl client.Client, obj client.Object) error {
+	key := objectKeyForObject(obj)
+	if err := wait.PollUntilContextCancel(ctx, pollInterval, true, func(conditionCtx context.Context) (bool, error) {
+		if err := cl.Get(conditionCtx, key, obj); apierrors.IsNotFound(err) {
+			return true, nil
+		} else if err != nil {
+			return false, err
+		}
+		return false, nil
+	}); err != nil {
+		return fmt.Errorf("waiting for deletion: %w", err)
+	}
+
+	return nil
+}

internal/pkg/v1/action/operator.go

@@ -58,7 +58,7 @@ func (i *OperatorInstall) Run(ctx context.Context) (*olmv1.ClusterExtension, err
 	// All Types will exist, so Ready may have a false Status. So, wait until
 	// Type=Ready,Status=True happens
 
-	if err := wait.PollUntilContextCancel(ctx, pollTimeout, true, func(conditionCtx context.Context) (bool, error) {
+	if err := wait.PollUntilContextCancel(ctx, pollInterval, true, func(conditionCtx context.Context) (bool, error) {
 		if err := i.config.Client.Get(conditionCtx, opKey, op); err != nil {
 			return false, err
 		}

internal/pkg/v1/action/operator_install.go

@@ -7,8 +7,6 @@ import (
 
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/types"
-	"k8s.io/apimachinery/pkg/util/wait"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	olmv1 "github.com/operator-framework/operator-controller/api/v1"
 
@@ -42,29 +40,3 @@ func (u *OperatorUninstall) Run(ctx context.Context) error {
 	}
 	return waitForDeletion(ctx, u.config.Client, op)
 }
-
-func objectKeyForObject(obj client.Object) types.NamespacedName {
-	return types.NamespacedName{
-		Namespace: obj.GetNamespace(),
-		Name:      obj.GetName(),
-	}
-}
-
-func waitForDeletion(ctx context.Context, cl client.Client, objs ...client.Object) error {
-	for _, obj := range objs {
-		obj := obj
-		lowerKind := strings.ToLower(obj.GetObjectKind().GroupVersionKind().Kind)
-		key := objectKeyForObject(obj)
-		if err := wait.PollUntilContextCancel(ctx, pollTimeout, true, func(conditionCtx context.Context) (bool, error) {
-			if err := cl.Get(conditionCtx, key, obj); apierrors.IsNotFound(err) {
-				return true, nil
-			} else if err != nil {
-				return false, err
-			}
-			return false, nil
-		}); err != nil {
-			return fmt.Errorf("wait for %s %q deleted: %v", lowerKind, key.Name, err)
-		}
-	}
-	return nil
-}