X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3d98f9b1196260dbc7b9963dfd295d7e330e23d6..13f6d45704efc68ca8419e8917376aa44fdee1be:/lib/config/cmd.go diff --git a/lib/config/cmd.go b/lib/config/cmd.go index 7019e479cb..528d748c86 100644 --- a/lib/config/cmd.go +++ b/lib/config/cmd.go @@ -6,16 +6,18 @@ package config import ( "bytes" + "errors" "flag" "fmt" "io" - "io/ioutil" "os" "os/exec" - "git.curoverse.com/arvados.git/sdk/go/arvados" - "git.curoverse.com/arvados.git/sdk/go/ctxlog" + "git.arvados.org/arvados.git/lib/cmd" + "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/ctxlog" "github.com/ghodss/yaml" + "github.com/sirupsen/logrus" ) var DumpCommand dumpCommand @@ -30,23 +32,18 @@ func (dumpCommand) RunCommand(prog string, args []string, stdin io.Reader, stdou } }() - flags := flag.NewFlagSet("", flag.ContinueOnError) - flags.SetOutput(stderr) - configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`") - err = flags.Parse(args) - if err == flag.ErrHelp { - err = nil - return 0 - } else if err != nil { - return 2 + loader := &Loader{ + Stdin: stdin, + Logger: ctxlog.New(stderr, "text", "info"), } - if len(flags.Args()) != 0 { - flags.Usage() - return 2 + flags := flag.NewFlagSet("", flag.ContinueOnError) + loader.SetupFlags(flags) + + if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok { + return code } - log := ctxlog.New(stderr, "text", "info") - cfg, err := loadFileOrStdin(*configFile, stdin, log) + cfg, err := loader.Load() if err != nil { return 1 } @@ -67,45 +64,79 @@ type checkCommand struct{} func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int { var err error + var logbuf = &bytes.Buffer{} defer func() { + io.Copy(stderr, logbuf) if err != nil { fmt.Fprintf(stderr, "%s\n", err) } }() - flags := flag.NewFlagSet("", flag.ContinueOnError) - flags.SetOutput(stderr) - configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`") - err = flags.Parse(args) - if err == flag.ErrHelp { - err = nil - return 0 - } else if err != nil { - return 2 + logger := logrus.New() + logger.Out = logbuf + loader := &Loader{ + Stdin: stdin, + Logger: logger, } - if len(flags.Args()) != 0 { - flags.Usage() - return 2 - } - log := &plainLogger{w: stderr} - var buf []byte - if *configFile == "-" { - buf, err = ioutil.ReadAll(stdin) - } else { - buf, err = ioutil.ReadFile(*configFile) + flags := flag.NewFlagSet(prog, flag.ContinueOnError) + loader.SetupFlags(flags) + 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 + // keys/files, once with -- and then compare the two resulting + // configs. This reveals whether the deprecated keys/files + // have any effect on the final configuration. + // + // If they do, show the operator how to update their config + // such that the deprecated keys/files are superfluous and can + // be deleted. + loader.SkipDeprecated = true + loader.SkipLegacy = true + withoutDepr, err := loader.Load() if err != nil { return 1 } - withoutDepr, err := load(bytes.NewBuffer(buf), log, false) + // 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 } - withDepr, err := load(bytes.NewBuffer(buf), nil, true) - if err != nil { - return 1 + + // Check for configured vocabulary validity. + for id, cc := range withDepr.Clusters { + if cc.API.VocabularyPath == "" { + continue + } + vd, err := os.ReadFile(cc.API.VocabularyPath) + if err != nil { + if errors.Is(err, os.ErrNotExist) { + // If the vocabulary path doesn't exist, it might mean that + // the current node isn't the controller; so it's not an + // error. + continue + } + logger.Errorf("Error reading vocabulary file %q for cluster %s: %s\n", cc.API.VocabularyPath, id, err) + continue + } + mk := make([]string, 0, len(cc.Collections.ManagedProperties)) + for k := range cc.Collections.ManagedProperties { + mk = append(mk, k) + } + _, err = arvados.NewVocabulary(vd, mk) + if err != nil { + logger.Errorf("Error loading vocabulary file %q for cluster %s:\n%s\n", cc.API.VocabularyPath, id, err) + continue + } } + 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) @@ -125,43 +156,33 @@ 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 log.used { - return 1 + if logbuf.Len() > 0 { + if *strict { + return 1 + } } return 0 } -type plainLogger struct { - w io.Writer - used bool -} - -func (pl *plainLogger) Warnf(format string, args ...interface{}) { - pl.used = true - fmt.Fprintf(pl.w, format+"\n", args...) -} - var DumpDefaultsCommand defaultsCommand type defaultsCommand struct{} func (defaultsCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int { - var err error - defer func() { - if err != nil { - fmt.Fprintf(stderr, "%s\n", err) - } - }() - - _, err = stdout.Write(DefaultYAML) + _, err := stdout.Write(DefaultYAML) if err != nil { + fmt.Fprintln(stderr, err) return 1 } return 0