17840: Deduplicate flag-parsing code.
[arvados.git] / lib / config / cmd.go
index d64106fbce6eaf9a5d2eefb246e15c4bc5017e92..eeab6ac8cd0dfad10f82f97880db0187f3e412bd 100644 (file)
@@ -12,7 +12,7 @@ import (
        "os"
        "os/exec"
 
-       "git.arvados.org/arvados.git/sdk/go/arvados"
+       "git.arvados.org/arvados.git/lib/cmd"
        "git.arvados.org/arvados.git/sdk/go/ctxlog"
        "github.com/ghodss/yaml"
        "github.com/sirupsen/logrus"
@@ -36,22 +36,11 @@ func (dumpCommand) RunCommand(prog string, args []string, stdin io.Reader, stdou
        }
 
        flags := flag.NewFlagSet("", flag.ContinueOnError)
-       flags.SetOutput(stderr)
        loader.SetupFlags(flags)
 
-       err = flags.Parse(args)
-       if err == flag.ErrHelp {
-               err = nil
-               return 0
-       } else if err != nil {
-               return 2
-       }
-
-       if len(flags.Args()) != 0 {
-               flags.Usage()
-               return 2
+       if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
+               return code
        }
-
        cfg, err := loader.Load()
        if err != nil {
                return 1
@@ -88,21 +77,11 @@ func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdo
                Logger: logger,
        }
 
-       flags := flag.NewFlagSet("", flag.ContinueOnError)
-       flags.SetOutput(stderr)
+       flags := flag.NewFlagSet(prog, flag.ContinueOnError)
        loader.SetupFlags(flags)
-
-       err = flags.Parse(args)
-       if err == flag.ErrHelp {
-               err = nil
-               return 0
-       } else if err != nil {
-               return 2
-       }
-
-       if len(flags.Args()) != 0 {
-               flags.Usage()
-               return 2
+       strict := flags.Bool("strict", true, "Strict validation of configuration file (warnings result in non-zero exit code)")
+       if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
+               return code
        }
 
        // Load the config twice -- once without loading deprecated
@@ -119,16 +98,15 @@ func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdo
        if err != nil {
                return 1
        }
+       // Reset() to avoid printing the same warnings twice when they
+       // are logged by both without-legacy and with-legacy loads.
+       logbuf.Reset()
        loader.SkipDeprecated = false
        loader.SkipLegacy = false
        withDepr, err := loader.Load()
        if err != nil {
                return 1
        }
-       problems := false
-       if warnAboutProblems(logger, withDepr) {
-               problems = true
-       }
        cmd := exec.Command("diff", "-u", "--label", "without-deprecated-configs", "--label", "relying-on-deprecated-configs", "/dev/fd/3", "/dev/fd/4")
        for _, obj := range []interface{}{withoutDepr, withDepr} {
                y, _ := yaml.Marshal(obj)
@@ -148,37 +126,23 @@ func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdo
                fmt.Fprintln(stdout, "Your configuration is relying on deprecated entries. Suggest making the following changes.")
                stdout.Write(diff)
                err = nil
-               return 1
+               if *strict {
+                       return 1
+               }
        } else if len(diff) > 0 {
                fmt.Fprintf(stderr, "Unexpected diff output:\n%s", diff)
-               return 1
+               if *strict {
+                       return 1
+               }
        } else if err != nil {
                return 1
        }
        if logbuf.Len() > 0 {
-               return 1
-       }
-
-       if problems {
-               return 1
-       } else {
-               return 0
-       }
-}
-
-func warnAboutProblems(logger logrus.FieldLogger, cfg *arvados.Config) bool {
-       warned := false
-       for id, cc := range cfg.Clusters {
-               if cc.SystemRootToken == "" {
-                       logger.Warnf("Clusters.%s.SystemRootToken is empty; see https://doc.arvados.org/master/install/install-keepstore.html", id)
-                       warned = true
-               }
-               if cc.ManagementToken == "" {
-                       logger.Warnf("Clusters.%s.ManagementToken is empty; see https://doc.arvados.org/admin/management-token.html", id)
-                       warned = true
+               if *strict {
+                       return 1
                }
        }
-       return warned
+       return 0
 }
 
 var DumpDefaultsCommand defaultsCommand