fix: bring back --verbose flag (#1660)

Signed-off-by: Xiaoxuan Wang <[email protected]>

Author: wangxiaoxuan273

cmd/oras/internal/option/verbose.go

@@ -0,0 +1,25 @@
+/*
+Copyright The ORAS 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 option
+
+import "github.com/spf13/pflag"
+
+// AddDeprecatedVerboseFlag adds the deprecated verbose flag to a command
+func AddDeprecatedVerboseFlag(flags *pflag.FlagSet) {
+	// ignoring the variable of the verbose flag, since we will not use it
+	_ = flags.BoolP("verbose", "v", false, "verbose output")
+	_ = flags.MarkDeprecated("verbose", "and will be removed in a future release.")
+}

cmd/oras/root/blob/delete.go

@@ -69,6 +69,7 @@ Example - Delete a blob and print its descriptor:
 		},
 	}
 
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }

cmd/oras/root/blob/fetch.go

@@ -92,6 +92,7 @@ Example - Fetch and print a blob from OCI image layout archive file 'layout.tar'
 	}
 
 	cmd.Flags().StringVarP(&opts.outputPath, "output", "o", "", "output file `path`, use - for stdout")
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }

cmd/oras/root/login.go

@@ -73,6 +73,7 @@ Example - Log in with username and password in an interactive terminal and no TL
 			return runLogin(cmd, opts)
 		},
 	}
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Remote)
 }

cmd/oras/root/manifest/delete.go

@@ -74,6 +74,7 @@ Example - Delete a manifest by digest 'sha256:99e4703fbf30916f549cd6bfa9cdbab614
 
 	opts.EnableDistributionSpecFlag()
 	option.ApplyFlags(&opts, cmd.Flags())
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }
 

cmd/oras/root/manifest/fetch.go

@@ -106,6 +106,7 @@ Example - Fetch raw manifest from an OCI layout archive file 'layout.tar':
 		option.FormatTypeJSON.WithUsage("Print in prettified JSON format"),
 		option.FormatTypeGoTemplate.WithUsage("Print using the given Go template"),
 	)
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }

cmd/oras/root/manifest/fetch_config.go

@@ -84,6 +84,7 @@ Example - Fetch and print the prettified descriptor of the config:
 	}
 
 	cmd.Flags().StringVarP(&opts.outputPath, "output", "o", "", "file `path` to write the fetched config to, use - for stdout")
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }

cmd/oras/root/repo/ls.go

@@ -67,6 +67,7 @@ Example - List the repositories under the registry that include values lexically
 	}
 
 	cmd.Flags().StringVar(&opts.last, "last", "", "start after the repository specified by `last`")
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Remote)
 }

cmd/oras/root/repo/tags.go

@@ -75,6 +75,7 @@ Example - [Experimental] Show tags associated with a digest:
 	}
 	cmd.Flags().StringVar(&opts.last, "last", "", "start after the tag specified by `last`")
 	cmd.Flags().BoolVar(&opts.excludeDigestTag, "exclude-digest-tags", false, "[Preview] exclude all digest-like tags such as 'sha256-aaaa...'")
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }

cmd/oras/root/resolve.go

@@ -58,6 +58,7 @@ Example - Resolve digest of the target artifact:
 	}
 
 	cmd.Flags().BoolVarP(&opts.fullRef, "full-reference", "l", false, "print the full artifact reference with digest")
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	option.ApplyFlags(&opts, cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }

cmd/oras/root/tag.go

@@ -96,6 +96,7 @@ Example - Tag the manifest 'v1.0.1' to 'v1.0.2' in an OCI image layout folder 'l
 
 	option.ApplyFlags(&opts, cmd.Flags())
 	cmd.Flags().IntVarP(&opts.concurrency, "concurrency", "", 5, "concurrency level")
+	option.AddDeprecatedVerboseFlag(cmd.Flags())
 	return oerrors.Command(cmd, &opts.Target)
 }
 

test/e2e/suite/auth/auth.go

@@ -25,6 +25,7 @@ import (
 	. "github.com/onsi/gomega"
 	"github.com/onsi/gomega/gbytes"
 	"oras.land/oras-go/v2"
+	"oras.land/oras/test/e2e/internal/testdata/feature"
 	"oras.land/oras/test/e2e/internal/testdata/foobar"
 	. "oras.land/oras/test/e2e/internal/utils"
 )
@@ -92,6 +93,11 @@ var _ = Describe("Common registry user", func() {
 				MatchErrKeyWords("WARNING", "Using --password via the CLI is insecure", "Use --password-stdin").Exec()
 		})
 
+		It("should show deprecation message when running with --verbose flag", func() {
+			ORAS("login", ZOTHost, "-u", Username, "-p", Password, "--registry-config", filepath.Join(GinkgoT().TempDir(), tmpConfigName), "--verbose").
+				MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
+
 		It("should show detailed error description if no argument provided", func() {
 			err := ORAS("login").ExpectFailure().Exec().Err
 			Expect(err).Should(gbytes.Say("Error"))

test/e2e/suite/command/blob.go

@@ -252,6 +252,13 @@ var _ = Describe("1.1 registry users:", func() {
 				MatchKeyWords("Missing", toDeleteRef).
 				Exec()
 		})
+
+		It("should show deprecation message when running with --verbose flag", func() {
+			dstRepo := fmt.Sprintf(repoFmt, "delete", "blob-delete-verbose")
+			CopyZOTRepo(BlobRepo, dstRepo)
+			toDeleteRef := RegistryRef(ZOTHost, dstRepo, foobar.FooBlobDigest)
+			ORAS("blob", "delete", toDeleteRef, "--verbose").MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
 	})
 	When("running `blob push`", func() {
 		It("should push a blob from a file and output the descriptor with specific media-type", func() {
@@ -288,6 +295,10 @@ var _ = Describe("1.1 registry users:", func() {
 			ORAS("blob", "fetch", RegistryRef(ZOTHost, ImageRepo, foobar.FooBlobDigest), "--output", "-").
 				MatchContent(foobar.FooBlobContent).Exec()
 		})
+		It("should show deprecation message when running with --verbose flag", func() {
+			ORAS("blob", "fetch", RegistryRef(ZOTHost, ImageRepo, foobar.FooBlobDigest), "--descriptor", "--verbose").
+				MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
 		It("should fetch blob content and output to a file", func() {
 			tempDir := GinkgoT().TempDir()
 			contentPath := filepath.Join(tempDir, "fetched")

test/e2e/suite/command/manifest.go

@@ -134,6 +134,10 @@ var _ = Describe("ORAS beginners:", func() {
 				MatchDefaultFlagValue("format", "text", "manifest", "fetch")
 			})
 
+			It("should show deprecation message when running with --verbose flag", func() {
+				ORAS("manifest", "fetch", RegistryRef(ZOTHost, ImageRepo, foobar.Tag), "--verbose").MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+			})
+
 			It("should fail and show detailed error description if no argument provided", func() {
 				err := ORAS("manifest", "fetch").ExpectFailure().Exec().Err
 				gomega.Expect(err).Should(gbytes.Say("Error"))
@@ -447,6 +451,11 @@ var _ = Describe("1.1 registry users:", func() {
 				MatchContent("{}").Exec()
 		})
 
+		It("should show deprecation message when running with --verbose flag", func() {
+			ORAS("manifest", "fetch-config", RegistryRef(ZOTHost, ImageRepo, foobar.Tag), "--verbose").
+				MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
+
 		It("should fetch a config descriptor via a tag", func() {
 			ORAS("manifest", "fetch-config", "--descriptor", RegistryRef(ZOTHost, ImageRepo, foobar.Tag)).
 				MatchContent(foobar.ImageConfigDesc).Exec()
@@ -486,6 +495,13 @@ var _ = Describe("1.1 registry users:", func() {
 			validateTag(RegistryRef(ZOTHost, dstRepo, ""), tempTag, true)
 		})
 
+		It("should show deprecation message when running with --verbose flag", func() {
+			dstRepo := fmt.Sprintf(repoFmt, "delete", "verbose-flag")
+			prepare(RegistryRef(ZOTHost, ImageRepo, foobar.Tag), RegistryRef(ZOTHost, dstRepo, tempTag))
+			ORAS("manifest", "delete", RegistryRef(ZOTHost, dstRepo, tempTag), "--verbose").
+				MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
+
 		It("should do confirmed deletion via flag", func() {
 			dstRepo := fmt.Sprintf(repoFmt, "delete", "confirm-flag")
 			prepare(RegistryRef(ZOTHost, ImageRepo, foobar.Tag), RegistryRef(ZOTHost, dstRepo, tempTag))

test/e2e/suite/command/repo.go

@@ -93,6 +93,9 @@ var _ = Describe("1.1 registry users:", func() {
 		It("should list repositories under provided namespace", func() {
 			ORAS("repo", "ls", RegistryRef(ZOTHost, Namespace, "")).MatchKeyWords(ImageRepo[len(Namespace)+1:]).Exec()
 		})
+		It("should show deprecation message when running with --verbose flag", func() {
+			ORAS("repository", "list", ZOTHost, "--verbose").MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
 
 		It("should not list repositories without a fully matched namespace", func() {
 			repo := "command-draft/images"
@@ -119,7 +122,9 @@ var _ = Describe("1.1 registry users:", func() {
 		})
 		It("should list tags via short command", func() {
 			ORAS("repo", "tags", repoRef).MatchKeyWords(multi_arch.Tag, foobar.Tag).Exec()
-
+		})
+		It("should show deprecation message when running with --verbose flag", func() {
+			ORAS("repo", "tags", repoRef, "--verbose").MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
 		})
 
 		It("Should list out tags associated to the provided reference", func() {

test/e2e/suite/command/resolve.go

@@ -78,6 +78,9 @@ var _ = Describe("Common registry user", func() {
 			out := ORAS("digest", "-l", RegistryRef(ZOTHost, ImageRepo, multi_arch.Tag)).Exec().Out
 			gomega.Expect(out).To(gbytes.Say(fmt.Sprintf("%s/%s@%s", ZOTHost, ImageRepo, multi_arch.Digest)))
 		})
+		It("should show deprecation message when running with --verbose flag", func() {
+			ORAS("resolve", RegistryRef(ZOTHost, ImageRepo, multi_arch.Digest), "--verbose").MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
 		It("should resolve with a fully qualified reference for a platform", func() {
 			out := ORAS("resolve", "--full-reference", "--platform", "linux/amd64", RegistryRef(ZOTHost, ImageRepo, multi_arch.Tag)).Exec().Out
 			gomega.Expect(out).To(gbytes.Say(fmt.Sprintf("%s/%s@%s", ZOTHost, ImageRepo, multi_arch.LinuxAMD64.Digest)))

test/e2e/suite/command/tag.go

@@ -24,6 +24,7 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	"github.com/onsi/gomega"
 	"github.com/onsi/gomega/gbytes"
+	"oras.land/oras/test/e2e/internal/testdata/feature"
 	"oras.land/oras/test/e2e/internal/testdata/foobar"
 	"oras.land/oras/test/e2e/internal/testdata/multi_arch"
 	. "oras.land/oras/test/e2e/internal/utils"
@@ -68,6 +69,9 @@ func tagAndValidate(reg string, repo string, tagOrDigest string, digestText stri
 
 var _ = Describe("1.1 registry users:", func() {
 	When("running `tag`", func() {
+		It("should show deprecation message when running with --verbose flag", func() {
+			ORAS("tag", RegistryRef(ZOTHost, ImageRepo, multi_arch.Tag), "latest", "--verbose").MatchErrKeyWords(feature.DeprecationMessageVerboseFlag).Exec()
+		})
 		It("should add a tag to an existent manifest when providing tag reference", func() {
 			tagAndValidate(ZOTHost, ImageRepo, multi_arch.Tag, multi_arch.Digest, "tag-via-tag")
 		})