[RFC] Standardized viper framework for vitess configuration parameters

go.mod

@@ -107,7 +107,9 @@ require (
 	github.com/hashicorp/go-version v1.6.0
 	github.com/kr/pretty v0.3.1
 	github.com/kr/text v0.2.0
+	github.com/mitchellh/mapstructure v1.5.0
 	github.com/nsf/jsondiff v0.0.0-20210926074059-1e845ec5d249
+	github.com/spf13/jwalterweatherman v1.1.0
 	github.com/xlab/treeprint v1.2.0
 	golang.org/x/exp v0.0.0-20230131160201-f062dba9d201
 	golang.org/x/sync v0.1.0
@@ -164,7 +166,6 @@ require (
 	github.com/mattn/go-runewidth v0.0.14 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/mitchellh/go-homedir v1.1.0 // indirect
-	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
@@ -179,7 +180,6 @@ require (
 	github.com/secure-systems-lab/go-securesystemslib v0.4.0 // indirect
 	github.com/spf13/afero v1.9.3 // indirect
 	github.com/spf13/cast v1.5.0 // indirect
-	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/subosito/gotenv v1.4.2 // indirect
 	github.com/tidwall/match v1.1.1 // indirect
 	github.com/tidwall/pretty v1.2.0 // indirect

go/flags/endtoend/flags_test.go

@@ -22,13 +22,16 @@ package flags
 
 import (
 	"bytes"
-	_ "embed"
+	"os"
 	"os/exec"
 	"testing"
+	"text/template"
 
-	"vitess.io/vitess/go/test/utils"
+	_ "embed"
 
 	"github.com/stretchr/testify/require"
+
+	"vitess.io/vitess/go/test/utils"
 )
 
 var (
@@ -105,16 +108,30 @@ var (
 )
 
 func TestHelpOutput(t *testing.T) {
+	wd, err := os.Getwd()
+	require.NoError(t, err)
+
 	args := []string{"--help"}
 	for binary, helptext := range helpOutput {
 		t.Run(binary, func(t *testing.T) {
+			tmpl, err := template.New(binary).Parse(helptext)
+			require.NoError(t, err)
+
+			var buf bytes.Buffer
+			err = tmpl.Execute(&buf, struct {
+				Workdir string
+			}{
+				Workdir: wd,
+			})
+			require.NoError(t, err)
+
 			cmd := exec.Command(binary, args...)
 			output := bytes.Buffer{}
 			cmd.Stderr = &output
 			cmd.Stdout = &output
-			err := cmd.Run()
+			err = cmd.Run()
 			require.NoError(t, err)
-			utils.MustMatch(t, helptext, output.String())
+			utils.MustMatch(t, buf.String(), output.String())
 		})
 	}
 }

go/flags/endtoend/mysqlctld.txt

@@ -3,6 +3,12 @@ Usage of mysqlctld:
       --app_idle_timeout duration                                        Idle timeout for app connections (default 1m0s)
       --app_pool_size int                                                Size of the connection pool for app connections (default 40)
       --catch-sigpipe                                                    catch and ignore SIGPIPE on stdout and stderr if specified
+      --config-file string                                               Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
+      --config-file-not-found-handling ConfigFileNotFoundHandling        Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
+      --config-name string                                               Name of the config file (without extension) to search for. (default "vtconfig")
+      --config-path strings                                              Paths to search for config files in. (default [{{.Workdir}}])
+      --config-persistence-min-interval duration                         minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
+      --config-type string                                               Config file type (omit to infer config type from file extension).
       --db-credentials-file string                                       db credentials file; send SIGHUP to reload this file
       --db-credentials-server string                                     db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file")
       --db-credentials-vault-addr string                                 URL to Vault server

go/flags/endtoend/vtaclcheck.txt

@@ -1,19 +1,25 @@
 Usage of vtaclcheck:
-      --acl-file string                  The path of the JSON ACL file to check
-      --alsologtostderr                  log to standard error as well as files
-  -h, --help                             display usage and exit
-      --keep_logs duration               keep logs for this long (using ctime) (zero to keep forever)
-      --keep_logs_by_mtime duration      keep logs for this long (using mtime) (zero to keep forever)
-      --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
-      --log_dir string                   If non-empty, write log files in this directory
-      --log_err_stacks                   log stack traces for errors
-      --log_rotate_max_size uint         size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
-      --logtostderr                      log to standard error instead of files
-      --pprof strings                    enable profiling
-      --purge_logs_interval duration     how often try to remove old logs (default 1h0m0s)
-      --security_policy string           the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)
-      --static-auth-file string          The path of the auth_server_static JSON file to check
-      --stderrthreshold severity         logs at or above this threshold go to stderr (default 1)
-      --v Level                          log level for V logs
-  -v, --version                          print binary version
-      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging
+      --acl-file string                                             The path of the JSON ACL file to check
+      --alsologtostderr                                             log to standard error as well as files
+      --config-file string                                          Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
+      --config-file-not-found-handling ConfigFileNotFoundHandling   Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
+      --config-name string                                          Name of the config file (without extension) to search for. (default "vtconfig")
+      --config-path strings                                         Paths to search for config files in. (default [{{.Workdir}}])
+      --config-persistence-min-interval duration                    minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
+      --config-type string                                          Config file type (omit to infer config type from file extension).
+  -h, --help                                                        display usage and exit
+      --keep_logs duration                                          keep logs for this long (using ctime) (zero to keep forever)
+      --keep_logs_by_mtime duration                                 keep logs for this long (using mtime) (zero to keep forever)
+      --log_backtrace_at traceLocation                              when logging hits line file:N, emit a stack trace (default :0)
+      --log_dir string                                              If non-empty, write log files in this directory
+      --log_err_stacks                                              log stack traces for errors
+      --log_rotate_max_size uint                                    size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
+      --logtostderr                                                 log to standard error instead of files
+      --pprof strings                                               enable profiling
+      --purge_logs_interval duration                                how often try to remove old logs (default 1h0m0s)
+      --security_policy string                                      the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)
+      --static-auth-file string                                     The path of the auth_server_static JSON file to check
+      --stderrthreshold severity                                    logs at or above this threshold go to stderr (default 1)
+      --v Level                                                     log level for V logs
+  -v, --version                                                     print binary version
+      --vmodule moduleSpec                                          comma-separated list of pattern=N settings for file-filtered logging