c8d: Improve error message for platform not found

vvoland · vvoland · commit 23d565cae39c · 2024-08-05T14:30:08.000+02:00
Return a similar error as the graphdrivers implementation when an image
was found, but the requested platform is not present locally or in the
image.

The message doesn't include the "actual" platform, as it doesn't make
sense with the multi-platform images. With graphdrivers all images were
single platform.

Signed-off-by: Paweł Gronowski &lt;pawel.gronowski@docker.com&gt;
diff --git a/daemon/containerd/image.go b/daemon/containerd/image.go
@@ -25,17 +25,46 @@ import (
 
 var errInconsistentData error = errors.New("consistency error: data changed during operation, retry")
 
+type errPlatformNotFound struct {
+	wanted   ocispec.Platform
+	imageRef string
+}
+
+func (e *errPlatformNotFound) NotFound() {}
+func (e *errPlatformNotFound) Error() string {
+	msg := "image with reference " + e.imageRef + " was found but does not match the specified platform"
+	if e.wanted.OS != "" {
+		msg += ": wanted " + platforms.Format(e.wanted)
+	}
+	return msg
+}
+
 // GetImage returns an image corresponding to the image referred to by refOrID.
 func (i *ImageService) GetImage(ctx context.Context, refOrID string, options backend.GetImageOpts) (*image.Image, error) {
 	img, err := i.resolveImage(ctx, refOrID)
 	if err != nil {
 		return nil, err
 	}
+
 	pm := matchAllWithPreference(platforms.Default())
 	if options.Platform != nil {
 		pm = platforms.OnlyStrict(*options.Platform)
 	}
-	return i.getImageV1(ctx, img, pm)
+
+	imgV1, err := i.getImageV1(ctx, img, pm)
+	if err != nil {
+		var e *errPlatformNotFound
+		if errors.As(err, &e) {
+			if options.Platform != nil {
+				e.wanted = *options.Platform
+			} else {
+				e.wanted = platforms.DefaultSpec()
+			}
+		}
+		return nil, err
+	}
+
+	return imgV1, nil
 }
 
 // getImageV1 gets the containerd image as a docker v1 image struct.
@@ -97,7 +126,9 @@ func (i *ImageService) presentImages(ctx context.Context, img containerdimages.I
 		return nil, err
 	}
 	if len(presentImages) == 0 {
-		return nil, errdefs.NotFound(errors.New("no matching image found"))
+		return nil, &errPlatformNotFound{
+			imageRef: img.Name,
+		}
 	}
 
 	sort.SliceStable(presentImages, func(i, j int) bool {
diff --git a/daemon/containerd/image_history.go b/daemon/containerd/image_history.go
@@ -9,9 +9,7 @@ import (
 	"github.com/containerd/platforms"
 	"github.com/distribution/reference"
 	imagetype "github.com/docker/docker/api/types/image"
-	"github.com/docker/docker/daemon/images"
 	dimages "github.com/docker/docker/daemon/images"
-	"github.com/docker/docker/errdefs"
 	"github.com/opencontainers/go-digest"
 	"github.com/opencontainers/image-spec/identity"
 	"github.com/pkg/errors"
@@ -31,9 +29,9 @@ func (i *ImageService) ImageHistory(ctx context.Context, name string) ([]*imaget
 
 	presentImages, err := i.presentImages(ctx, img, platform)
 	if err != nil {
-		if errdefs.IsNotFound(err) {
-			r, _ := reference.ParseAnyReference(name)
-			return nil, images.ErrImageDoesNotExist{Ref: r}
+		var e *errPlatformNotFound
+		if errors.As(err, &e) {
+			e.wanted = platforms.DefaultSpec()
 		}
 		return nil, err
 	}
