Add DeleteCollection to the client Interface.

Author: Aaron

pkg/client/client.go

@@ -139,6 +139,15 @@ func (c *client) List(ctx context.Context, obj runtime.Object, opts ...ListOptio
 	return c.typedClient.List(ctx, obj, opts...)
 }
 
+// DeleteCollection implements client.Client
+func (c *client) DeleteCollection(ctx context.Context, obj runtime.Object, opts ...DeleteCollectionOptionFunc) error {
+	_, ok := obj.(*unstructured.UnstructuredList)
+	if ok {
+		return c.unstructuredClient.DeleteCollection(ctx, obj, opts...)
+	}
+	return c.typedClient.DeleteCollection(ctx, obj, opts...)
+}
+
 // Status implements client.StatusClient
 func (c *client) Status() StatusWriter {
 	return &statusWriter{client: c}

pkg/client/client_test.go

@@ -1846,6 +1846,37 @@ var _ = Describe("Client", func() {
 			Expect(lo.Namespace).To(Equal("test"))
 		})
 	})
+
+	Describe("DeleteCollectionOptions", func() {
+		It("should be created from ListOptions", func() {
+			labels := map[string]string{"foo": "bar"}
+			dco := &client.DeleteCollectionOptions{}
+			client.FromListOptionsFunc(client.MatchingLabels(labels))(dco)
+			Expect(dco).NotTo(BeNil())
+			Expect(dco.LabelSelector.String()).To(Equal("foo=bar"))
+			Expect(dco.AsDeleteOptions()).To(Equal(&metav1.DeleteOptions{}))
+		})
+		It("should be created from DeleteOptions", func() {
+			dco := &client.DeleteCollectionOptions{}
+			client.FromDeleteOptionsFunc(client.GracePeriodSeconds(1))(dco)
+			gp := int64(1)
+			Expect(dco.GracePeriodSeconds).To(Equal(&gp))
+			Expect(dco.AsListOptions()).To(Equal(&metav1.ListOptions{}))
+		})
+		It("should merge multiple options together", func() {
+			gp := int64(1)
+			labels := map[string]string{"foo": "bar"}
+
+			dco := &client.DeleteCollectionOptions{}
+			dco.ApplyOptions([]client.DeleteCollectionOptionFunc{
+				client.FromListOptionsFunc(client.MatchingLabels(labels)),
+				client.FromDeleteOptionsFunc(client.GracePeriodSeconds(1)),
+			})
+
+			Expect(dco.GracePeriodSeconds).To(Equal(&gp))
+			Expect(dco.LabelSelector.String()).To(Equal("foo=bar"))
+		})
+	})
 })
 
 var _ = Describe("DelegatingReader", func() {

pkg/client/example_test.go

@@ -22,7 +22,7 @@ import (
 	"os"
 
 	corev1 "k8s.io/api/core/v1"
-	"k8s.io/apimachinery/pkg/apis/meta/v1"
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -196,3 +196,19 @@ func ExampleClient_delete() {
 	})
 	_ = c.Delete(context.Background(), u)
 }
+
+// This example shows how to use the client with typed and unstrucurted objects to delete collections of objects.
+func ExampleClient_deleteCollection() {
+	// Using a typed object.
+	pod := &corev1.PodList{}
+	// c is a created client.
+	_ = c.DeleteCollection(context.Background(), pod)
+
+	u := &unstructured.UnstructuredList{}
+	u.SetGroupVersionKind(schema.GroupVersionKind{
+		Group:   "apps",
+		Kind:    "DeploymentList",
+		Version: "v1",
+	})
+	_ = c.DeleteCollection(context.Background(), u)
+}

pkg/client/interfaces.go

@@ -65,6 +65,8 @@ type Writer interface {
 	// Update updates the given obj in the Kubernetes cluster. obj must be a
 	// struct pointer so that obj can be updated with the content returned by the Server.
 	Update(ctx context.Context, obj runtime.Object) error
+
+	DeleteCollection(ctx context.Context, obj runtime.Object, opts ...DeleteCollectionOptionFunc) error
 }
 
 // StatusClient knows how to create a client which can update status subresource
@@ -323,3 +325,36 @@ func UseListOptions(newOpts *ListOptions) ListOptionFunc {
 		*opts = *newOpts
 	}
 }
