fix(host-cleanup): don't prune dangling werf images for some time (#6767)

Signed-off-by: Alexandr Zaytsev <alexandr.zaytsev@flant.com>

Author: nervgh

Diff for: pkg/buildah/common.go

@@ -15,6 +15,7 @@ import (
 
 	"github.com/werf/common-go/pkg/util"
 	"github.com/werf/werf/v2/pkg/buildah/thirdparty"
+	"github.com/werf/werf/v2/pkg/container_backend/filter"
 	"github.com/werf/werf/v2/pkg/container_backend/info"
 	"github.com/werf/werf/v2/pkg/image"
 	"github.com/werf/werf/v2/pkg/werf"
@@ -102,6 +103,8 @@ type CommitOpts struct {
 
 type PruneImagesOptions struct {
 	CommonOpts
+
+	Filters filter.FilterList
 }
 
 type PruneImagesReport struct {

Diff for: pkg/buildah/native_linux.go

@@ -41,9 +41,12 @@ import (
 	"github.com/containers/storage/pkg/unshare"
 	"github.com/moby/buildkit/frontend/dockerfile/instructions"
 	"github.com/opencontainers/runtime-spec/specs-go"
+	"github.com/samber/lo"
 	"github.com/sirupsen/logrus"
 
+	"github.com/werf/common-go/pkg/util"
 	"github.com/werf/werf/v2/pkg/buildah/thirdparty"
+	"github.com/werf/werf/v2/pkg/container_backend/filter"
 	"github.com/werf/werf/v2/pkg/container_backend/info"
 	"github.com/werf/werf/v2/pkg/image"
 	"github.com/werf/werf/v2/pkg/ssh_agent"
@@ -605,9 +608,14 @@ func (b *NativeBuildah) PruneImages(ctx context.Context, opts PruneImagesOptions
 		return PruneImagesReport{}, err
 	}
 
+	// ensure dangling=true
+	filters := opts.Filters
+	filters.Remove(filter.DanglingFalse)
+	filters.Add(filter.DanglingTrue)
+
 	imageReports, rmiErrors := runtime.RemoveImages(ctx, []string{}, &libimage.RemoveImagesOptions{
 		Force:    false, // not remove containers
-		Filters:  []string{"dangling=true"},
+		Filters:  mapBackendOldFiltersToBuildahImageFilters(filters.ToPairs()),
 		WithSize: true,
 		NoPrune:  false,
 	})
@@ -898,10 +906,10 @@ func (b *NativeBuildah) Images(ctx context.Context, opts ImagesOptions) (image.I
 		return nil, err
 	}
 
-	listOpts := &libimage.ListImagesOptions{}
-	for _, filter := range opts.Filters {
-		listOpts.Filters = append(listOpts.Filters, fmt.Sprintf("%s=%s", filter.First, filter.Second))
+	listOpts := &libimage.ListImagesOptions{
+		Filters: mapBackendOldFiltersToBuildahImageFilters(opts.Filters),
 	}
+
 	images, err := runtime.ListImages(ctx, opts.Names, listOpts)
 	if err != nil {
 		return nil, err
@@ -938,6 +946,13 @@ func (b *NativeBuildah) Images(ctx context.Context, opts ImagesOptions) (image.I
 	return res, nil
 }
 
+// mapBackendOldFiltersToBuildahImageFilters returns filters in key=value format
+func mapBackendOldFiltersToBuildahImageFilters(filters []util.Pair[string, string]) []string {
+	return lo.Map(filters, func(pair util.Pair[string, string], _ int) string {
+		return fmt.Sprintf("%s=%s", pair.First, pair.Second)
+	})
+}
+
 func (b *NativeBuildah) Containers(ctx context.Context, opts ContainersOptions) (image.ContainerList, error) {
 	builders, err := buildah.OpenAllBuilders(b.Store)
 	if err != nil {

Diff for: pkg/buildah/native_linux_test.go

@@ -0,0 +1,30 @@
+package buildah
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/werf/common-go/pkg/util"
+)
+
+var _ = Describe("buildah", func() {
+	DescribeTable("mapBackendOldFiltersToBuildahImageFilters",
+		func(oldFilters []util.Pair[string, string], expectedFilters []string) {
+			actual := mapBackendOldFiltersToBuildahImageFilters(oldFilters)
+			Expect(actual).To(Equal(expectedFilters))
+		},
+		Entry(
+			"should work with empty input",
+			[]util.Pair[string, string]{},
+			[]string{},
+		),
+		Entry(
+			"should work with non-empty input",
+			[]util.Pair[string, string]{
+				util.NewPair("foo", "bar"),
+				util.NewPair("key", "value"),
+			},
+			[]string{"foo=bar", "key=value"},
+		),
+	)
+})

Diff for: pkg/buildah/suite_test.go

@@ -0,0 +1,13 @@
+package buildah
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestBuildah(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Buildah Suite")
+}

Diff for: pkg/container_backend/filter/filter.go

@@ -0,0 +1,18 @@
+package filter
+
+import (
+	"github.com/werf/common-go/pkg/util"
+)
+
+type Filter util.Pair[string, string]
+
+func NewFilter(key, value string) Filter {
+	return Filter{
+		First:  key,
+		Second: value,
+	}
+}
+
+func (f *Filter) ToPair() util.Pair[string, string] {
+	return util.NewPair(f.First, f.Second)
+}

Diff for: pkg/container_backend/filter/filter_list.go

@@ -0,0 +1,27 @@
+package filter
+
+import (
+	"slices"
+
+	"github.com/samber/lo"
+
+	"github.com/werf/common-go/pkg/util"
+)
+
+type FilterList []Filter
+
+func (list *FilterList) Add(filter Filter) {
+	*list = lo.Uniq(append(*list, filter))
+}
+
+func (list *FilterList) Remove(filter Filter) {
+	*list = slices.DeleteFunc(*list, func(f Filter) bool {
+		return f == filter
+	})
+}
+
+func (list *FilterList) ToPairs() []util.Pair[string, string] {
+	return lo.Map(*list, func(f Filter, _ int) util.Pair[string, string] {
+		return f.ToPair()
+	})
+}

Diff for: pkg/container_backend/filter/filter_list_test.go

@@ -0,0 +1,60 @@
+package filter_test
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/werf/werf/v2/pkg/container_backend/filter"
+)
+
+var _ = Describe("FilterList", func() {
+	DescribeTable("Add",
+		func(list filter.FilterList, item filter.Filter, expectedList filter.FilterList) {
+			list.Add(item)
+			Expect(list).To(Equal(expectedList))
+		},
+		Entry(
+			"should modify list in place",
+			filter.FilterList{},
+			filter.NewFilter("foo", "bar"),
+			filter.FilterList{
+				filter.NewFilter("foo", "bar"),
+			},
+		),
+		Entry(
+			"should prevent duplication",
+			filter.FilterList{
+				filter.NewFilter("foo", "bar"),
+			},
+			filter.NewFilter("foo", "bar"),
+			filter.FilterList{
+				filter.NewFilter("foo", "bar"),
+			},
+		),
+	)
+
+	DescribeTable("Remove",
+		func(list filter.FilterList, item filter.Filter, expectedList filter.FilterList) {
+			list.Remove(item)
+			Expect(list).To(Equal(expectedList))
+		},
+		Entry(
+			"should not modify list if item not found",
+			filter.FilterList{
+				filter.NewFilter("foo", "bar"),
+			},
+			filter.NewFilter("foo", "1"),
+			filter.FilterList{
+				filter.NewFilter("foo", "bar"),
+			},
+		),
+		Entry(
+			"should remove item from the list if found",
+			filter.FilterList{
+				filter.NewFilter("foo", "bar"),
+			},
+			filter.NewFilter("foo", "bar"),
+			filter.FilterList{},
+		),
+	)
+})

Diff for: pkg/container_backend/filter/image.go

@@ -0,0 +1,6 @@
+package filter
+
+var (
+	DanglingTrue  = NewFilter("dangling", "true")
+	DanglingFalse = NewFilter("dangling", "false")
+)

Diff for: pkg/container_backend/filter/suite_test.go

@@ -0,0 +1,13 @@
+package filter
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestFilter(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Filter Suite")
+}

Diff for: pkg/container_backend/prune/prune.go

@@ -1,9 +1,11 @@
 package prune
 
-import "github.com/werf/common-go/pkg/util"
+import (
+	"github.com/werf/werf/v2/pkg/container_backend/filter"
+)
 
 type Options struct {
-	Filters []util.Pair[string, string]
+	Filters filter.FilterList
 }
 
 type Report struct {

Diff for: pkg/docker/image.go

@@ -20,8 +20,8 @@ import (
 	"github.com/spf13/cobra"
 	"golang.org/x/net/context"
 
-	"github.com/werf/common-go/pkg/util"
 	"github.com/werf/logboek"
+	"github.com/werf/werf/v2/pkg/container_backend/filter"
 	"github.com/werf/werf/v2/pkg/container_backend/prune"
 )
 
@@ -78,7 +78,7 @@ type (
 // ImagesPrune containers using opts.Filters.
 // List of accepted filters is there https://github.com/moby/moby/blob/25.0/daemon/containerd/image_prune.go#L22
 func ImagesPrune(ctx context.Context, opts ImagesPruneOptions) (ImagesPruneReport, error) {
-	report, err := apiCli(ctx).ImagesPrune(ctx, mapImagesPruneOptionsToImagesPruneFilters(opts))
+	report, err := apiCli(ctx).ImagesPrune(ctx, mapBackendFiltersToImagesPruneFilters(opts.Filters))
 	if err != nil {
 		return ImagesPruneReport{}, err
 	}
@@ -91,9 +91,9 @@ func ImagesPrune(ctx context.Context, opts ImagesPruneOptions) (ImagesPruneRepor
 	}, err
 }
 
-func mapImagesPruneOptionsToImagesPruneFilters(opts ImagesPruneOptions) filters.Args {
-	args := lo.Map(opts.Filters, func(pair util.Pair[string, string], _ int) filters.KeyValuePair {
-		return filters.Arg(pair.First, pair.Second)
+func mapBackendFiltersToImagesPruneFilters(list filter.FilterList) filters.Args {
+	args := lo.Map(list, func(filter filter.Filter, _ int) filters.KeyValuePair {
+		return filters.Arg(filter.First, filter.Second)
 	})
 	return filters.NewArgs(args...)
 }

Diff for: pkg/docker/image_test.go

@@ -5,13 +5,13 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
-	"github.com/werf/common-go/pkg/util"
+	"github.com/werf/werf/v2/pkg/container_backend/filter"
 )
 
 var _ = Describe("docker images", func() {
-	DescribeTable("mapImagesPruneOptionsToImagesPruneFilters",
+	DescribeTable("mapBackendFiltersToImagesPruneFilters",
 		func(opts ImagesPruneOptions, expected filters.Args) {
-			actual := mapImagesPruneOptionsToImagesPruneFilters(opts)
+			actual := mapBackendFiltersToImagesPruneFilters(opts.Filters)
 			Expect(actual).To(Equal(expected))
 		},
 		Entry(
@@ -21,8 +21,8 @@ var _ = Describe("docker images", func() {
 		),
 		Entry("should work with 'label' filter",
 			ImagesPruneOptions{
-				Filters: []util.Pair[string, string]{
-					util.NewPair("label", "foo=bar"),
+				Filters: filter.FilterList{
+					filter.NewFilter("label", "foo=bar"),
 				},
 			},
 			filters.NewArgs(