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

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

Author: nervgh

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

@@ -1,6 +1,10 @@
 package prune
 
-type Options struct{}
+import "github.com/werf/common-go/pkg/util"
+
+type Options struct {
+	Filters []util.Pair[string, string]
+}
 
 type Report struct {
 	ItemsDeleted   []string

Diff for: pkg/docker/image.go

@@ -20,6 +20,7 @@ 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/prune"
 )
@@ -74,8 +75,10 @@ type (
 	ImagesPruneReport  prune.Report
 )
 
-func ImagesPrune(ctx context.Context, _ ImagesPruneOptions) (ImagesPruneReport, error) {
-	report, err := apiCli(ctx).ImagesPrune(ctx, filters.NewArgs())
+// 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))
 	if err != nil {
 		return ImagesPruneReport{}, err
 	}
@@ -88,6 +91,13 @@ func ImagesPrune(ctx context.Context, _ ImagesPruneOptions) (ImagesPruneReport,
 	}, 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)
+	})
+	return filters.NewArgs(args...)
+}
+
 func doCliPull(c command.Cli, args ...string) error {
 	return prepareCliCmd(image.NewPullCommand(c), args...).Execute()
 }

Diff for: pkg/docker/image_test.go

@@ -0,0 +1,33 @@
+package docker
+
+import (
+	"github.com/docker/docker/api/types/filters"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/werf/common-go/pkg/util"
+)
+
+var _ = Describe("docker images", func() {
+	DescribeTable("mapImagesPruneOptionsToImagesPruneFilters",
+		func(opts ImagesPruneOptions, expected filters.Args) {
+			actual := mapImagesPruneOptionsToImagesPruneFilters(opts)
+			Expect(actual).To(Equal(expected))
+		},
+		Entry(
+			"should work with empty filters",
+			ImagesPruneOptions{},
+			filters.NewArgs(),
+		),
+		Entry("should work with 'label' filter",
+			ImagesPruneOptions{
+				Filters: []util.Pair[string, string]{
+					util.NewPair("label", "foo=bar"),
+				},
+			},
+			filters.NewArgs(
+				filters.Arg("label", "foo=bar"),
+			),
+		),
+	)
+})

Diff for: pkg/host_cleaning/local_backend_cleaner.go

@@ -492,7 +492,13 @@ func (cleaner *LocalBackendCleaner) pruneImages(ctx context.Context, options Run
 		return mapImageListToCleanupReport(list), nil
 	}
 
-	report, err := cleaner.backend.PruneImages(ctx, prune.Options{})
+	report, err := cleaner.backend.PruneImages(ctx, prune.Options{
+		// werf relies on a "dangling" image for some time before tagging its image.
+		// Guard dangling images for "werf build" with Stapel.
+		Filters: []util.Pair[string, string]{
+			util.NewPair("label!", image.WerfLabel),
+		},
+	})
 	return mapPruneReportToCleanupReport(report), err
 }
 

Diff for: pkg/host_cleaning/local_backend_cleaner_test.go

@@ -125,7 +125,11 @@ var _ = Describe("LocalBackendCleaner", func() {
 			Expect(report).To(Equal(newCleanupReport()))
 		})
 		It("should call backend.PruneImages() if opts.DryRun=false", func() {
-			backend.EXPECT().PruneImages(ctx, prune.Options{}).Return(prune.Report{}, nil)
+			imagesFilters := []util.Pair[string, string]{
+				util.NewPair("label!", image.WerfLabel),
+			}
+
+			backend.EXPECT().PruneImages(ctx, prune.Options{Filters: imagesFilters}).Return(prune.Report{}, nil)
 
 			report, err := cleaner.pruneImages(ctx, RunGCOptions{})
 			Expect(err).To(Succeed())
@@ -322,12 +326,16 @@ var _ = Describe("LocalBackendCleaner", func() {
 				{ID: "one", RepoDigests: []string{"digest one"}},
 			}
 
+			imagesFilters := []util.Pair[string, string]{
+				util.NewPair("label!", image.WerfLabel),
+			}
+
 			// keep orders of backend calls
 			gomock.InOrder(
 				// use backend native GC pruning
 				backend.EXPECT().PruneContainers(ctx, prune.Options{}).Return(prune.Report{}, nil),
 				backend.EXPECT().PruneVolumes(ctx, prune.Options{}).Return(prune.Report{}, nil),
-				backend.EXPECT().PruneImages(ctx, prune.Options{}).Return(prune.Report{}, nil),
+				backend.EXPECT().PruneImages(ctx, prune.Options{Filters: imagesFilters}).Return(prune.Report{}, nil),
 
 				// list and remove werf containers
 				backend.EXPECT().Containers(ctx, buildContainersOptions(