+
+// DeleteCollectionOptions contains options for delete collection requests. It's a collection of
+// Both metav1.DeletOptions and metav1.ListOptions
+type DeleteCollectionOptions struct {
+	DeleteOptions
+	ListOptions
+}
+
+// ApplyOptions executes the given DeleteCollectionOptionFuncs and returns the mutated
+// DeleteOptions.
+func (o *DeleteCollectionOptions) ApplyOptions(optFuncs []DeleteCollectionOptionFunc) *DeleteCollectionOptions {
+	for _, optFunc := range optFuncs {
+		optFunc(o)
+	}
+	return o
+}
+
+// DeleteCollectionOptionFunc is a function that mutates a DeleteOptions struct. It implements
+// the functional options pattern. See
+// https://github.com/tmrts/go-patterns/blob/master/idiom/functional-options.md.
+type DeleteCollectionOptionFunc func(*DeleteCollectionOptions)
+
+func FromListOptionsFunc(newFunc ListOptionFunc) DeleteCollectionOptionFunc {
+	return func(opts *DeleteCollectionOptions) {
+		newFunc(&opts.ListOptions)
+	}
+}
+
+func FromDeleteOptionsFunc(newFunc DeleteOptionFunc) DeleteCollectionOptionFunc {
+	return func(opts *DeleteCollectionOptions) {
+		newFunc(&opts.DeleteOptions)
+	}
+}

pkg/client/typed_client.go

@@ -109,6 +109,25 @@ func (c *typedClient) List(ctx context.Context, obj runtime.Object, opts ...List
 		Into(obj)
 }
 
+func (c *typedClient) DeleteCollection(ctx context.Context, obj runtime.Object, opts ...DeleteCollectionOptionFunc) error {
+	r, err := c.cache.getResource(obj)
+	if err != nil {
+		return err
+	}
+
+	dcOpts := DeleteCollectionOptions{}
+	dcOpts.ApplyOptions(opts)
+
+	return r.Delete().
+		NamespaceIfScoped(dcOpts.Namespace, r.isNamespaced()).
+		Resource(r.resource()).
+		VersionedParams(dcOpts.AsListOptions(), c.paramCodec).
+		Body(dcOpts.AsDeleteOptions()).
+		Context(ctx).
+		Do().
+		Error()
+}
+
 // UpdateStatus used by StatusWriter to write status.
 func (c *typedClient) UpdateStatus(ctx context.Context, obj runtime.Object) error {
 	o, err := c.cache.getObjMeta(obj)

pkg/client/unstructured_client.go

@@ -131,6 +131,28 @@ func (uc *unstructuredClient) List(_ context.Context, obj runtime.Object, opts .
 	return nil
 }
 
+func (uc *unstructuredClient) DeleteCollection(_ context.Context, obj runtime.Object, opts ...DeleteCollectionOptionFunc) error {
+	u, ok := obj.(*unstructured.UnstructuredList)
+	if !ok {
+		return fmt.Errorf("unstructured client did not understand object: %T", obj)
+	}
+	gvk := u.GroupVersionKind()
+	if strings.HasSuffix(gvk.Kind, "List") {
+		gvk.Kind = gvk.Kind[:len(gvk.Kind)-4]
+	}
+
+	dcOpts := DeleteCollectionOptions{}
+	dcOpts.ApplyOptions(opts)
+
+	r, err := uc.getResourceInterface(gvk, dcOpts.ListOptions.Namespace)
+	if err != nil {
+		return err
+	}
+
+	err = r.DeleteCollection(dcOpts.AsDeleteOptions(), *dcOpts.AsListOptions())
+	return err
+}
+
 func (uc *unstructuredClient) UpdateStatus(_ context.Context, obj runtime.Object) error {
 	u, ok := obj.(*unstructured.Unstructured)
 	if !ok {