Skip to content

Migrates cmd/vtbench to pflags#11366

Merged
frouioui merged 4 commits intovitessio:mainfrom
planetscale:switch-pflag-vtbench
Sep 29, 2022
Merged

Migrates cmd/vtbench to pflags#11366
frouioui merged 4 commits intovitessio:mainfrom
planetscale:switch-pflag-vtbench

Conversation

@frouioui
Copy link
Copy Markdown
Member

Description

This PR changes cmd/vtbench to use pflags as instructed in #10697.

Related Issue(s)

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: CLI labels Sep 27, 2022
@frouioui frouioui requested a review from ajm188 as a code owner September 27, 2022 11:18
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented Sep 27, 2022

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive. Additionally, flag names should use dashes (-) as word separators rather than underscores (_).
  • If a workflow is added or modified, each items in Jobs should be named in order to mark it as required. If the workflow should be required, the GitHub Admin should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

Comment on lines 115 to 116
logger := logutil.NewConsoleLogger()
flag.CommandLine.SetOutput(logutil.NewLoggerWriter(logger))
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@ajm188, I was not sure whether this needs to be removed or not. I can see that #11364 is getting rid of it. Let me know what I should follow :)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

well, it depends on what you want 😅

if you want to keep the behavior, you want to something like:

servenv.OnParse(func(fs *pflag.FlagSet) {
    fs.SetOutput(logutil.NewLoggerWriter(logger))
}

@ajm188 ajm188 mentioned this pull request Sep 27, 2022
3 tasks
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui force-pushed the switch-pflag-vtbench branch from f135d07 to 9f46586 Compare September 29, 2022 02:21
Copy link
Copy Markdown
Contributor

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

LGTM!

@frouioui frouioui merged commit 2c5535b into vitessio:main Sep 29, 2022
@frouioui frouioui deleted the switch-pflag-vtbench branch September 29, 2022 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: CLI Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Switch flag definitions to be on pflag instead of flag in package go/cmd/vtbench

3 participants