command buckets converted to the cobra style #859

tommyshem · 2024-11-10T22:32:51Z

issue #472 Migrate all commands to cobra style commands

converted buckets command to cobra style

k8s-ci-robot · 2024-11-10T22:32:55Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: tommyshem
Once this PR has been reviewed and has the lgtm label, please assign serathius for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

cmd/bbolt/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2024-11-10T22:33:01Z

Hi @tommyshem. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

ivanvc · 2024-11-11T03:13:29Z

Hi @tommyshem, thanks for your pull request. Could you please sign your commit? So the developer certificate of origin (DCO) check passes, i.e:

git rebase HEAD~1 --signoff
git push --force

Thanks!

Ref: https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#commit-your-change

/ok-to-test

ahrtr · 2024-11-11T10:37:04Z

Thanks for raising the PR. It doesn't break the user experience, so I agree to get this PR included in 1.4.

Please resolve the test failure in case TestBucketsCommand_Run.

tommyshem · 2024-11-11T23:40:27Z

cmd/bbolt/command_version.go

changed the output so it could be tested in the future

tommyshem · 2024-11-11T23:41:17Z

cmd/bbolt/main_test.go

removed the tests and put them in the buckets test file

ahrtr · 2024-11-12T08:03:35Z

Please signoff the commit, read https://github.com/etcd-io/bbolt/pull/859/checks?check_run_id=32833799850

tommyshem · 2024-11-12T18:44:07Z

cmd/bbolt/bbolt.exe

not sure how to delete this as upload by mistake

I think running git rm cmd/bbolt/bbolt.exe should work, as the file is not ignored. If it doesn't work, you can try adding -f, i.e., git rm -f cmd/bbolt/bbolt.exe.

You'll then need to do a commit.

tommyshem · 2024-11-12T18:46:16Z

Should be finished now for review.
But some how I upload the bbolt.exe in the pull request and I don't know how to remove it.

ahrtr · 2024-11-13T10:20:21Z

cmd/bbolt/command_version.go

+			fmt.Fprintln(cmd.OutOrStdout(), "bbolt Version: ", version.Version)
+			fmt.Fprintln(cmd.OutOrStdout(), "Go Version: ", runtime.Version())
+			fmt.Fprintln(cmd.OutOrStdout(), "Go OS/Arch: ", runtime.GOOS, "/", runtime.GOARCH)


One PR only does one thing. Please don't make unrelated change.

Signed-off-by: tommy shem <[email protected]>

tommyshem · 2024-11-13T21:55:58Z

Removed the bolt.exe file and the command_version.go file.
So it should be just the buckets command change now hopefully.

ahrtr · 2024-11-14T09:41:14Z

cmd/bbolt/command_buckets.go

+// newBucketsCommand creates a new command that prints a list of buckets in the given Bolt database.
+//
+// The path to a Bolt database must be specified as an argument.


It's unnecessary comment to me. The command is self-explanation.

Suggested change

// newBucketsCommand creates a new command that prints a list of buckets in the given Bolt database.

//

// The path to a Bolt database must be specified as an argument.

ahrtr · 2024-11-14T09:42:13Z

cmd/bbolt/command_buckets.go

+		Short: "Print a list of buckets",
+		Long:  "Print a list of buckets in the given Bolt database\nThe path to a Bolt database must be specified as an argument",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return printBucketsList(cmd, args[0])
+		},


Please try to keep consistent with other commands implementation.

Suggested change

Short: "Print a list of buckets",

Long: "Print a list of buckets in the given Bolt database\nThe path to a Bolt database must be specified as an argument",

Args: cobra.ExactArgs(1),

RunE: func(cmd *cobra.Command, args []string) error {

return printBucketsList(cmd, args[0])

},

Short: "print a list of buckets",

Args: cobra.ExactArgs(1),

RunE: func(cmd *cobra.Command, args []string) error {

return bucketsFunc(args[0])

},

ahrtr · 2024-11-14T09:44:04Z

cmd/bbolt/command_buckets.go

+		// Verify if the specified database file exists.
+	} else if _, err := os.Stat(path); os.IsNotExist(err) {
+		return ErrFileNotFound
+	}


Please use checkSourceDBPath. See example below,

bbolt/cmd/bbolt/command_inspect.go

Line 27 in cb0618b

if _, err := checkSourceDBPath(srcDBPath); err != nil {

ahrtr · 2024-11-14T09:50:58Z

cmd/bbolt/command_buckets_test.go

+}
+
+// executeCommand runs the given command and returns the output and error.
+func executeCommand(rootCmd *cobra.Command, args ...string) (*cobra.Command, string, error) {


Can we just remove this function and get the implementation inlined in the test?

If you want to make it as a generic test utility function (i.e. included in utils_test.go), let's do it in a followup PR and we can discuss it separately.

k8s-ci-robot added the needs-ok-to-test label Nov 10, 2024

k8s-ci-robot added the size/L label Nov 10, 2024

k8s-ci-robot added ok-to-test and removed needs-ok-to-test labels Nov 11, 2024

tommyshem force-pushed the cmd_buckets branch from 378390b to 7dd48a6 Compare November 11, 2024 15:23

tommyshem commented Nov 11, 2024

View reviewed changes

cmd/bbolt/command_version.go Outdated

Copy link

Author

tommyshem Nov 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed the output so it could be tested in the future

tommyshem commented Nov 11, 2024

View reviewed changes

cmd/bbolt/main_test.go Outdated

Copy link

Author

tommyshem Nov 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed the tests and put them in the buckets test file

tommyshem force-pushed the cmd_buckets branch from d08fd3c to b89ce20 Compare November 12, 2024 15:56

tommyshem commented Nov 12, 2024

View reviewed changes

ahrtr reviewed Nov 13, 2024

View reviewed changes

etcd-io#472 Migrate buckets command to cobra style commands

a039306

Signed-off-by: tommy shem <[email protected]>

tommyshem force-pushed the cmd_buckets branch from b89ce20 to a039306 Compare November 13, 2024 21:33

ahrtr reviewed Nov 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

command buckets converted to the cobra style #859

command buckets converted to the cobra style #859

tommyshem commented Nov 10, 2024

k8s-ci-robot commented Nov 10, 2024

k8s-ci-robot commented Nov 10, 2024

ivanvc commented Nov 11, 2024

ahrtr commented Nov 11, 2024

tommyshem Nov 11, 2024

tommyshem Nov 11, 2024

ahrtr commented Nov 12, 2024

tommyshem Nov 12, 2024

ivanvc Nov 12, 2024

tommyshem commented Nov 12, 2024

ahrtr Nov 13, 2024

tommyshem commented Nov 13, 2024

ahrtr Nov 14, 2024

ahrtr Nov 14, 2024

ahrtr Nov 14, 2024

ahrtr Nov 14, 2024

	// newBucketsCommand creates a new command that prints a list of buckets in the given Bolt database.
	//
	// The path to a Bolt database must be specified as an argument.

command buckets converted to the cobra style #859

Are you sure you want to change the base?

command buckets converted to the cobra style #859

Conversation

tommyshem commented Nov 10, 2024

k8s-ci-robot commented Nov 10, 2024

k8s-ci-robot commented Nov 10, 2024

ivanvc commented Nov 11, 2024

ahrtr commented Nov 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahrtr commented Nov 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tommyshem commented Nov 12, 2024

Choose a reason for hiding this comment

tommyshem commented Nov 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment