Skip to content

Normalize flag names at the pflag level. #18642

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

Merged
arthurschreiber merged 14 commits into from
Sep 15, 2025
Merged

Normalize flag names at the pflag level. #18642

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
73d3bf0
Normalize flag names at the `pflag` level.
arthurschreiber Sep 12, 2025
c6cfeae
Only normalize flag names that don't contain `-` (this makes flags li…
arthurschreiber Sep 12, 2025
f8cd042
Do not normalize glog flag names.
arthurschreiber Sep 12, 2025
6ee6f6b
Fixup.
arthurschreiber Sep 12, 2025
53d3f18
Also ignore `log_link` from `glog`.
arthurschreiber Sep 12, 2025
4328a8b
Fix deprecated variable name.
arthurschreiber Sep 12, 2025
9673a5e
Rename `mysqld_args` to `mysqld-args`.
arthurschreiber Sep 12, 2025
1efa5ff
Print deprecation messages to stderr instead of stdout.
arthurschreiber Sep 12, 2025
8297840
Stop testing flag variations in unit tests.
arthurschreiber Sep 12, 2025
3ed3b99
Fix more flag related unit tests to not test for underscore flags.
arthurschreiber Sep 12, 2025
dcaf770
Fix another use of flag variants in unit tests.
arthurschreiber Sep 12, 2025
afc0d89
Do not use flag variants in vtorc tests.
arthurschreiber Sep 12, 2025
951f1dc
Small cleanups.
arthurschreiber Sep 15, 2025
8d1da6f
test: cleanup
systay Sep 15, 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
3 changes: 3 additions & 0 deletions go/cmd/mysqlctl/mysqlctl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,12 @@ package main
import (
"vitess.io/vitess/go/cmd/mysqlctl/command"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
command.Root.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)

if err := command.Root.Execute(); err != nil {
log.Exit(err)
}
Expand Down
3 changes: 3 additions & 0 deletions go/cmd/mysqlctld/mysqlctld.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@ package main
import (
"vitess.io/vitess/go/cmd/mysqlctld/cli"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)

if err := cli.Main.Execute(); err != nil {
log.Exit(err)
}
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/rulesctl/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ import (
vtlog "vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/utils"
)

func main() {
rootCmd := cmd.Main()
rootCmd.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
vtlog.RegisterFlags(rootCmd.PersistentFlags())
logutil.RegisterFlags(rootCmd.PersistentFlags())
acl.RegisterFlags(rootCmd.PersistentFlags())
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/topo2topo/topo2topo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ import (
"vitess.io/vitess/go/cmd/topo2topo/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.RecoverAll()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Exitf("%s", err)
}
Expand Down
3 changes: 3 additions & 0 deletions go/cmd/vtaclcheck/cli/vtactlcheck.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"vitess.io/vitess/go/acl"
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vtaclcheck"
)

Expand Down Expand Up @@ -58,6 +59,8 @@ func run(cmd *cobra.Command, args []string) error {
}

func init() {
Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)

servenv.MoveFlagsToCobraCommand(Main)

Main.Flags().StringVar(&aclFile, "acl-file", aclFile, "The path of the JSON ACL file to check")
Expand Down
1 change: 1 addition & 0 deletions go/cmd/vtadmin/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ func registerFlags() {
func main() {
registerFlags()

rootCmd.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := rootCmd.Execute(); err != nil {
log.Fatal(err)
}
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtbackup/vtbackup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ import (
"vitess.io/vitess/go/cmd/vtbackup/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.Recover()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Error(err)
exit.Return(1)
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtbench/vtbench.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ import (
"vitess.io/vitess/go/cmd/vtbench/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.Recover()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Exit(err)
}
Expand Down
3 changes: 3 additions & 0 deletions go/cmd/vtclient/vtclient.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@ package main
import (
"vitess.io/vitess/go/cmd/vtclient/cli"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
cli.InitializeFlags()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Exit(err)
}
Expand Down
4 changes: 2 additions & 2 deletions go/cmd/vtcombo/cli/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,8 @@ func run(cmd *cobra.Command, args []string) (err error) {

// vtctld UI requires the cell flag
cmd.Flags().Set("cell", tpb.Cells[0])
if f := cmd.Flags().Lookup("log_dir"); f != nil && !f.Changed {
cmd.Flags().Set("log_dir", "$VTDATAROOT/tmp")
if f := cmd.Flags().Lookup("log-dir"); f != nil && !f.Changed {
Comment thread
arthurschreiber marked this conversation as resolved.
Outdated
cmd.Flags().Set("log-dir", "$VTDATAROOT/tmp")
}

env, err = vtenv.New(vtenv.Options{
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtcombo/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@ import (
"vitess.io/vitess/go/cmd/vtcombo/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.Recover()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Error(err)
exit.Return(1)
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtctl/vtctl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ func init() {
fs.BoolVar(&detachedMode, "detach", detachedMode, "detached mode - run vtcl detached from the terminal")

acl.RegisterFlags(fs)

fs.SetNormalizeFunc(utils.NormalizeUnderscoresToDashes)
})
}

Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtctlclient/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ func init() {
fs.StringVar(&server, "server", server, "server to use for connection")

acl.RegisterFlags(fs)

fs.SetNormalizeFunc(utils.NormalizeUnderscoresToDashes)
})
}

Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtctld/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ package main
import (
"vitess.io/vitess/go/cmd/vtctld/cli"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Fatal(err)
}
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtctldclient/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"vitess.io/vitess/go/vt/vttablet/tmclient"

_flag "vitess.io/vitess/go/internal/flag"
flagUtils "vitess.io/vitess/go/vt/utils"
)

func main() {
Expand All @@ -55,6 +56,7 @@ func main() {
// hack to get rid of an "ERROR: logging before flag.Parse"
_flag.TrickGlog()

command.Root.SetGlobalNormalizationFunc(flagUtils.NormalizeUnderscoresToDashes)
// back to your regularly scheduled cobra programming
if err := command.Root.Execute(); err != nil {
log.Error(err)
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtexplain/vtexplain.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@ import (

"vitess.io/vitess/go/cmd/vtexplain/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.RecoverAll()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
fmt.Printf("ERROR: %s\n", err)
exit.Return(1)
Expand Down
4 changes: 1 addition & 3 deletions go/cmd/vtgate/cli/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,5 @@ func init() {
Main.Flags().StringVar(&plannerName, "planner-version", plannerName, "Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right")

// Support both variants until v25
// Main.MarkFlagRequired("tablet-types-to-wait")
Main.MarkFlagsOneRequired("tablet-types-to-wait", "tablet_types_to_wait")

Main.MarkFlagsOneRequired("tablet-types-to-wait")
}
2 changes: 2 additions & 0 deletions go/cmd/vtgate/vtgate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ package main
import (
"vitess.io/vitess/go/cmd/vtgate/cli"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Exit(err)
}
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtgateclienttest/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ import (
"vitess.io/vitess/go/cmd/vtgateclienttest/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.Recover()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Exitf("%s", err)
}
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vtorc/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ package main
import (
"vitess.io/vitess/go/cmd/vtorc/cli"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

// main is the application's entry point. It will spawn an HTTP interface.
func main() {
// TODO: viperutil.BindFlags()

cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Exit(err)
}
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/vttablet/vttablet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ package main
import (
"vitess.io/vitess/go/cmd/vttablet/cli"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Exit(err)
}
Expand Down
5 changes: 4 additions & 1 deletion go/cmd/vttestserver/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@ package main
import (
"vitess.io/vitess/go/cmd/vttestserver/cli"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
if err := cli.New().Execute(); err != nil {
cmd := cli.New()
cmd.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cmd.Execute(); err != nil {
log.Fatal(err)
}
}
2 changes: 2 additions & 0 deletions go/cmd/vttlstest/vttlstest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ import (
"vitess.io/vitess/go/cmd/vttlstest/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.Recover()
defer logutil.Flush()

cli.Root.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
cobra.CheckErr(cli.Root.Execute())
}
2 changes: 2 additions & 0 deletions go/cmd/zk/zkcmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"vitess.io/vitess/go/cmd/zk/command"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
Expand All @@ -38,6 +39,7 @@ func main() {
cancel()
}()

command.Root.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
// Run the command.
if err := command.Root.ExecuteContext(ctx); err != nil {
log.Error(err)
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/zkctl/zkctl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ import (
"vitess.io/vitess/go/cmd/zkctl/command"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.Recover()

command.Root.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := command.Root.Execute(); err != nil {
log.Error(err)
exit.Return(1)
Expand Down
2 changes: 2 additions & 0 deletions go/cmd/zkctld/zkctld.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ import (
"vitess.io/vitess/go/cmd/zkctld/cli"
"vitess.io/vitess/go/exit"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)

func main() {
defer exit.Recover()
cli.Main.SetGlobalNormalizationFunc(utils.NormalizeUnderscoresToDashes)
if err := cli.Main.Execute(); err != nil {
log.Error(err)
exit.Return(1)
Expand Down
4 changes: 2 additions & 2 deletions go/vt/servenv/servenv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,10 +357,10 @@ func moveFlags(name string, fs *pflag.FlagSet) {
// glog flags, no better way to do this
_flag.PreventGlogVFlagFromClobberingVersionFlagShorthand(fs)
fs.AddGoFlag(flag.Lookup("logtostderr"))
fs.AddGoFlag(flag.Lookup("log_backtrace_at"))
Comment thread
arthurschreiber marked this conversation as resolved.
fs.AddGoFlag(flag.Lookup("log-backtrace-at"))
fs.AddGoFlag(flag.Lookup("alsologtostderr"))
fs.AddGoFlag(flag.Lookup("stderrthreshold"))
fs.AddGoFlag(flag.Lookup("log_dir"))
fs.AddGoFlag(flag.Lookup("log-dir"))
fs.AddGoFlag(flag.Lookup("vmodule"))

pflag.CommandLine = fs
Expand Down
Loading
Loading