Merge pull request #9863 from jmguzik/fix-prune-filter-funcs

Containers prune endpoint should use only prune filters

pkg/api/handlers/compat/containers_prune.go

@@ -23,7 +23,7 @@ func PruneContainers(w http.ResponseWriter, r *http.Request) {
 
 	filterFuncs := make([]libpod.ContainerFilter, 0, len(*filtersMap))
 	for k, v := range *filtersMap {
-		generatedFunc, err := filters.GenerateContainerFilterFuncs(k, v, runtime)
+		generatedFunc, err := filters.GeneratePruneContainerFilterFuncs(k, v, runtime)
 		if err != nil {
 			utils.InternalServerError(w, err)
 			return

pkg/bindings/test/containers_test.go

@@ -550,21 +550,28 @@ var _ = Describe("Podman containers ", func() {
 		filtersIncorrect := map[string][]string{
 			"status": {"dummy"},
 		}
-		pruneResponse, err := containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filtersIncorrect))
+		_, err = containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filtersIncorrect))
+		Expect(err).ToNot(BeNil())
+
+		// List filter params should not work with prune.
+		filtersIncorrect = map[string][]string{
+			"name": {"top"},
+		}
+		_, err = containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filtersIncorrect))
 		Expect(err).ToNot(BeNil())
 
 		// Mismatched filter params no container should be pruned.
 		filtersIncorrect = map[string][]string{
-			"name": {"r"},
+			"label": {"xyz"},
 		}
-		pruneResponse, err = containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filtersIncorrect))
+		pruneResponse, err := containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filtersIncorrect))
 		Expect(err).To(BeNil())
 		Expect(len(reports.PruneReportsIds(pruneResponse))).To(Equal(0))
 		Expect(len(reports.PruneReportsErrs(pruneResponse))).To(Equal(0))
 
 		// Valid filter params container should be pruned now.
 		filters := map[string][]string{
-			"name": {"top"},
+			"until": {"0s"},
 		}
 		pruneResponse, err = containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filters))
 		Expect(err).To(BeNil())

pkg/domain/filters/containers.go

@@ -165,16 +165,7 @@ func GenerateContainerFilterFuncs(filter string, filterValues []string, r *libpo
 			return false
 		}, nil
 	case "until":
-		until, err := util.ComputeUntilTimestamp(filterValues)
-		if err != nil {
-			return nil, err
-		}
-		return func(c *libpod.Container) bool {
-			if !until.IsZero() && c.CreatedTime().After((until)) {
-				return true
-			}
-			return false
-		}, nil
+		return prepareUntilFilterFunc(filterValues)
 	case "pod":
 		var pods []*libpod.Pod
 		for _, podNameOrID := range filterValues {
@@ -226,3 +217,29 @@ func GenerateContainerFilterFuncs(filter string, filterValues []string, r *libpo
 	}
 	return nil, errors.Errorf("%s is an invalid filter", filter)
 }
+
+// GeneratePruneContainerFilterFuncs return ContainerFilter functions based of filter for prune operation
+func GeneratePruneContainerFilterFuncs(filter string, filterValues []string, r *libpod.Runtime) (func(container *libpod.Container) bool, error) {
+	switch filter {
+	case "label":
+		return func(c *libpod.Container) bool {
+			return util.MatchLabelFilters(filterValues, c.Labels())
+		}, nil
+	case "until":
+		return prepareUntilFilterFunc(filterValues)
+	}
+	return nil, errors.Errorf("%s is an invalid filter", filter)
+}
+
+func prepareUntilFilterFunc(filterValues []string) (func(container *libpod.Container) bool, error) {
+	until, err := util.ComputeUntilTimestamp(filterValues)
+	if err != nil {
+		return nil, err
+	}
+	return func(c *libpod.Container) bool {
+		if !until.IsZero() && c.CreatedTime().After((until)) {
+			return true
+		}
+		return false
+	}, nil
+}

pkg/domain/infra/abi/containers.go

@@ -194,7 +194,7 @@ func (ic *ContainerEngine) ContainerStop(ctx context.Context, namesOrIds []strin
 func (ic *ContainerEngine) ContainerPrune(ctx context.Context, options entities.ContainerPruneOptions) ([]*reports.PruneReport, error) {
 	filterFuncs := make([]libpod.ContainerFilter, 0, len(options.Filters))
 	for k, v := range options.Filters {
-		generatedFunc, err := dfilters.GenerateContainerFilterFuncs(k, v, ic.Libpod)
+		generatedFunc, err := dfilters.GeneratePruneContainerFilterFuncs(k, v, ic.Libpod)
 		if err != nil {
 			return nil, err
 		}

test/apiv2/20-containers.at

@@ -298,7 +298,7 @@ t POST containers/prune?filters='garb1age}' 500 \
 t POST libpod/containers/prune?filters='garb1age}' 500 \
     .cause="invalid character 'g' looking for beginning of value"
 
-## Prune containers with illformed label
+# Prune containers with illformed label
 t POST containers/prune?filters='{"label":["tes' 500 \
     .cause="unexpected end of JSON input"
 t POST libpod/containers/prune?filters='{"label":["tes' 500 \
@@ -306,6 +306,22 @@ t POST libpod/containers/prune?filters='{"label":["tes' 500 \
 
 t GET libpod/containers/json?filters='{"label":["testlabel"]}' 200 length=0
 
+# libpod api: do not use list filters for prune
+t POST libpod/containers/prune?filters='{"name":["anyname"]}' 500 \
+    .cause="name is an invalid filter"
+t POST libpod/containers/prune?filters='{"id":["anyid"]}' 500 \
+    .cause="id is an invalid filter"
+t POST libpod/containers/prune?filters='{"network":["anynetwork"]}' 500 \
+    .cause="network is an invalid filter"
+
+# compat api: do not use list filters for prune
+t POST containers/prune?filters='{"name":["anyname"]}' 500 \
+    .cause="name is an invalid filter"
+t POST containers/prune?filters='{"id":["anyid"]}' 500 \
+    .cause="id is an invalid filter"
+t POST containers/prune?filters='{"network":["anynetwork"]}' 500 \
+    .cause="network is an invalid filter"
+
 # Test CPU limit (NanoCPUs)
 t POST containers/create Image=$IMAGE HostConfig='{"NanoCpus":500000}' 201 \
   .Id~[0-9a-f]\\{64\\}