From 3aae34694623cce5f1da4a93c7c1e729c528402c Mon Sep 17 00:00:00 2001 From: Jakub Guzik Date: Sat, 8 May 2021 22:47:23 +0200 Subject: [PATCH 1/2] Move filter parsing to common utils Signed-off-by: Jakub Guzik --- cmd/podman/common/util.go | 15 +++++++++++++++ cmd/podman/containers/prune.go | 15 +++++---------- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/cmd/podman/common/util.go b/cmd/podman/common/util.go index 2a8b2040cd..afee55914a 100644 --- a/cmd/podman/common/util.go +++ b/cmd/podman/common/util.go @@ -35,6 +35,21 @@ func ReadPodIDFiles(files []string) ([]string, error) { return ids, nil } +// ParseFilters transforms one filter format to another and validates input +func ParseFilters(filter []string) (map[string][]string, error) { + // TODO Remove once filter refactor is finished and url.Values done. + filters := map[string][]string{} + for _, f := range filter { + t := strings.SplitN(f, "=", 2) + filters = make(map[string][]string) + if len(t) < 2 { + return map[string][]string{}, errors.Errorf("filter input must be in the form of filter=value: %s is invalid", f) + } + filters[t[0]] = append(filters[t[0]], t[1]) + } + return filters, nil +} + // createExpose parses user-provided exposed port definitions and converts them // into SpecGen format. // TODO: The SpecGen format should really handle ranges more sanely - we could diff --git a/cmd/podman/containers/prune.go b/cmd/podman/containers/prune.go index 9acf5589b2..837d90f70d 100644 --- a/cmd/podman/containers/prune.go +++ b/cmd/podman/containers/prune.go @@ -4,16 +4,15 @@ import ( "bufio" "context" "fmt" - "net/url" "os" "strings" "github.com/containers/common/pkg/completion" + "github.com/containers/podman/v3/cmd/podman/common" "github.com/containers/podman/v3/cmd/podman/registry" "github.com/containers/podman/v3/cmd/podman/utils" "github.com/containers/podman/v3/cmd/podman/validate" "github.com/containers/podman/v3/pkg/domain/entities" - "github.com/pkg/errors" "github.com/spf13/cobra" ) @@ -50,6 +49,7 @@ func init() { func prune(cmd *cobra.Command, args []string) error { var ( pruneOptions = entities.ContainerPruneOptions{} + err error ) if !force { reader := bufio.NewReader(os.Stdin) @@ -64,14 +64,9 @@ func prune(cmd *cobra.Command, args []string) error { } } - // TODO Remove once filter refactor is finished and url.Values done. - for _, f := range filter { - t := strings.SplitN(f, "=", 2) - pruneOptions.Filters = make(url.Values) - if len(t) < 2 { - return errors.Errorf("filter input must be in the form of filter=value: %s is invalid", f) - } - pruneOptions.Filters.Add(t[0], t[1]) + pruneOptions.Filters, err = common.ParseFilters(filter) + if err != nil { + return err } responses, err := registry.ContainerEngine().ContainerPrune(context.Background(), pruneOptions) From 5e6405334c3d0422b5ec7cd09ef9c58d8f558dba Mon Sep 17 00:00:00 2001 From: Jakub Guzik Date: Wed, 12 May 2021 00:39:01 +0200 Subject: [PATCH 2/2] Add support for cli network prune --filter flag Signed-off-by: Jakub Guzik --- cmd/podman/networks/prune.go | 16 +++++-- docs/source/markdown/podman-network-ls.1.md | 2 +- .../source/markdown/podman-network-prune.1.md | 14 ++++++ test/e2e/network_test.go | 46 +++++++++++++++++++ 4 files changed, 73 insertions(+), 5 deletions(-) diff --git a/cmd/podman/networks/prune.go b/cmd/podman/networks/prune.go index ebba06db59..bcc55f0f4f 100644 --- a/cmd/podman/networks/prune.go +++ b/cmd/podman/networks/prune.go @@ -6,6 +6,7 @@ import ( "os" "strings" + "github.com/containers/common/pkg/completion" "github.com/containers/podman/v3/cmd/podman/common" "github.com/containers/podman/v3/cmd/podman/registry" "github.com/containers/podman/v3/cmd/podman/utils" @@ -31,12 +32,14 @@ var ( var ( networkPruneOptions entities.NetworkPruneOptions force bool + filter = []string{} ) -func networkPruneFlags(flags *pflag.FlagSet) { - //TODO: Not implemented but for future reference - //flags.StringSliceVar(&networkPruneOptions.Filters,"filters", []string{}, "provide filter values (e.g. 'until=')") +func networkPruneFlags(cmd *cobra.Command, flags *pflag.FlagSet) { flags.BoolVarP(&force, "force", "f", false, "do not prompt for confirmation") + filterFlagName := "filter" + flags.StringArrayVar(&filter, filterFlagName, []string{}, "Provide filter values (e.g. 'label==')") + _ = cmd.RegisterFlagCompletionFunc(filterFlagName, completion.AutocompleteNone) } func init() { @@ -46,12 +49,13 @@ func init() { Parent: networkCmd, }) flags := networkPruneCommand.Flags() - networkPruneFlags(flags) + networkPruneFlags(networkPruneCommand, flags) } func networkPrune(cmd *cobra.Command, _ []string) error { var ( errs utils.OutputErrors + err error ) if !force { reader := bufio.NewReader(os.Stdin) @@ -65,6 +69,10 @@ func networkPrune(cmd *cobra.Command, _ []string) error { return nil } } + networkPruneOptions.Filters, err = common.ParseFilters(filter) + if err != nil { + return err + } responses, err := registry.ContainerEngine().NetworkPrune(registry.Context(), networkPruneOptions) if err != nil { setExitCode(err) diff --git a/docs/source/markdown/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md index a5c6ff0c0a..b7fd13ec60 100644 --- a/docs/source/markdown/podman-network-ls.1.md +++ b/docs/source/markdown/podman-network-ls.1.md @@ -13,7 +13,7 @@ Displays a list of existing podman networks. #### **--filter**, **-f** Filter output based on conditions given. -Multiple filters can be given with multiple uses of the --filter flag. +Multiple filters can be given with multiple uses of the --filter option. Filters with the same key work inclusive with the only exception being `label` which is exclusive. Filters with different keys always work exclusive. diff --git a/docs/source/markdown/podman-network-prune.1.md b/docs/source/markdown/podman-network-prune.1.md index af0a7295dc..e18ffaaeae 100644 --- a/docs/source/markdown/podman-network-prune.1.md +++ b/docs/source/markdown/podman-network-prune.1.md @@ -16,6 +16,20 @@ the so-called default network which goes by the name of *podman*. Do not prompt for confirmation +#### **--filter** + +Filter output based on conditions given. +Multiple filters can be given with multiple uses of the --filter option. +Filters with the same key work inclusive with the only exception being +`label` which is exclusive. Filters with different keys always work exclusive. + +Valid filters are listed below: + +| **Filter** | **Description** | +| ---------- | ------------------------------------------------------------------------------------- | +| label | [Key] or [Key=Value] Label assigned to a network | +| until | only remove networks created before given timestamp | + ## EXAMPLE Prune networks diff --git a/test/e2e/network_test.go b/test/e2e/network_test.go index ff2e1eb660..6f28d7e19f 100644 --- a/test/e2e/network_test.go +++ b/test/e2e/network_test.go @@ -584,6 +584,52 @@ var _ = Describe("Podman network", func() { Expect(nc.ExitCode()).To(Equal(0)) }) + It("podman network prune --filter", func() { + net1 := "macvlan" + stringid.GenerateNonCryptoID() + "net1" + + nc := podmanTest.Podman([]string{"network", "create", net1}) + nc.WaitWithDefaultTimeout() + defer podmanTest.removeCNINetwork(net1) + Expect(nc.ExitCode()).To(Equal(0)) + + list := podmanTest.Podman([]string{"network", "ls", "--format", "{{.Name}}"}) + list.WaitWithDefaultTimeout() + Expect(list.ExitCode()).To(BeZero()) + + Expect(StringInSlice(net1, list.OutputToStringArray())).To(BeTrue()) + if !isRootless() { + Expect(StringInSlice("podman", list.OutputToStringArray())).To(BeTrue()) + } + + // -f needed only to skip y/n question + prune := podmanTest.Podman([]string{"network", "prune", "-f", "--filter", "until=50"}) + prune.WaitWithDefaultTimeout() + Expect(prune.ExitCode()).To(BeZero()) + + listAgain := podmanTest.Podman([]string{"network", "ls", "--format", "{{.Name}}"}) + listAgain.WaitWithDefaultTimeout() + Expect(listAgain.ExitCode()).To(BeZero()) + + Expect(StringInSlice(net1, listAgain.OutputToStringArray())).To(BeTrue()) + if !isRootless() { + Expect(StringInSlice("podman", list.OutputToStringArray())).To(BeTrue()) + } + + // -f needed only to skip y/n question + prune = podmanTest.Podman([]string{"network", "prune", "-f", "--filter", "until=5000000000000"}) + prune.WaitWithDefaultTimeout() + Expect(prune.ExitCode()).To(BeZero()) + + listAgain = podmanTest.Podman([]string{"network", "ls", "--format", "{{.Name}}"}) + listAgain.WaitWithDefaultTimeout() + Expect(listAgain.ExitCode()).To(BeZero()) + + Expect(StringInSlice(net1, listAgain.OutputToStringArray())).To(BeFalse()) + if !isRootless() { + Expect(StringInSlice("podman", list.OutputToStringArray())).To(BeTrue()) + } + }) + It("podman network prune", func() { // Create two networks // Check they are there