Merge pull request #4562 from ChengyuZhu6/checkpoint-rm

checkpoint: support checkpoint rm command

Author: AkihiroSuda

cmd/nerdctl/checkpoint/checkpoint.go

@@ -33,16 +33,23 @@ func Command() *cobra.Command {
 	}
 
 	cmd.AddCommand(
-		CreateCommand(),
-		checkpointLsCommand(),
+		createCommand(),
+		lsCommand(),
+		rmCommand(),
 	)
 
 	return cmd
 }
 
-func checkpointLsCommand() *cobra.Command {
-	x := ListCommand()
+func lsCommand() *cobra.Command {
+	x := listCommand()
 	x.Use = "ls"
 	x.Aliases = []string{"list"}
 	return x
 }
+func rmCommand() *cobra.Command {
+	x := removeCommand()
+	x.Use = "rm"
+	x.Aliases = []string{"remove"}
+	return x
+}

cmd/nerdctl/checkpoint/checkpoint_create.go

@@ -28,7 +28,7 @@ import (
 	"github.com/containerd/nerdctl/v2/pkg/cmd/checkpoint"
 )
 
-func CreateCommand() *cobra.Command {
+func createCommand() *cobra.Command {
 	var cmd = &cobra.Command{
 		Use:               "create [OPTIONS] CONTAINER CHECKPOINT",
 		Short:             "Create a checkpoint from a running container",

cmd/nerdctl/checkpoint/checkpoint_create_linux_test.go

@@ -83,6 +83,7 @@ func TestCheckpointCreate(t *testing.T) {
 		// The issue is tracked in the moby/moby project as https://github.com/moby/moby/issues/50750.
 		require.Not(nerdtest.Docker),
 	)
+	testCase.NoParallel = true
 	testCase.SubTests = []*test.Case{
 		{
 			Description: "leave-running=true",

cmd/nerdctl/checkpoint/checkpoint_list.go

@@ -29,7 +29,7 @@ import (
 	"github.com/containerd/nerdctl/v2/pkg/cmd/checkpoint"
 )
 
-func ListCommand() *cobra.Command {
+func listCommand() *cobra.Command {
 	var cmd = &cobra.Command{
 		Use:               "list [OPTIONS] CONTAINER",
 		Short:             "List checkpoints for a container",

cmd/nerdctl/checkpoint/checkpoint_list_linux_test.go

@@ -80,15 +80,14 @@ func TestCheckpointList(t *testing.T) {
 		// The issue is tracked in the moby/moby project as https://github.com/moby/moby/issues/50750.
 		require.Not(nerdtest.Docker),
 	)
-
+	testCase.NoParallel = true
 	testCase.Setup = func(data test.Data, helpers test.Helpers) {
 		helpers.Ensure("run", "-d", "--name", data.Identifier(), testutil.CommonImage, "sleep", "infinity")
 		helpers.Ensure("checkpoint", "create", data.Identifier(), checkpointName)
 	}
 
 	testCase.Cleanup = func(data test.Data, helpers test.Helpers) {
 		helpers.Anyhow("rm", "-f", data.Identifier())
-		helpers.Anyhow("rmi", "-f", testutil.CommonImage)
 	}
 
 	testCase.Command = func(data test.Data, helpers test.Helpers) test.TestableCommand {

cmd/nerdctl/checkpoint/checkpoint_remove.go

@@ -0,0 +1,87 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package checkpoint
+
+import (
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+
+	"github.com/containerd/nerdctl/v2/cmd/nerdctl/completion"
+	"github.com/containerd/nerdctl/v2/cmd/nerdctl/helpers"
+	"github.com/containerd/nerdctl/v2/pkg/api/types"
+	"github.com/containerd/nerdctl/v2/pkg/clientutil"
+	"github.com/containerd/nerdctl/v2/pkg/cmd/checkpoint"
+)
+
+func removeCommand() *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:               "rm [OPTIONS] CONTAINER CHECKPOINT",
+		Short:             "Remove a checkpoint",
+		Args:              cobra.ExactArgs(2),
+		RunE:              removeAction,
+		ValidArgsFunction: removeShellComplete,
+		SilenceUsage:      true,
+		SilenceErrors:     true,
+	}
+	cmd.Flags().String("checkpoint-dir", "", "Checkpoint directory")
+	return cmd
+}
+
+func processRemoveFlags(cmd *cobra.Command) (types.CheckpointRemoveOptions, error) {
+	globalOptions, err := helpers.ProcessRootCmdFlags(cmd)
+	if err != nil {
+		return types.CheckpointRemoveOptions{}, err
+	}
+
+	checkpointDir, err := cmd.Flags().GetString("checkpoint-dir")
+	if err != nil {
+		return types.CheckpointRemoveOptions{}, err
+	}
+	if checkpointDir == "" {
+		checkpointDir = filepath.Join(globalOptions.DataRoot, "checkpoints")
+	}
+
+	return types.CheckpointRemoveOptions{
+		Stdout:        cmd.OutOrStdout(),
+		GOptions:      globalOptions,
+		CheckpointDir: checkpointDir,
+	}, nil
+}
+
+func removeAction(cmd *cobra.Command, args []string) error {
+	removeOptions, err := processRemoveFlags(cmd)
+	if err != nil {
+		return err
+	}
+	client, ctx, cancel, err := clientutil.NewClient(cmd.Context(), removeOptions.GOptions.Namespace, removeOptions.GOptions.Address)
+	if err != nil {
+		return err
+	}
+	defer cancel()
+
+	err = checkpoint.Remove(ctx, client, args[0], args[1], removeOptions)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func removeShellComplete(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	return completion.ImageNames(cmd)
+}

cmd/nerdctl/checkpoint/checkpoint_remove_linux_test.go

@@ -0,0 +1,128 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package checkpoint
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/containerd/nerdctl/mod/tigron/expect"
+	"github.com/containerd/nerdctl/mod/tigron/require"
+	"github.com/containerd/nerdctl/mod/tigron/test"
+
+	"github.com/containerd/nerdctl/v2/pkg/testutil"
+	"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
+)
+
+func TestCheckpointRemoveErrors(t *testing.T) {
+	testCase := nerdtest.Setup()
+
+	testCase.Require = require.All(
+		require.Not(nerdtest.Rootless),
+		// Docker version 28.x has a known regression that breaks Checkpoint/Restore functionality.
+		// The issue is tracked in the moby/moby project as https://github.com/moby/moby/issues/50750.
+		require.Not(nerdtest.Docker),
+	)
+	testCase.SubTests = []*test.Case{
+		{
+			Description: "too-few-arguments",
+			Command:     test.Command("checkpoint", "rm", "too-few-arguments"),
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 1,
+				}
+			},
+		},
+		{
+			Description: "too-many-arguments",
+			Command:     test.Command("checkpoint", "rm", "too", "many", "arguments"),
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 1,
+				}
+			},
+		},
+		{
+			Description: "invalid-container-id",
+			Command:     test.Command("checkpoint", "rm", "foo", "bar"),
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 1,
+					Errors:   []error{errors.New("error removing checkpoint for container: foo")},
+				}
+			},
+		},
+	}
+
+	testCase.Run(t)
+}
+
+func TestCheckpointRemove(t *testing.T) {
+	const (
+		checkpointName = "checkpoint-remove"
+		checkpointDir  = "/dir/remove"
+	)
+	testCase := nerdtest.Setup()
+	testCase.Require = require.All(
+		require.Not(nerdtest.Rootless),
+		// Docker version 28.x has a known regression that breaks Checkpoint/Restore functionality.
+		// The issue is tracked in the moby/moby project as https://github.com/moby/moby/issues/50750.
+		require.Not(nerdtest.Docker),
+	)
+	testCase.NoParallel = true
+	testCase.SubTests = []*test.Case{
+		{
+			Description: "remove-existing",
+			Setup: func(data test.Data, helpers test.Helpers) {
+				helpers.Ensure("run", "-d", "--name", data.Identifier("container-running-remove"), testutil.CommonImage, "sleep", "infinity")
+				helpers.Ensure("checkpoint", "create", "--checkpoint-dir", checkpointDir, data.Identifier("container-running-remove"), checkpointName)
+			},
+			Cleanup: func(data test.Data, helpers test.Helpers) {
+				helpers.Anyhow("rm", "-f", data.Identifier("container-running-remove"))
+			},
+			Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
+				return helpers.Command("checkpoint", "rm", "--checkpoint-dir", checkpointDir, data.Identifier("container-running-remove"), checkpointName)
+			},
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 0,
+					Output:   expect.Equals(""),
+				}
+			},
+		},
+		{
+			Description: "remove-nonexistent-checkpoint",
+			Setup: func(data test.Data, helpers test.Helpers) {
+				helpers.Ensure("run", "-d", "--name", data.Identifier("container-clean-remove"), testutil.CommonImage, "sleep", "infinity")
+			},
+			Cleanup: func(data test.Data, helpers test.Helpers) {
+				helpers.Anyhow("rm", "-f", data.Identifier("container-clean-remove"))
+			},
+			Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
+				return helpers.Command("checkpoint", "rm", "--checkpoint-dir", checkpointDir, data.Identifier("container-clean-remove"), checkpointName)
+			},
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 1,
+					Errors:   []error{errors.New("checkpoint " + checkpointName + " does not exist for container")},
+				}
+			},
+		},
+	}
+
+	testCase.Run(t)
+}

