Modify the ref option

Signed-off-by: zhouhao <[email protected]>

Author: zhouhao

cmd/oci-image-tool/create.go

@@ -89,8 +89,8 @@ var createCommand = cli.Command{
 		},
 		cli.StringFlag{
 			Name:  "ref",
-			Value: "v1.0",
-			Usage: "The ref pointing to the manifest of the OCI image. This must be present in the 'refs' subdirectory of the image.",
+			Value: "org.opencontainers.ref.name==v1.0",
+			Usage: "Specify the search criteria, format is A==B. Only support `org.opencontainers.ref.name`, `platform.os` and `digest` three cases.",
 		},
 		cli.StringFlag{
 			Name:  "rootfs",

cmd/oci-image-tool/unpack.go

@@ -85,8 +85,8 @@ var unpackCommand = cli.Command{
 		},
 		cli.StringFlag{
 			Name:  "ref",
-			Value: "v1.0",
-			Usage: "The ref pointing to the manifest of the OCI image. This must be present in the 'refs' subdirectory of the image.",
+			Value: "org.opencontainers.ref.name==v1.0",
+			Usage: "Specify the search criteria, format is A==B. Only support `org.opencontainers.ref.name`, `platform.os` and `digest` three cases.",
 		},
 		cli.StringFlag{
 			Name:  "platform",

image/descriptor.go

@@ -20,6 +20,7 @@ import (
 	"io"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/pkg/errors"
@@ -44,20 +45,32 @@ func listReferences(w walker) (map[string]*v1.Descriptor, error) {
 			if index.Manifests[i].Annotations["org.opencontainers.ref.name"] != "" {
 				refs[index.Manifests[i].Annotations["org.opencontainers.ref.name"]] = &index.Manifests[i]
 			}
+
+			if index.Manifests[i].Platform != nil && index.Manifests[i].Platform.OS != "" {
+				refs[index.Manifests[i].Platform.OS] = &index.Manifests[i]
+			}
+
+			refs[string(index.Manifests[i].Digest)] = &index.Manifests[i]
 		}
 
 		return nil
 	}); err != nil {
 		return nil, err
 	}
+
 	return refs, nil
 }
 
 func findDescriptor(w walker, name string) (*v1.Descriptor, error) {
-	var d v1.Descriptor
+	var refs []v1.Descriptor
 	var index v1.Index
 
-	switch err := w.walk(func(path string, info os.FileInfo, r io.Reader) error {
+	argsParts := strings.Split(name, "==")
+	if len(argsParts) != 2 {
+		return nil, fmt.Errorf("ref must contain two parts")
+	}
+
+	if err := w.walk(func(path string, info os.FileInfo, r io.Reader) error {
 		if info.IsDir() || filepath.Clean(path) != indexPath {
 			return nil
 		}
@@ -66,22 +79,41 @@ func findDescriptor(w walker, name string) (*v1.Descriptor, error) {
 			return err
 		}
 
-		for i := 0; i < len(index.Manifests); i++ {
-			if index.Manifests[i].Annotations["org.opencontainers.ref.name"] == name {
-				d = index.Manifests[i]
-				return errEOW
+		switch argsParts[0] {
+		case "org.opencontainers.ref.name":
+			for i := 0; i < len(index.Manifests); i++ {
+				if index.Manifests[i].Annotations["org.opencontainers.ref.name"] == argsParts[1] {
+					refs = append(refs, index.Manifests[i])
+				}
+			}
+		case "platform.os":
+			for i := 0; i < len(index.Manifests); i++ {
+				if index.Manifests[i].Platform != nil && index.Manifests[i].Platform.OS == argsParts[1] {
+					refs = append(refs, index.Manifests[i])
+				}
 			}
+		case "digest":
+			for i := 0; i < len(index.Manifests); i++ {
+				if string(index.Manifests[i].Digest) == argsParts[1] {
+					refs = append(refs, index.Manifests[i])
+				}
+			}
+		default:
+			return fmt.Errorf("criteria %q unimplemented", argsParts[0])
 		}
 
 		return nil
-	}); err {
-	case nil:
-		return nil, fmt.Errorf("index.json: descriptor not found")
-	case errEOW:
-		return &d, nil
-	default:
+	}); err != nil {
 		return nil, err
 	}
+
+	if len(refs) == 0 {
+		return nil, fmt.Errorf("index.json: descriptor retrieved by %q is not unique", name)
+	} else if len(refs) > 1 {
+		return nil, fmt.Errorf("index.json: descriptor retrieved by %q is not unique", name)
+	}
+
+	return &refs[0], nil
 }
 
 func validateDescriptor(d *v1.Descriptor, w walker, mts []string) error {

man/oci-image-tool-create.1.md

@@ -18,7 +18,9 @@ runtime-spec-compatible `dest/config.json`.
   Print usage statement
 
 **--ref**=""
-  The ref pointing to the manifest of the OCI image. This must be present in the "refs" subdirectory of the image. (default "v1.0")
+  Specify the search criteria, format is A==B.
+  e.g. --ref org.opencontainers.ref.name==v1.0
+  Only support `org.opencontainers.ref.name`, `platform.os` and `digest` three cases.(default org.opencontainers.ref.name==v1.0)
 
 **--rootfs**=""
   A directory representing the root filesystem of the container in the OCI runtime bundle. It is strongly recommended to keep the default value. (default "rootfs")

man/oci-image-tool-unpack.1.md

@@ -15,7 +15,9 @@ oci-image-tool unpack \- Unpack an image or image source layout
   Print usage statement
 
 **--ref**=""
-  The ref pointing to the manifest to be unpacked. This must be present in the "refs" subdirectory of the image. (default "v1.0")
+  Specify the search criteria, format is A==B.
+  e.g. --ref org.opencontainers.ref.name==v1.0
+  Only support `org.opencontainers.ref.name`, `platform.os` and `digest` three cases.(default org.opencontainers.ref.name==v1.0)
 
 **--type**=""
   Type of the file to unpack. If unset, oci-image-tool will try to auto-detect the type. One of "imageLayout,image"