From 4b2321ac08a61850d3f40968d83ec74be007f02c Mon Sep 17 00:00:00 2001 From: Terry Howe Date: Mon, 30 Sep 2024 09:36:38 -0600 Subject: [PATCH] feature: add platform option to push command Signed-off-by: Terry Howe --- cmd/oras/internal/option/platform.go | 18 +++++++- cmd/oras/root/push.go | 31 ++++++++++++++ test/e2e/internal/testdata/foobar/const.go | 12 ++++++ test/e2e/suite/command/push.go | 48 ++++++++++++++++++++++ 4 files changed, 108 insertions(+), 1 deletion(-) diff --git a/cmd/oras/internal/option/platform.go b/cmd/oras/internal/option/platform.go index 37cbea1d9..e8181e035 100644 --- a/cmd/oras/internal/option/platform.go +++ b/cmd/oras/internal/option/platform.go @@ -40,7 +40,7 @@ func (opts *Platform) ApplyFlags(fs *pflag.FlagSet) { fs.StringVarP(&opts.platform, "platform", "", "", opts.FlagDescription+" in the form of `os[/arch][/variant][:os_version]`") } -// parse parses the input platform flag to an oci platform type. +// Parse parses the input platform flag to an oci platform type. func (opts *Platform) Parse(*cobra.Command) error { if opts.platform == "" { return nil @@ -73,3 +73,19 @@ func (opts *Platform) Parse(*cobra.Command) error { opts.Platform = &p return nil } + +// ArtifactPlatform option struct. +type ArtifactPlatform struct { + Platform +} + +// ApplyFlags applies flags to a command flag set. +func (opts *ArtifactPlatform) ApplyFlags(fs *pflag.FlagSet) { + opts.FlagDescription = "set artifact platform" + fs.StringVarP(&opts.platform, "artifact-platform", "", "", opts.FlagDescription+" in the form of `os[/arch][/variant][:os_version]`") +} + +// Parse parses the input platform flag to an oci platform type. +func (opts *ArtifactPlatform) Parse(cmd *cobra.Command) error { + return opts.Platform.Parse(cmd) +} diff --git a/cmd/oras/root/push.go b/cmd/oras/root/push.go index f9dfdee20..118a6e630 100644 --- a/cmd/oras/root/push.go +++ b/cmd/oras/root/push.go @@ -16,6 +16,8 @@ limitations under the License. package root import ( + "bytes" + "encoding/json" "errors" "strings" @@ -41,6 +43,7 @@ import ( type pushOptions struct { option.Common option.Packer + option.ArtifactPlatform option.ImageSpec option.Target option.Format @@ -100,6 +103,9 @@ Example - Push repository with manifest annotations: Example - Push repository with manifest annotation file: oras push --annotation-file annotation.json localhost:5000/hello:v1 +Example - Push artifact to repository with platform: + oras push --artifact-platform linux/arm/v5 localhost:5000/hello:v1 + Example - Push file "hi.txt" with multiple tags: oras push localhost:5000/hello:tag1,tag2,tag3 hi.txt @@ -133,6 +139,10 @@ Example - Push file "hi.txt" into an OCI image layout folder 'layout-dir' with t } } } + configAndPlatform := []string{"config", "artifact-platform"} + if err := oerrors.CheckMutuallyExclusiveFlags(cmd.Flags(), configAndPlatform...); err != nil { + return err + } switch opts.PackVersion { case oras.PackManifestVersion1_0: @@ -182,6 +192,27 @@ func runPush(cmd *cobra.Command, opts *pushOptions) error { } desc.Annotations = packOpts.ConfigAnnotations packOpts.ConfigDescriptor = &desc + } else if opts.Platform.Platform != nil { + blob, err := json.Marshal(opts.Platform.Platform) + if err != nil { + return err + } + mediaType := opts.artifactType + if mediaType == "" { + switch opts.PackVersion { + case oras.PackManifestVersion1_0: + mediaType = oras.MediaTypeUnknownConfig + case oras.PackManifestVersion1_1: + mediaType = oras.MediaTypeUnknownArtifact + } + } + desc := content.NewDescriptorFromBytes(mediaType, blob) + err = store.Push(ctx, desc, bytes.NewReader(blob)) + if err != nil { + return err + } + desc.Annotations = packOpts.ConfigAnnotations + packOpts.ConfigDescriptor = &desc } memoryStore := memory.New() union := contentutil.MultiReadOnlyTarget(memoryStore, store) diff --git a/test/e2e/internal/testdata/foobar/const.go b/test/e2e/internal/testdata/foobar/const.go index dc3de4a89..397afe986 100644 --- a/test/e2e/internal/testdata/foobar/const.go +++ b/test/e2e/internal/testdata/foobar/const.go @@ -38,6 +38,18 @@ var ( Digest: "46b68ac1696c", Name: "application/vnd.unknown.config.v1+json", } + PlatformConfigSize = 38 + PlatformConfigDigest = digest.Digest("sha256:e94c0ba80a1157ffab5b5c6656fffc089c6446c7ed0604f3382910d1ef7dd40d") + PlatformConfigStateKey = match.StateKey{ + Digest: "e94c0ba80a11", Name: "application/vnd.unknown.artifact.v1", + } + + PlatformV10ConfigSize = 38 + PlatformV10ConfigDigest = digest.Digest("sha256:e94c0ba80a1157ffab5b5c6656fffc089c6446c7ed0604f3382910d1ef7dd40d") + PlatformV10ConfigStateKey = match.StateKey{ + Digest: "e94c0ba80a11", Name: "test/artifact+json", + } + FileBarName = "foobar/bar" FileBarStateKey = match.StateKey{Digest: "fcde2b2edba5", Name: FileLayerNames[2]} FileStateKeys = []match.StateKey{ diff --git a/test/e2e/suite/command/push.go b/test/e2e/suite/command/push.go index 5cb644a66..b70fb3277 100644 --- a/test/e2e/suite/command/push.go +++ b/test/e2e/suite/command/push.go @@ -77,6 +77,14 @@ var _ = Describe("ORAS beginners:", func() { ORAS("push", ref, "--config", foobar.FileConfigName, "--artifact-type", "test/artifact+json", "--image-spec", "v1.0").ExpectFailure().WithWorkDir(tempDir).Exec() }) + It("should fail to use --artifact-platform and --config at the same time", func() { + tempDir := PrepareTempFiles() + repo := pushTestRepo("no-mediatype") + ref := RegistryRef(ZOTHost, repo, "") + + ORAS("push", ref, "--artifact-platform", "linux/amd64", "--config", foobar.FileConfigName).ExpectFailure().WithWorkDir(tempDir).Exec() + }) + It("should fail if image spec is not valid", func() { testRepo := attachTestRepo("invalid-image-spec") subjectRef := RegistryRef(ZOTHost, testRepo, foobar.Tag) @@ -612,6 +620,46 @@ var _ = Describe("OCI image layout users:", func() { })) }) + It("should push files with platform", func() { + tempDir := PrepareTempFiles() + ref := LayoutRef(tempDir, tag) + ORAS("push", Flags.Layout, ref, "--artifact-platform", "darwin/arm64", foobar.FileBarName, "-v"). + MatchStatus([]match.StateKey{ + foobar.PlatformConfigStateKey, + foobar.FileBarStateKey, + }, true, 2). + WithWorkDir(tempDir).Exec() + // validate + fetched := ORAS("manifest", "fetch", Flags.Layout, ref).Exec().Out.Contents() + var manifest ocispec.Manifest + Expect(json.Unmarshal(fetched, &manifest)).ShouldNot(HaveOccurred()) + Expect(manifest.Config).Should(Equal(ocispec.Descriptor{ + MediaType: foobar.PlatformConfigStateKey.Name, + Size: int64(foobar.PlatformConfigSize), + Digest: foobar.PlatformConfigDigest, + })) + }) + + It("should push files with platform with mediaType as artifactType for v1.0", func() { + tempDir := PrepareTempFiles() + ref := LayoutRef(tempDir, tag) + ORAS("push", Flags.Layout, ref, "--image-spec", "v1.0", "--artifact-type", "test/artifact+json", "--artifact-platform", "darwin/arm64", foobar.FileBarName, "-v"). + MatchStatus([]match.StateKey{ + foobar.PlatformV10ConfigStateKey, + foobar.FileBarStateKey, + }, true, 2). + WithWorkDir(tempDir).Exec() + // validate + fetched := ORAS("manifest", "fetch", Flags.Layout, ref).Exec().Out.Contents() + var manifest ocispec.Manifest + Expect(json.Unmarshal(fetched, &manifest)).ShouldNot(HaveOccurred()) + Expect(manifest.Config).Should(Equal(ocispec.Descriptor{ + MediaType: "test/artifact+json", + Size: int64(foobar.PlatformV10ConfigSize), + Digest: foobar.PlatformV10ConfigDigest, + })) + }) + It("should push files with customized manifest annotation", func() { tempDir := PrepareTempFiles() ref := LayoutRef(tempDir, tag)