Merge branch 'verbose_refactor' into verbose_refactor_ci

Wwwsylvia · Nov 25, 2024 · 66501f3 · 66501f3
2 parents 49dfa17 + a892087
commit 66501f3
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 6 deletions.
diff --git a/cmd/oras/internal/option/common.go b/cmd/oras/internal/option/common.go
@@ -28,12 +28,15 @@ const NoTTYFlag = "no-tty"
 
 // Common option struct.
 type Common struct {
-	Debug   bool
-	Verbose bool // deprecated, the current default behavior is equivalent to verbose=true TODO: better doc
-	TTY     *os.File
+	Debug bool
+	// SuppressUntitled suppresses the status output for untitled blobs.
+	SuppressUntitled bool
+	TTY              *os.File
 	*output.Printer
-	noTTY            bool
-	SuppressUntitled bool // equivalent to verbose=false TODO: better doc
+	noTTY bool
+
+	// Deprecated: Verbose is deprecated. Use SuppressUntitled instead (SuppressUntitled=false is equivalent to Verbose=true).
+	Verbose bool
 }
 
 // ApplyFlags applies flags to a command flag set.
@@ -42,7 +45,7 @@ func (opts *Common) ApplyFlags(fs *pflag.FlagSet) {
 	fs.BoolVarP(&opts.Verbose, "verbose", "v", false, "[Deprecated] verbose output")
 	fs.BoolVarP(&opts.noTTY, NoTTYFlag, "", false, "[Preview] do not show progress output")
 
-	fs.MarkDeprecated("verbose", "and may be removed in a future release.") // TODO: remove -v in e2e test; test deprecation message
+	fs.MarkDeprecated("verbose", "and may be removed in a future release.") // TODO: test deprecation message
 }
 
 // Parse gets target options from user input.

diff --git a/test/e2e/suite/command/pull.go b/test/e2e/suite/command/pull.go
@@ -47,6 +47,19 @@ var _ = Describe("ORAS beginners:", func() {
 			MatchDefaultFlagValue("format", "text", "pull")
 		})
 
+		It("should not show --verbose in help doc", func() {
+			out := ORAS("pull", "--help").MatchKeyWords(ExampleDesc).Exec().Out
+			gomega.Expect(out).ShouldNot(gbytes.Say("--verbose"))
+		})
+
+		It("should show deprecation message for --verbose", func() {
+			tempDir := PrepareTempFiles()
+			ref := RegistryRef(ZOTHost, ImageRepo, foobar.Tag)
+			ORAS("pull", ref, "--verbose").
+				WithWorkDir(tempDir).
+				MatchErrKeyWords("Flag --verbose has been deprecated")
+		})
+
 		hintMsg := func(reference string) string {
 			return fmt.Sprintf("Skipped pulling layers without file name in \"org.opencontainers.image.title\"\nUse 'oras copy %s --to-oci-layout <layout-dir>' to pull all layers.\n", reference)
 		}

diff --git a/test/e2e/suite/command/push.go b/test/e2e/suite/command/push.go
@@ -45,6 +45,21 @@ var _ = Describe("ORAS beginners:", func() {
 			MatchDefaultFlagValue("format", "text", "push")
 		})
 
+		It("should not show --verbose in help doc", func() {
+			out := ORAS("push", "--help").MatchKeyWords(ExampleDesc).Exec().Out
+			gomega.Expect(out).ShouldNot(gbytes.Say("--verbose"))
+		})
+
+		It("should show deprecation message for --verbose", func() {
+			repo := pushTestRepo("test-verbose")
+			tag := "e2e"
+			tempDir := PrepareTempFiles()
+
+			ORAS("push", RegistryRef(ZOTHost, repo, tag), "--verbose").
+				WithWorkDir(tempDir).
+				MatchErrKeyWords("Flag --verbose has been deprecated")
+		})
+
 		It("should fail and show detailed error description if no argument provided", func() {
 			err := ORAS("push").ExpectFailure().Exec().Err
 			gomega.Expect(err).Should(gbytes.Say("Error"))