Redesign OCI image status: Display the image's exact repository digest

pkg/apis/ignite/types.go

@@ -52,16 +52,10 @@ type OCIImageClaim struct {
 // OCIImageSource specifies how the OCI image was imported.
 // It is the status variant of OCIImageClaim
 type OCIImageSource struct {
-	// ID defines the source's ID (e.g. the Docker image ID)
-	ID string `json:"id"`
+	// ID defines the source's content ID (e.g. the canonical OCI path or Docker image ID)
+	ID *meta.OCIContentID `json:"id"`
 	// Size defines the size of the source in bytes
 	Size meta.Size `json:"size"`
-	// RepoDigests defines the image name as it was when pulled
-	// from a repository, and the digest of the image
-	// The format is $registry/$user/$image@sha256:$digest
-	// This field is unpopulated if the image used as the source
-	// has never been pushed to or pulled from a registry
-	RepoDigests []string `json:"repoDigests,omitempty"`
 }
 
 // ImageStatus defines the status of the image

pkg/apis/ignite/v1alpha2/types.go

@@ -52,16 +52,10 @@ type OCIImageClaim struct {
 // OCIImageSource specifies how the OCI image was imported.
 // It is the status variant of OCIImageClaim
 type OCIImageSource struct {
-	// ID defines the source's ID (e.g. the Docker image ID)
-	ID string `json:"id"`
+	// ID defines the source's content ID (e.g. the canonical OCI path or Docker image ID)
+	ID *meta.OCIContentID `json:"id"`
 	// Size defines the size of the source in bytes
 	Size meta.Size `json:"size"`
-	// RepoDigests defines the image name as it was when pulled
-	// from a repository, and the digest of the image
-	// The format is $registry/$user/$image@sha256:$digest
-	// This field is unpopulated if the image used as the source
-	// has never been pushed to or pulled from a registry
-	RepoDigests []string `json:"repoDigests,omitempty"`
 }
 
 // ImageStatus defines the status of the image

pkg/apis/meta/v1alpha1/image.go

@@ -3,19 +3,21 @@ package v1alpha1
 import (
 	"encoding/json"
 	"fmt"
+	"net/url"
 
 	"github.com/containers/image/docker/reference"
+	"github.com/opencontainers/go-digest"
 )
 
 // NewOCIImageRef parses and normalizes a reference to an OCI (docker) image.
 func NewOCIImageRef(imageStr string) (OCIImageRef, error) {
 	named, err := reference.ParseDockerRef(imageStr)
 	if err != nil {
-		return OCIImageRef(""), err
+		return "", err
 	}
 	namedTagged, ok := named.(reference.NamedTagged)
 	if !ok {
-		return OCIImageRef(""), fmt.Errorf("could not parse image name with a tag %s", imageStr)
+		return "", fmt.Errorf("could not parse image name with a tag %s", imageStr)
 	}
 	return OCIImageRef(reference.FamiliarString(namedTagged)), nil
 }
@@ -32,10 +34,6 @@ func (i OCIImageRef) IsUnset() bool {
 	return len(i) == 0
 }
 
-func (i OCIImageRef) MarshalJSON() ([]byte, error) {
-	return json.Marshal(string(i))
-}
-
 func (i *OCIImageRef) UnmarshalJSON(b []byte) error {
 	var str string
 	var err error
@@ -47,3 +45,89 @@ func (i *OCIImageRef) UnmarshalJSON(b []byte) error {
 	*i, err = NewOCIImageRef(str)
 	return err
 }
+
+func ParseOCIContentID(str string) (*OCIContentID, error) {
+	named, err := reference.ParseDockerRef(str)
+	if err != nil {
+		return nil, err
+	}
+
+	if canonical, ok := named.(reference.Canonical); ok {
+		return &OCIContentID{
+			repoName: named.Name(),
+			digest:   canonical.Digest().String(),
+		}, nil
+	}
+
+	d, err := digest.Parse(str)
+	if err != nil {
+		return nil, err
+	}
+
+	return &OCIContentID{
+		digest: d.String(),
+	}, nil
+}
+
+type OCIContentID struct {
+	repoName string // Fully qualified image name, e.g. "docker.io/library/node" or blank if the image is local
+	digest   string // Repo digest of the image, or sha256sum provided by the source if the image is local
+}
+
+var _ json.Marshaler = &OCIContentID{}
+var _ json.Unmarshaler = &OCIContentID{}
+
+func (o *OCIContentID) String() string {
+	if len(o.repoName) > 0 {
+		return fmt.Sprintf("oci://%s", o.RepoDigest())
+	}
+
+	return fmt.Sprintf("docker://%s", o.Digest())
+}
+
+func parseOCIString(s string) (*OCIContentID, error) {
+	u, err := url.Parse(s)
+	if err != nil {
+		return nil, err
+	}
+
+	// Remove the "docker://" or "oci://" scheme by only caring about the host and path
+	return ParseOCIContentID(u.Host + u.Path)
+}
+
+// Local returns true if the image has no repoName, i.e. it's not available from a registry
+func (o *OCIContentID) Local() bool {
+	return len(o.repoName) == 0
+}
+
+// Digest is a getter for the digest field
+func (o *OCIContentID) Digest() string {
+	return o.digest
+}
+
+// RepoDigest returns a repo digest based on the OCIContentID if it is not local
+func (o *OCIContentID) RepoDigest() (s string) {
+	if !o.Local() {
+		s = fmt.Sprintf("%s@%s", o.repoName, o.digest)
+	}
+
+	return
+}
+
+func (o *OCIContentID) MarshalJSON() ([]byte, error) {
+	return json.Marshal(o.String())
+}
+
+func (o *OCIContentID) UnmarshalJSON(b []byte) (err error) {
+	var s string
+	if err = json.Unmarshal(b, &s); err != nil {
+		return err
+	}
+
+	var id *OCIContentID
+	if id, err = parseOCIString(s); err == nil {
+		*o = *id
+	}
+
+	return
+}

pkg/source/docker.go

@@ -54,10 +54,26 @@ func (ds *DockerSource) Parse(ociRef meta.OCIImageRef) (*api.OCIImageSource, err
 	}
 
 	ds.imageID = res.ID
+
+	// By default parse the OCI content ID from the Docker image ID
+	contentRef := res.ID
+	if len(res.RepoDigests) > 0 {
+		// If the image has Repo digests, use the first one of them to parse
+		// the fully qualified OCI image name and digest. All of the digests
+		// point to the same contents, so it doesn't matter which one we use
+		// here. It will be translated to the right content by the runtime.
+		contentRef = res.RepoDigests[0]
+	}
+
+	// Parse the OCI content ID based on the available reference
+	ci, err := meta.ParseOCIContentID(contentRef)
+	if err != nil {
+		return nil, err
+	}
+
 	return &api.OCIImageSource{
-		ID:          res.ID,
-		RepoDigests: res.RepoDigests,
-		Size:        meta.NewSizeFromBytes(uint64(res.Size)),
+		ID:   ci,
+		Size: meta.NewSizeFromBytes(uint64(res.Size)),
 	}, nil
 }