docs/command-reference.md

@@ -56,6 +56,7 @@
 - [Checkpoint management](#checkpoint-management)
   - [:whale: nerdctl checkpoint create](#whale-nerdctl-checkpoint-create)
   - [:whale: nerdctl checkpoint list](#whale-nerdctl-checkpoint-list)
+  - [:whale: nerdctl checkpoint remove](#whale-nerdctl-checkpoint-remove)
 - [Manifest management](#manifest-management)
   - [:whale: nerdctl manifest annotate](#whale-nerdctl-manifest-annotate)
   - [:whale: nerdctl manifest create](#whale-nerdctl-manifest-create)
@@ -1086,6 +1087,15 @@ Usage: `nerdctl checkpoint list/ls [OPTIONS] CONTAINER`
 Flags:
 - :whale: `checkpoint-dir`: Use a custom checkpoint storage directory
 
+### :whale: nerdctl checkpoint remove
+
+Remove a checkpoint for a container
+
+Usage: `nerdctl checkpoint remove/rm [OPTIONS] CONTAINER CHECKPOINT`
+
+Flags:
+- :whale: `checkpoint-dir`: Use a custom checkpoint storage directory
+
 ## Manifest management
 
 ### :whale: nerdctl manifest annotate
@@ -1958,7 +1968,6 @@ See [`./config.md`](./config.md).
 Container management:
 
 - `docker diff`
-- `docker checkpoint *`
 
 Image:
 

pkg/api/types/checkpoint_types.go

@@ -35,6 +35,13 @@ type CheckpointListOptions struct {
 	CheckpointDir string
 }
 
+// CheckpointRemoveOptions specifies options for `nerdctl checkpoint rm`.
+type CheckpointRemoveOptions struct {
+	Stdout   io.Writer
+	GOptions GlobalCommandOptions
+	// Checkpoint directory
+	CheckpointDir string
+}
 type CheckpointSummary struct {
 	// Name is the name of the checkpoint.
 	Name string

pkg/cmd/checkpoint/remove.go

@@ -0,0 +1,58 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package checkpoint
+
+import (
+	"context"
+	"fmt"
+	"os"
+
+	containerd "github.com/containerd/containerd/v2/client"
+
+	"github.com/containerd/nerdctl/v2/pkg/api/types"
+	"github.com/containerd/nerdctl/v2/pkg/checkpointutil"
+	"github.com/containerd/nerdctl/v2/pkg/idutil/containerwalker"
+)
+
+func Remove(ctx context.Context, client *containerd.Client, containerID string, checkpointName string, options types.CheckpointRemoveOptions) error {
+	var container containerd.Container
+
+	walker := &containerwalker.ContainerWalker{
+		Client: client,
+		OnFound: func(ctx context.Context, found containerwalker.Found) error {
+			if found.MatchCount > 1 {
+				return fmt.Errorf("multiple containers found with provided prefix: %s", found.Req)
+			}
+			container = found.Container
+			return nil
+		},
+	}
+
+	n, err := walker.Walk(ctx, containerID)
+	if err != nil {
+		return err
+	} else if n == 0 {
+		return fmt.Errorf("error removing checkpoint for container: %s, no such container", containerID)
+	}
+
+	targetPath, err := checkpointutil.GetCheckpointDir(options.CheckpointDir, checkpointName, container.ID(), false)
+	if err != nil {
+		return err
+	}
+
+	return os.RemoveAll(targetPath)
+}