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: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.

cmd/bbolt/command_version.go

cmd/bbolt/main_test.go

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

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

cmd/bbolt/bbolt.exe

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.

cmd/bbolt/command_version.go

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.

cmd/bbolt/command_buckets.go

cmd/bbolt/command_buckets_test.go

tommyshem · 2024-11-19T00:07:04Z

All the changes from above should be done now.

ahrtr · 2024-11-19T10:46:20Z

@tommyshem you need to rebase this PR instead of merging main branch into your dev branch. Please also squash the commits into one.

tommyshem · 2024-11-19T19:49:45Z

Sorry new to github pull requests as only used github mainly for personal projects. I will try tomorrow to rebase and squash commits. Do I need to put any info in the commit text or just reference the issue number.

Signed-off-by: tommy shem <tommy@test.com>

k8s-ci-robot · 2024-11-22T09:12:00Z

[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

ahrtr · 2024-11-22T10:10:40Z

cmd/bbolt/command_buckets.go

+	if srcDBPath == "" {
+		return ErrPathRequired


I think the cobra.ExactArgs(1) already guarantees that it won't be empty string? Pleasae follow the same pattern as other command.

This check is from the original code.

"the original code" doesn't mean that it's necessary.

Please also always remember to simplify the the implementation,

bbolt/cmd/bbolt/command_inspect.go

Lines 26 to 30 in cb0618b

func inspectFunc(srcDBPath string) error {

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

return err

}

In order to avoid long back-and-forth, please see #859 (comment)

ahrtr · 2024-11-22T10:12:30Z

cmd/bbolt/command_buckets.go

+	// Print the list of buckets in the database.
+	return db.View(func(tx *bolt.Tx) error {
+		return tx.ForEach(func(name []byte, _ *bolt.Bucket) error {
+			fmt.Fprintln(cmd.OutOrStdout(), string(name))


I agree that cmd.OutOrStdout() is a little better than os.Stdout, but please keep it consistent with other commands. We can replace them with cmd.OutOrStdout() in separate PR.

cmd.OutOrStdout() is all ready used in the cobra style converted files already
command_check.go line 44, 65, 70
command_get.go line 46, 92
command_info.go line 47
command_version.go line 18, 19, 20

I see that it's only used in command_check.go. I should have raised this comment in PR 723.

Overall, not a big deal. Feel free to keep it as it's

I must have changed the over files in my copy above when I was testing the outputs.
As I had trouble capturing the output when I had converted to the cobra style without the cmd.OutOrStdout() function

cmd/bbolt/command_buckets.go

Co-authored-by: Benjamin Wang <benjamin.wang@broadcom.com>

ahrtr · 2024-12-06T09:29:47Z

This PR is almost ready to be approved & merged.

Please squash the commits and ensure it's signed off. thx

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 Show resolved Hide resolved

tommyshem commented Nov 11, 2024

View reviewed changes

cmd/bbolt/main_test.go Outdated Show resolved Hide resolved

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

cmd/bbolt/bbolt.exe Outdated Show resolved Hide resolved

ahrtr reviewed Nov 13, 2024

View reviewed changes

cmd/bbolt/command_version.go Outdated Show resolved Hide resolved

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

cmd/bbolt/command_buckets.go Outdated Show resolved Hide resolved

cmd/bbolt/command_buckets.go Outdated Show resolved Hide resolved

cmd/bbolt/command_buckets.go Show resolved Hide resolved

cmd/bbolt/command_buckets_test.go Outdated Show resolved Hide resolved

tommyshem force-pushed the cmd_buckets branch from 0c84aa2 to 4b3e3d4 Compare November 18, 2024 23:59

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

76ff28c

Signed-off-by: tommy shem <tommy@test.com>

tommyshem force-pushed the cmd_buckets branch from 4b3e3d4 to 76ff28c Compare November 22, 2024 09:11

ahrtr reviewed Nov 22, 2024

View reviewed changes

ahrtr reviewed Nov 25, 2024

View reviewed changes

cmd/bbolt/command_buckets.go Outdated Show resolved Hide resolved

remove srcDBPath check

588bfbb

Co-authored-by: Benjamin Wang <benjamin.wang@broadcom.com>

tommyshem closed this Dec 6, 2024

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

ivanvc commented Nov 11, 2024

ahrtr commented Nov 11, 2024

ahrtr commented Nov 12, 2024

tommyshem commented Nov 12, 2024

tommyshem commented Nov 13, 2024

tommyshem commented Nov 19, 2024

ahrtr commented Nov 19, 2024

tommyshem commented Nov 19, 2024

k8s-ci-robot commented Nov 22, 2024

ahrtr Nov 22, 2024

tommyshem Nov 24, 2024

ahrtr Nov 25, 2024

ahrtr Nov 25, 2024

ahrtr Nov 22, 2024

tommyshem Nov 24, 2024

ahrtr Nov 25, 2024

tommyshem Nov 25, 2024

ahrtr commented Dec 6, 2024

	func inspectFunc(srcDBPath string) error {
	if _, err := checkSourceDBPath(srcDBPath); err != nil {
	return err
	}

command buckets converted to the cobra style #859

command buckets converted to the cobra style #859

Conversation

tommyshem commented Nov 10, 2024

k8s-ci-robot commented Nov 10, 2024

ivanvc commented Nov 11, 2024

ahrtr commented Nov 11, 2024

ahrtr commented Nov 12, 2024

tommyshem commented Nov 12, 2024

tommyshem commented Nov 13, 2024

tommyshem commented Nov 19, 2024

ahrtr commented Nov 19, 2024

tommyshem commented Nov 19, 2024

k8s-ci-robot commented Nov 22, 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

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

ahrtr commented Dec 6, 2024