api/types/volume: add PruneOptions

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
moby · thaJeztah · Apr 24, 2023 · Apr 24, 2023 · Apr 25, 2023 · Apr 21, 2023
commit 7065e742ac35b3a9312e54b807cc2523e987f29c
diff --git a/api/types/volume/options.go b/api/types/volume/options.go
@@ -7,6 +7,15 @@ type ListOptions struct {
 	Filters filters.Args
 }
 
+// PruneOptions holds parameters to prune volumes.
+type PruneOptions struct {
+	// All controls whether named volumes should also be pruned.
+	All bool
+
+	// Filters to apply when pruning.
+	Filters filters.Args
+}
+
 // PruneReport contains the response for Engine API:
 // POST "/volumes/prune"
 type PruneReport struct {

diff --git a/client/interface.go b/client/interface.go
@@ -179,7 +179,7 @@ type VolumeAPIClient interface {
 	VolumeInspectWithRaw(ctx context.Context, volumeID string) (volume.Volume, []byte, error)
 	VolumeList(ctx context.Context, options volume.ListOptions) (volume.ListResponse, error)
 	VolumeRemove(ctx context.Context, volumeID string, force bool) error
-	VolumesPrune(ctx context.Context, pruneFilter filters.Args) (volume.PruneReport, error)
+	VolumesPrune(ctx context.Context, options volume.PruneOptions) (volume.PruneReport, error)
 	VolumeUpdate(ctx context.Context, volumeID string, version swarm.Version, options volume.UpdateOptions) error
 }
 

diff --git a/client/volume_prune.go b/client/volume_prune.go
@@ -5,17 +5,28 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/docker/docker/api/types/filters"
+	"github.com/docker/docker/api/types/versions"
 	"github.com/docker/docker/api/types/volume"
+	"github.com/docker/docker/errdefs"
+	"github.com/pkg/errors"
 )
 
 // VolumesPrune requests the daemon to delete unused data
-func (cli *Client) VolumesPrune(ctx context.Context, pruneFilters filters.Args) (volume.PruneReport, error) {
+func (cli *Client) VolumesPrune(ctx context.Context, opts volume.PruneOptions) (volume.PruneReport, error) {
 	if err := cli.NewVersionError(ctx, "1.25", "volume prune"); err != nil {
 		return volume.PruneReport{}, err
 	}
 
-	query, err := getFiltersQuery(pruneFilters)
+	if versions.GreaterThanOrEqualTo(cli.version, "1.42") {
+		if opts.All {
+			if opts.Filters.Contains("all") {
+				return report, errdefs.InvalidParameter(errors.New(`conflicting options: cannot specify both "all"" and "all" filter"`))
+			}
+			opts.Filters.Add("all", "true")
+		}
+	}
+
+	query, err := getFiltersQuery(opts.Filters)
 	if err != nil {
 		return volume.PruneReport{}, err
 	}

diff --git a/client/volume_prune_test.go b/client/volume_prune_test.go
@@ -0,0 +1,27 @@
+package client
+
+import (
+	"context"
+	"net/http"
+	"testing"
+
+	"github.com/docker/docker/api/types/filters"
+	"github.com/docker/docker/api/types/volume"
+	"github.com/docker/docker/errdefs"
+	"gotest.tools/v3/assert"
+	is "gotest.tools/v3/assert/cmp"
+)
+
+func TestVolumePruneError(t *testing.T) {
+	client := &Client{
+		version: "1.42",
+		client:  &http.Client{},
+	}
+
+	_, err := client.VolumesPrune(context.Background(), volume.PruneOptions{
+		All:     true,
+		Filters: filters.NewArgs(filters.Arg("all", "true")),
+	})
+	assert.Check(t, is.ErrorType(err, errdefs.IsInvalidParameter))
+	assert.Check(t, is.Error(err, `conflicting options: cannot specify both "all"" and "all" filter"`))
+}
diff --git a/integration/plugin/authz/authz_plugin_v2_test.go b/integration/plugin/authz/authz_plugin_v2_test.go
@@ -9,7 +9,6 @@ import (
 	"testing"
 
 	"github.com/docker/docker/api/types"
-	"github.com/docker/docker/api/types/filters"
 	"github.com/docker/docker/api/types/volume"
 	"github.com/docker/docker/client"
 	"github.com/docker/docker/integration/internal/container"
@@ -112,7 +111,7 @@ func TestAuthZPluginV2RejectVolumeRequests(t *testing.T) {
 	assert.Assert(t, err != nil)
 	assert.ErrorContains(t, err, fmt.Sprintf("Error response from daemon: plugin %s failed with error:", authzPluginNameWithTag))
 
-	_, err = c.VolumesPrune(ctx, filters.Args{})
+	_, err = c.VolumesPrune(ctx, volume.PruneOptions{})
 	assert.Assert(t, err != nil)
 	assert.ErrorContains(t, err, fmt.Sprintf("Error response from daemon: plugin %s failed with error:", authzPluginNameWithTag))
 }

diff --git a/integration/volume/volume_test.go b/integration/volume/volume_test.go
@@ -272,7 +272,7 @@ func TestVolumePruneAnonymous(t *testing.T) {
 	assert.NilError(t, err)
 
 	// Prune anonymous volumes
-	pruneReport, err := client.VolumesPrune(ctx, filters.Args{})
+	pruneReport, err := client.VolumesPrune(ctx, volume.PruneOptions{})
 	assert.NilError(t, err)
 	assert.Check(t, is.Equal(len(pruneReport.VolumesDeleted), 1))
 	assert.Check(t, is.Equal(pruneReport.VolumesDeleted[0], v.Name))
@@ -283,8 +283,17 @@ func TestVolumePruneAnonymous(t *testing.T) {
 	// Prune all volumes
 	_, err = client.VolumeCreate(ctx, volume.CreateOptions{})
 	assert.NilError(t, err)
+	pruneReport, err = client.VolumesPrune(ctx, volume.PruneOptions{Filters: filters.NewArgs(filters.Arg("all", "1"))})
+	assert.NilError(t, err)
+	assert.Check(t, is.Equal(len(pruneReport.VolumesDeleted), 2))
+
+	// Create a named volume and an anonymous volume, and prune all
+	_, err = client.VolumeCreate(ctx, volume.CreateOptions{})
+	assert.NilError(t, err)
+	_, err = client.VolumeCreate(ctx, volume.CreateOptions{Name: "test"})
+	assert.NilError(t, err)
 
-	pruneReport, err = client.VolumesPrune(ctx, filters.NewArgs(filters.Arg("all", "1")))
+	pruneReport, err = client.VolumesPrune(ctx, volume.PruneOptions{All: true})
 	assert.NilError(t, err)
 	assert.Check(t, is.Equal(len(pruneReport.VolumesDeleted), 2))
 
@@ -299,7 +308,7 @@ func TestVolumePruneAnonymous(t *testing.T) {
 	vNamed, err = client.VolumeCreate(ctx, volume.CreateOptions{Name: "test-api141"})
 	assert.NilError(t, err)
 
-	pruneReport, err = clientOld.VolumesPrune(ctx, filters.Args{})
+	pruneReport, err = clientOld.VolumesPrune(ctx, volume.PruneOptions{})
 	assert.NilError(t, err)
 	assert.Check(t, is.Equal(len(pruneReport.VolumesDeleted), 2))
 	assert.Check(t, is.Contains(pruneReport.VolumesDeleted, v.Name))
@@ -334,7 +343,7 @@ VOLUME ` + volDest
 	err = client.ContainerRemove(ctx, id, containertypes.RemoveOptions{})
 	assert.NilError(t, err)
 
-	pruneReport, err := client.VolumesPrune(ctx, filters.Args{})
+	pruneReport, err := client.VolumesPrune(ctx, volume.PruneOptions{})
 	assert.NilError(t, err)
 	assert.Assert(t, is.Contains(pruneReport.VolumesDeleted, volumeName))
 }