Merge pull request #4447 from ChengyuZhu6/manifest-rm

manifest: support nerdctl manifest rm command

Author: AkihiroSuda

cmd/nerdctl/manifest/manifest.go

@@ -36,6 +36,7 @@ func Command() *cobra.Command {
 		InspectCommand(),
 		CreateCommand(),
 		AnnotateCommand(),
+		RemoveCommand(),
 	)
 
 	return cmd

cmd/nerdctl/manifest/manifest_remove.go

@@ -0,0 +1,59 @@
+/*
+   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 manifest
+
+import (
+	"errors"
+
+	"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/cmd/manifest"
+)
+
+func RemoveCommand() *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:               "rm INDEX/MANIFESTLIST [INDEX/MANIFESTLIST...]",
+		Short:             "Remove one or more index/manifest lists",
+		Args:              cobra.MinimumNArgs(1),
+		RunE:              removeAction,
+		ValidArgsFunction: removeShellComplete,
+		SilenceUsage:      true,
+		SilenceErrors:     true,
+	}
+	return cmd
+}
+
+func removeAction(cmd *cobra.Command, refs []string) error {
+	globalOptions, err := helpers.ProcessRootCmdFlags(cmd)
+	if err != nil {
+		return err
+	}
+	var errs []error
+	for _, ref := range refs {
+		err := manifest.Remove(cmd.Context(), ref, globalOptions)
+		if err != nil {
+			errs = append(errs, err)
+		}
+	}
+	return errors.Join(errs...)
+}
+
+func removeShellComplete(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	return completion.ImageNames(cmd)
+}

cmd/nerdctl/manifest/manifest_remove_linux_test.go

@@ -0,0 +1,68 @@
+/*
+   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 manifest
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/containerd/nerdctl/mod/tigron/test"
+
+	"github.com/containerd/nerdctl/v2/pkg/testutil"
+	"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
+)
+
+func TestManifestsRemove(t *testing.T) {
+	testCase := nerdtest.Setup()
+	manifestListName1 := "example.com/test-list-remove:v1"
+	manifestListName2 := "example.com/test-list-remove:v2"
+	manifestRef1 := testutil.GetTestImageWithoutTag("alpine") + "@" + testutil.GetTestImageManifestDigest("alpine", "linux/amd64")
+	manifestRef2 := testutil.GetTestImageWithoutTag("alpine") + "@" + testutil.GetTestImageManifestDigest("alpine", "linux/arm64")
+
+	testCase.SubTests = []*test.Case{
+		{
+			Description: "remove-several-manifestlists",
+			Setup: func(data test.Data, helpers test.Helpers) {
+				cmd := helpers.Command("manifest", "create", manifestListName1, manifestRef1)
+				cmd.Run(&test.Expected{ExitCode: 0})
+				cmd = helpers.Command("manifest", "create", manifestListName2, manifestRef2)
+				cmd.Run(&test.Expected{ExitCode: 0})
+			},
+			Command: test.Command("manifest", "rm", manifestListName1, manifestListName2),
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 0,
+				}
+			},
+		},
+		{
+			Description: "remove-non-existent-manifestlist",
+			Command:     test.Command("manifest", "rm", "example.com/non-existent:latest"),
+			Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
+				return &test.Expected{
+					ExitCode: 1,
+					Errors:   []error{errors.New(data.Labels().Get("error"))},
+				}
+			},
+			Data: test.WithLabels(map[string]string{
+				"error": "No such manifest: example.com/non-existent:latest",
+			}),
+		},
+	}
+
+	testCase.Run(t)
+}

docs/command-reference.md

@@ -55,6 +55,7 @@ It does not necessarily mean that the corresponding features are missing in cont
   - [:whale: nerdctl manifest annotate](#whale-nerdctl-manifest-annotate)
   - [:whale: nerdctl manifest create](#whale-nerdctl-manifest-create)
   - [:whale: nerdctl manifest inspect](#whale-nerdctl-manifest-inspect)
+  - [:whale: nerdctl manifest rm](#whale-nerdctl-manifest-rm)
 - [Registry](#registry)
   - [:whale: nerdctl login](#whale-nerdctl-login)
   - [:whale: nerdctl logout](#whale-nerdctl-logout)
@@ -1102,6 +1103,18 @@ nerdctl manifest inspect alpine:3.22.1
 nerdctl manifest inspect alpine@sha256:eafc1edb577d2e9b458664a15f23ea1c370214193226069eb22921169fc7e43f
 ```
 
+### :whale: nerdctl manifest rm
+
+Remove one or more index/manifest lists.
+
+Usage: `nerdctl manifest rm INDEX/MANIFESTLIST [INDEX/MANIFESTLIST...]`
+
+Example:
+
+```bash
+nerdctl manifest rm alpine:3.22.1 alpine:3.22.2
+```
+
 ## Registry
 
 ### :whale: nerdctl login

pkg/cmd/manifest/rm.go

@@ -0,0 +1,51 @@
+/*
+   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 manifest
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/containerd/nerdctl/v2/pkg/api/types"
+	"github.com/containerd/nerdctl/v2/pkg/manifeststore"
+	"github.com/containerd/nerdctl/v2/pkg/manifestutil"
+	"github.com/containerd/nerdctl/v2/pkg/referenceutil"
+)
+
+func Remove(ctx context.Context, ref string, options types.GlobalCommandOptions) error {
+	parsedRef, err := referenceutil.Parse(ref)
+	if err != nil {
+		return fmt.Errorf("failed to parse reference: %w", err)
+	}
+	manifestStore, err := manifeststore.NewStore(options.DataRoot)
+	if err != nil {
+		return fmt.Errorf("failed to create manifest store: %w", err)
+	}
+	_, err = manifestStore.GetList(parsedRef)
+	if err != nil {
+		if strings.Contains(err.Error(), "not found") {
+			return manifestutil.NewNoSuchManifestError(parsedRef.String())
+		}
+		return err
+	}
+	err = manifestStore.Remove(parsedRef)
+	if err != nil {
+		return fmt.Errorf("failed to remove manifest list: %w", err)
+	}
+	return nil
+}

pkg/manifeststore/manifeststore.go

@@ -33,6 +33,8 @@ type Store interface {
 	GetList(listRef *referenceutil.ImageReference) ([]*manifesttypes.DockerManifestEntry, error)
 	// Save saves a manifest as part of a index or local manifest list
 	Save(listRef, manifestRef *referenceutil.ImageReference, manifest *manifesttypes.DockerManifestEntry) error
+	// Remove removes a index or local manifest list
+	Remove(listRef *referenceutil.ImageReference) error
 }
 
 type manifestStore struct {
@@ -103,6 +105,13 @@ func (s *manifestStore) Save(listRef, manifestRef *referenceutil.ImageReference,
 	})
 }
 
+func (s *manifestStore) Remove(listRef *referenceutil.ImageReference) error {
+	return s.store.WithLock(func() error {
+		listPath := makeFilesafeName(listRef.String())
+		return s.store.Delete(listPath)
+	})
+}
+
 func (s *manifestStore) getManifestFromPath(listPath, manifestPath string) (*manifesttypes.DockerManifestEntry, error) {
 	data, err := s.store.Get(listPath, manifestPath)
 	if err != nil {

pkg/manifestutil/manifestutils.go

@@ -45,6 +45,20 @@ var manifestParsers = map[string]manifestParser{
 	ocispec.MediaTypeImageIndex:               parseOCIIndex,
 }
 
+// NoSuchManifestError represents an error when a manifest is not found
+type NoSuchManifestError struct {
+	Ref string
+}
+
+func (e *NoSuchManifestError) Error() string {
+	return fmt.Sprintf("No such manifest: %s", e.Ref)
+}
+
+// NewNoSuchManifestError creates a new NoSuchManifestError
+func NewNoSuchManifestError(ref string) error {
+	return &NoSuchManifestError{Ref: ref}
+}
+
 // ParseManifest parses manifest data based on media type
 func ParseManifest(mediaType string, data []byte) (interface{}, error) {
 	if parser, exists := manifestParsers[mediaType]; exists {

pkg/testutil/images.yaml

@@ -15,6 +15,8 @@ alpine:
       manifest: "sha256:e103c1b4bf019dc290bcc7aca538dc2bf7a9d0fc836e186f5fa34945c5168310"
       config: "sha256:49f356fa4513676c5e22e3a8404aad6c7262cc7aaed15341458265320786c58c"
       raw: "ewogICAic2NoZW1hVmVyc2lvbiI6IDIsCiAgICJtZWRpYVR5cGUiOiAiYXBwbGljYXRpb24vdm5kLmRvY2tlci5kaXN0cmlidXRpb24ubWFuaWZlc3QudjIranNvbiIsCiAgICJjb25maWciOiB7CiAgICAgICJtZWRpYVR5cGUiOiAiYXBwbGljYXRpb24vdm5kLmRvY2tlci5jb250YWluZXIuaW1hZ2UudjEranNvbiIsCiAgICAgICJzaXplIjogMTQ3MiwKICAgICAgImRpZ2VzdCI6ICJzaGEyNTY6NDlmMzU2ZmE0NTEzNjc2YzVlMjJlM2E4NDA0YWFkNmM3MjYyY2M3YWFlZDE1MzQxNDU4MjY1MzIwNzg2YzU4YyIKICAgfSwKICAgImxheWVycyI6IFsKICAgICAgewogICAgICAgICAibWVkaWFUeXBlIjogImFwcGxpY2F0aW9uL3ZuZC5kb2NrZXIuaW1hZ2Uucm9vdGZzLmRpZmYudGFyLmd6aXAiLAogICAgICAgICAic2l6ZSI6IDI4MTE5NDcsCiAgICAgICAgICJkaWdlc3QiOiAic2hhMjU2OmNhM2NkNDJhN2M5NTI1ZjZjZTNkNjRjMWE3MDk4MjYxM2E4MjM1ZjBjYzA1N2VjOTI0NDA1MjkyMTg1M2VmMTUiCiAgICAgIH0KICAgXQp9"
+    linux/arm64:
+      manifest: "sha256:071fa5de01a240dbef5be09d69f8fef2f89d68445d9175393773ee389b6f5935"
 
 busybox:
   ref: "ghcr.io/containerd/busybox"