Merge pull request #3316 from austinvazquez/add-builder-prune-all

Add builder prune --all and --force flag support

cmd/nerdctl/builder.go

@@ -22,11 +22,11 @@ import (
 	"os/exec"
 	"strings"
 
+	"github.com/docker/go-units"
 	"github.com/spf13/cobra"
 
-	"github.com/containerd/log"
-
-	"github.com/containerd/nerdctl/v2/pkg/buildkitutil"
+	"github.com/containerd/nerdctl/v2/pkg/api/types"
+	"github.com/containerd/nerdctl/v2/pkg/cmd/builder"
 )
 
 func newBuilderCommand() *cobra.Command {
@@ -58,29 +58,83 @@ func newBuilderPruneCommand() *cobra.Command {
 	}
 
 	AddStringFlag(buildPruneCommand, "buildkit-host", nil, "", "BUILDKIT_HOST", "BuildKit address")
+
+	buildPruneCommand.Flags().BoolP("all", "a", false, "Remove all unused build cache, not just dangling ones")
+	buildPruneCommand.Flags().BoolP("force", "f", false, "Do not prompt for confirmation")
 	return buildPruneCommand
 }
 
 func builderPruneAction(cmd *cobra.Command, _ []string) error {
-	globalOptions, err := processRootCmdFlags(cmd)
+	options, err := processBuilderPruneOptions(cmd)
 	if err != nil {
 		return err
 	}
-	buildkitHost, err := getBuildkitHost(cmd, globalOptions.Namespace)
+
+	if !options.Force {
+		var (
+			confirm string
+			msg     string
+		)
+
+		if options.All {
+			msg = "This will remove all build cache."
+		} else {
+			msg = "This will remove any dangling build cache."
+		}
+		msg += " Are you sure you want to continue? [y/N] "
+
+		fmt.Fprintf(cmd.OutOrStdout(), "WARNING! %s", msg)
+		fmt.Fscanf(cmd.InOrStdin(), "%s", &confirm)
+
+		if strings.ToLower(confirm) != "y" {
+			return nil
+		}
+	}
+
+	prunedObjects, err := builder.Prune(cmd.Context(), options)
 	if err != nil {
 		return err
 	}
-	buildctlBinary, err := buildkitutil.BuildctlBinary()
+
+	var totalReclaimedSpace int64
+
+	for _, prunedObject := range prunedObjects {
+		totalReclaimedSpace += prunedObject.Size
+	}
+
+	fmt.Fprintf(cmd.OutOrStdout(), "Total:  %s\n", units.BytesSize(float64(totalReclaimedSpace)))
+
+	return nil
+}
+
+func processBuilderPruneOptions(cmd *cobra.Command) (types.BuilderPruneOptions, error) {
+	globalOptions, err := processRootCmdFlags(cmd)
+	if err != nil {
+		return types.BuilderPruneOptions{}, err
+	}
+
+	buildkitHost, err := getBuildkitHost(cmd, globalOptions.Namespace)
+	if err != nil {
+		return types.BuilderPruneOptions{}, err
+	}
+
+	all, err := cmd.Flags().GetBool("all")
 	if err != nil {
-		return err
+		return types.BuilderPruneOptions{}, err
 	}
-	buildctlArgs := buildkitutil.BuildctlBaseArgs(buildkitHost)
-	buildctlArgs = append(buildctlArgs, "prune")
-	log.L.Debugf("running %s %v", buildctlBinary, buildctlArgs)
-	buildctlCmd := exec.Command(buildctlBinary, buildctlArgs...)
-	buildctlCmd.Env = os.Environ()
-	buildctlCmd.Stdout = cmd.OutOrStdout()
-	return buildctlCmd.Run()
+
+	force, err := cmd.Flags().GetBool("force")
+	if err != nil {
+		return types.BuilderPruneOptions{}, err
+	}
+
+	return types.BuilderPruneOptions{
+		Stderr:       cmd.OutOrStderr(),
+		GOptions:     globalOptions,
+		BuildKitHost: buildkitHost,
+		All:          all,
+		Force:        force,
+	}, nil
 }
 
 func newBuilderDebugCommand() *cobra.Command {

cmd/nerdctl/builder_build_test.go

@@ -32,8 +32,8 @@ import (
 
 func TestBuild(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -57,8 +57,8 @@ CMD ["echo", "nerdctl-build-test-string"]
 
 func TestBuildIsShareableForCompatiblePlatform(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -87,8 +87,8 @@ CMD ["echo", "nerdctl-build-test-string"]
 // This isn't currently supported by nerdctl with BuildKit OCI worker.
 func TestBuildBaseImage(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 	imageName2 := imageName + "-2"
@@ -122,8 +122,8 @@ CMD ["cat", "/hello2"]
 func TestBuildFromContainerd(t *testing.T) {
 	testutil.DockerIncompatible(t)
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 	imageName2 := imageName + "-2"
@@ -152,8 +152,8 @@ CMD ["cat", "/hello2"]
 
 func TestBuildFromStdin(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -166,8 +166,8 @@ CMD ["echo", "nerdctl-build-test-stdin"]
 
 func TestBuildWithDockerfile(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -198,8 +198,8 @@ CMD ["echo", "nerdctl-build-test-dockerfile"]
 
 func TestBuildLocal(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	const testFileName = "nerdctl-build-test"
 	const testContent = "nerdctl"
 	outputDir := t.TempDir()
@@ -243,8 +243,8 @@ func createBuildContext(t *testing.T, dockerfile string) string {
 
 func TestBuildWithBuildArg(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -288,8 +288,8 @@ CMD echo $TEST_STRING
 
 func TestBuildWithIIDFile(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -312,8 +312,8 @@ CMD ["echo", "nerdctl-build-test-string"]
 
 func TestBuildWithLabels(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 
 	dockerfile := fmt.Sprintf(`FROM %s
@@ -330,8 +330,8 @@ LABEL name=nerdctl-build-test-label
 
 func TestBuildMultipleTags(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	img := testutil.Identifier(t)
 	imgWithNoTag, imgWithCustomTag := fmt.Sprintf("%s%d", img, 2), fmt.Sprintf("%s%d:hello", img, 3)
 	defer base.Cmd("rmi", img).AssertOK()
@@ -354,10 +354,10 @@ func TestBuildMultipleTags(t *testing.T) {
 }
 
 func TestBuildWithContainerfile(t *testing.T) {
-	testutil.RequiresBuild(t)
 	testutil.DockerIncompatible(t)
+	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -375,8 +375,8 @@ CMD ["echo", "nerdctl-build-test-string"]
 
 func TestBuildWithDockerFileAndContainerfile(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 	imageName := testutil.Identifier(t)
 	defer base.Cmd("rmi", imageName).Run()
 
@@ -404,8 +404,8 @@ CMD ["echo", "dockerfile"]
 
 func TestBuildNoTag(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").AssertOK()
 	base.Cmd("image", "prune", "--force", "--all").AssertOK()
 
 	dockerfile := fmt.Sprintf(`FROM %s
@@ -420,8 +420,8 @@ CMD ["echo", "nerdctl-build-notag-string"]
 
 func TestBuildContextDockerImageAlias(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").AssertOK()
 	base.Cmd("image", "prune", "--force", "--all").AssertOK()
 
 	dockerfile := `FROM myorg/myapp
@@ -435,8 +435,8 @@ CMD ["echo", "nerdctl-build-myorg/myapp"]`
 
 func TestBuildContextWithCopyFromDir(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").AssertOK()
 	base.Cmd("image", "prune", "--force", "--all").AssertOK()
 
 	content := "hello_from_dir_2"
@@ -487,8 +487,8 @@ CMD ["cat", "/source-date-epoch"]
 
 func TestBuildNetwork(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").AssertOK()
 
 	dockerfile := fmt.Sprintf(`FROM %s
 RUN apk add --no-cache curl
@@ -540,14 +540,14 @@ func buildWithNamedBuilder(base *testutil.Base, builderName string, args ...stri
 
 func TestBuildAttestation(t *testing.T) {
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
 	builderName := testutil.Identifier(t)
 	if testutil.GetTarget() == testutil.Docker {
 		// create named builder for docker
 		defer base.Cmd("buildx", "rm", builderName).AssertOK()
 		base.Cmd("buildx", "create", "--name", builderName, "--bootstrap", "--use").AssertOK()
 	}
-	defer base.Cmd("builder", "prune").Run()
 
 	dockerfile := "FROM " + testutil.NginxAlpineImage
 	buildCtx := createBuildContext(t, dockerfile)

cmd/nerdctl/builder_linux_test.go

@@ -30,6 +30,39 @@ import (
 	"github.com/containerd/nerdctl/v2/pkg/testutil"
 )
 
+func TestBuilderPrune(t *testing.T) {
+	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
+
+	base := testutil.NewBase(t)
+
+	dockerfile := fmt.Sprintf(`FROM %s
+CMD ["echo", "nerdctl-test-builder-prune"]`, testutil.CommonImage)
+
+	buildCtx := createBuildContext(t, dockerfile)
+
+	testCases := []struct {
+		name        string
+		commandArgs []string
+	}{
+		{
+			name:        "TestBuilderPruneForce",
+			commandArgs: []string{"builder", "prune", "--force"},
+		},
+		{
+			name:        "TestBuilderPruneForceAll",
+			commandArgs: []string{"builder", "prune", "--force", "--all"},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			base.Cmd("build", buildCtx).AssertOK()
+			base.Cmd(tc.commandArgs...).AssertOK()
+		})
+	}
+}
+
 func TestBuilderDebug(t *testing.T) {
 	testutil.DockerIncompatible(t)
 	base := testutil.NewBase(t)
@@ -49,6 +82,7 @@ func TestBuildWithPull(t *testing.T) {
 		t.Skipf("skipped because the test needs a custom buildkitd config")
 	}
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 
 	oldImage := testutil.BusyboxImage
 	oldImageSha := "141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47"
@@ -86,8 +120,8 @@ namespace = "%s"`, testutil.Namespace)
 	for _, tc := range testCases {
 		tc := tc
 		t.Run(tc.name, func(t *testing.T) {
+			testutil.RegisterBuildCacheCleanup(t)
 			base := testutil.NewBase(t)
-			defer base.Cmd("builder", "prune").AssertOK()
 			base.Cmd("image", "prune", "--force", "--all").AssertOK()
 
 			base.Cmd("pull", oldImage).Run()

cmd/nerdctl/compose_build_linux_test.go

@@ -46,8 +46,8 @@ services:
 	dockerfile := fmt.Sprintf(`FROM %s`, testutil.AlpineImage)
 
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 
 	comp := testutil.NewComposeDir(t, dockerComposeYAML)
 	defer comp.CleanUp()

cmd/nerdctl/compose_create_linux_test.go

@@ -116,8 +116,8 @@ services:
 	dockerfile := fmt.Sprintf(`FROM %s`, testutil.AlpineImage)
 
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	base := testutil.NewBase(t)
-	defer base.Cmd("builder", "prune").Run()
 
 	comp := testutil.NewComposeDir(t, dockerComposeYAML)
 	defer comp.CleanUp()

cmd/nerdctl/compose_run_linux_test.go

@@ -426,6 +426,7 @@ func TestComposePushAndPullWithCosignVerify(t *testing.T) {
 	testutil.RequireExecutable(t, "cosign")
 	testutil.DockerIncompatible(t)
 	testutil.RequiresBuild(t)
+	testutil.RegisterBuildCacheCleanup(t)
 	t.Parallel()
 
 	base := testutil.NewBase(t)
@@ -435,7 +436,6 @@ func TestComposePushAndPullWithCosignVerify(t *testing.T) {
 	reg := testregistry.NewWithNoAuth(base, 0, false)
 	t.Cleanup(func() {
 		keyPair.cleanup()
-		base.Cmd("builder", "prune").Run()
 		reg.Cleanup(nil)
 	})