Add volume prune --filter support

This change adds support for the `--filter` / `?filters` arguments on
the `podman volume prune` subcommand.

  * Adds ParseFilterArgumentsIntoFilters helper for consistent
    Filter string slice handling
  * Adds `--filter` support to podman volume prune cli
  * Adds `?filters...` support to podman volume prune api
  * Updates apiv2 / e2e tests

Closes #8672

Signed-off-by: Baron Lenardson <lenardson.baron@gmail.com>

2 files changed, 47 insertions, 6 deletions

diff --git a/pkg/bindings/test/volumes_test.go b/pkg/bindings/test/volumes_test.go
index dc90d4d00..861a02441 100644
--- a/pkg/bindings/test/volumes_test.go
+++ b/pkg/bindings/test/volumes_test.go
@@ -144,16 +144,15 @@ var _ = Describe("Podman volumes", func() {
 		Expect(vols[0].Name).To(Equal("homer"))
 	})
 
-	// TODO we need to add filtering to tests
 	It("prune unused volume", func() {
 		// Pruning when no volumes present should be ok
-		_, err := volumes.Prune(connText)
+		_, err := volumes.Prune(connText, nil)
 		Expect(err).To(BeNil())
 
 		// Removing an unused volume should work
 		_, err = volumes.Create(connText, entities.VolumeCreateOptions{})
 		Expect(err).To(BeNil())
-		vols, err := volumes.Prune(connText)
+		vols, err := volumes.Prune(connText, nil)
 		Expect(err).To(BeNil())
 		Expect(len(vols)).To(BeNumerically("==", 1))
 
@@ -163,11 +162,45 @@ var _ = Describe("Podman volumes", func() {
 		Expect(err).To(BeNil())
 		session := bt.runPodman([]string{"run", "-dt", "-v", fmt.Sprintf("%s:/homer", "homer"), "--name", "vtest", alpine.name, "top"})
 		session.Wait(45)
-		vols, err = volumes.Prune(connText)
+		vols, err = volumes.Prune(connText, nil)
 		Expect(err).To(BeNil())
 		Expect(len(vols)).To(BeNumerically("==", 1))
 		_, err = volumes.Inspect(connText, "homer")
 		Expect(err).To(BeNil())
+
+		// Removing volume with non matching filter shouldn't prune any volumes
+		filters := make(map[string][]string)
+		filters["label"] = []string{"label1=idontmatch"}
+		_, err = volumes.Create(connText, entities.VolumeCreateOptions{Label: map[string]string{
+			"label1": "value1",
+		}})
+		Expect(err).To(BeNil())
+		vols, err = volumes.Prune(connText, filters)
+		Expect(err).To(BeNil())
+		Expect(len(vols)).To(BeNumerically("==", 0))
+		vol2, err := volumes.Create(connText, entities.VolumeCreateOptions{Label: map[string]string{
+			"label1": "value2",
+		}})
+		Expect(err).To(BeNil())
+		_, err = volumes.Create(connText, entities.VolumeCreateOptions{Label: map[string]string{
+			"label1": "value3",
+		}})
+		Expect(err).To(BeNil())
+
+		// Removing volume with matching filter label and value should remove specific entry
+		filters = make(map[string][]string)
+		filters["label"] = []string{"label1=value2"}
+		vols, err = volumes.Prune(connText, filters)
+		Expect(err).To(BeNil())
+		Expect(len(vols)).To(BeNumerically("==", 1))
+		Expect(vols[0].Id).To(Equal(vol2.Name))
+
+		// Removing volumes with matching filter label should remove all matching volumes
+		filters = make(map[string][]string)
+		filters["label"] = []string{"label1"}
+		vols, err = volumes.Prune(connText, filters)
+		Expect(err).To(BeNil())
+		Expect(len(vols)).To(BeNumerically("==", 2))
 	})
 
 })
diff --git a/pkg/bindings/volumes/volumes.go b/pkg/bindings/volumes/volumes.go
index 00f1e5720..b1be257b8 100644
--- a/pkg/bindings/volumes/volumes.go
+++ b/pkg/bindings/volumes/volumes.go
@@ -75,7 +75,7 @@ func List(ctx context.Context, filters map[string][]string) ([]*entities.VolumeL
 }
 
 // Prune removes unused volumes from the local filesystem.
-func Prune(ctx context.Context) ([]*entities.VolumePruneReport, error) {
+func Prune(ctx context.Context, filters map[string][]string) ([]*entities.VolumePruneReport, error) {
 	var (
 		pruned []*entities.VolumePruneReport
 	)
@@ -83,7 +83,15 @@ func Prune(ctx context.Context) ([]*entities.VolumePruneReport, error) {
 	if err != nil {
 		return nil, err
 	}
-	response, err := conn.DoRequest(nil, http.MethodPost, "/volumes/prune", nil, nil)
+	params := url.Values{}
+	if len(filters) > 0 {
+		strFilters, err := bindings.FiltersToString(filters)
+		if err != nil {
+			return nil, err
+		}
+		params.Set("filters", strFilters)
+	}
+	response, err := conn.DoRequest(nil, http.MethodPost, "/volumes/prune", params, nil)
 	if err != nil {
 		return nil, err
 	}