Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: deprecate table format #1656

Merged
merged 4 commits into from
Mar 18, 2025
Merged

refactor: deprecate table format #1656

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1db14f2
refactor: deprecate table format
Mar 13, 2025
c96caaf
fix failed tests
Mar 13, 2025
a4f7078
resolving comments
Mar 17, 2025
235a805
Merge branch 'main' into deprecate-table
TerryHowe Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions cmd/oras/internal/option/format.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,10 @@ var (
Usage: "Print output using the given Go template",
HasParams: true,
}
// Deprecated: table format is deprecated and will be removed in the future.
FormatTypeTable = &FormatType{
Name: "table",
Usage: "Get direct referrers and output in table format",
Usage: "[Deprecated] Get direct referrers and output in table format",
}
FormatTypeTree = &FormatType{
Name: "tree",
Expand Down Expand Up @@ -98,7 +99,11 @@ func (opts *Format) ApplyFlags(fs *pflag.FlagSet) {
}

// Parse parses the input format flag.
func (opts *Format) Parse(_ *cobra.Command) error {
func (opts *Format) Parse(cmd *cobra.Command) error {
// print deprecation message for table format
if opts.FormatFlag == "table" {
fmt.Fprint(cmd.ErrOrStderr(), "Format \"table\" is deprecated and will be removed in a future release.\n")
}
if err := opts.parseFlag(); err != nil {
return err
}
Expand Down
11 changes: 8 additions & 3 deletions test/e2e/suite/command/discover.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ func discoverKeyWords(verbose bool, descs ...ocispec.Descriptor) []string {
}

var _ = Describe("ORAS beginners:", func() {
const DeprecationMessageTableFormat = "Format \"table\" is deprecated and will be removed in a future release.\n"
When("running discover command", func() {
RunAndShowPreviewInHelp([]string{"discover"})

Expand All @@ -56,10 +57,14 @@ var _ = Describe("ORAS beginners:", func() {
gomega.Expect(out).Should(gbytes.Say("--distribution-spec string\\s+%s", regexp.QuoteMeta(feature.Preview.Mark)))
})

It("should show text as default format type in help doc", func() {
It("should show tree as default format type in help doc", func() {
MatchDefaultFlagValue("format", "tree", "discover")
})

It("should show deprecation message when using table format", func() {
ORAS("discover", RegistryRef(ZOTHost, ImageRepo, foobar.Tag), "--format", "table").MatchErrKeyWords(DeprecationMessageTableFormat).Exec()
})

It("should fail when no subject reference provided", func() {
ORAS("discover").ExpectFailure().MatchErrKeyWords("Error:").Exec()
})
Expand Down Expand Up @@ -192,7 +197,7 @@ var _ = Describe("1.1 registry users:", func() {
})
When("running discover command with table output", func() {
format := "table"
It("should all referrers of a subject with deprecation hint", func() {
It("should show all referrers of a subject with deprecation hint", func() {
referrers := []ocispec.Descriptor{foobar.SBOMImageReferrer, foobar.SBOMImageReferrer}
ORAS("discover", subjectRef, "-o", format).
MatchErrKeyWords(feature.Deprecated.Mark).
Expand All @@ -204,7 +209,7 @@ var _ = Describe("1.1 registry users:", func() {
err := ORAS("discover", subjectRef, "--format", format).
MatchKeyWords(append(discoverKeyWords(false, referrers...), foobar.Digest)...).
Exec().Err
Expect(err).NotTo(gbytes.Say(feature.Deprecated.Mark))
Expect(err).To(gbytes.Say(feature.Deprecated.Mark))
})
})
When("running discover command with go-template output", func() {
Expand Down
Loading