lib/config/load.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package config
   6
   7 import (
   8         "bytes"
   9         "encoding/json"
  10         "errors"
  11         "flag"
  12         "fmt"
  13         "io"
  14         "io/ioutil"
  15         "os"
  16         "strings"
  17
  18         "git.curoverse.com/arvados.git/sdk/go/arvados"
  19         "github.com/ghodss/yaml"
  20         "github.com/imdario/mergo"
  21         "github.com/sirupsen/logrus"
  22 )
  23
  24 var ErrNoClustersDefined = errors.New("config does not define any clusters")
  25
  26 type Loader struct {
  27         Stdin          io.Reader
  28         Logger         logrus.FieldLogger
  29         SkipDeprecated bool // Don't load legacy/deprecated config keys/files
  30
  31         Path          string
  32         KeepstorePath string
  33
  34         configdata []byte
  35 }
  36
  37 // NewLoader returns a new Loader with Stdin and Logger set to the
  38 // given values, and all config paths set to their default values.
  39 func NewLoader(stdin io.Reader, logger logrus.FieldLogger) *Loader {
  40         ldr := &Loader{Stdin: stdin, Logger: logger}
  41         // Calling SetupFlags on a throwaway FlagSet has the side
  42         // effect of assigning default values to the configurable
  43         // fields.
  44         ldr.SetupFlags(flag.NewFlagSet("", flag.ContinueOnError))
  45         return ldr
  46 }
  47
  48 // SetupFlags configures a flagset so arguments like -config X can be
  49 // used to change the loader's Path fields.
  50 //
  51 //      ldr := NewLoader(os.Stdin, logrus.New())
  52 //      flagset := flag.NewFlagSet("", flag.ContinueOnError)
  53 //      ldr.SetupFlags(flagset)
  54 //      // ldr.Path == "/etc/arvados/config.yml"
  55 //      flagset.Parse([]string{"-config", "/tmp/c.yaml"})
  56 //      // ldr.Path == "/tmp/c.yaml"
  57 func (ldr *Loader) SetupFlags(flagset *flag.FlagSet) {
  58         flagset.StringVar(&ldr.Path, "config", arvados.DefaultConfigFile, "Site configuration `file` (default may be overridden by setting an ARVADOS_CONFIG environment variable)")
  59         flagset.StringVar(&ldr.KeepstorePath, "legacy-keepstore-config", defaultKeepstoreConfigPath, "Legacy keepstore configuration `file`")
  60 }
  61
  62 // MungeLegacyConfigArgs checks args for a -config flag whose argument
  63 // is a regular file (or a symlink to one), but doesn't have a
  64 // top-level "Clusters" key and therefore isn't a valid cluster
  65 // configuration file. If it finds such a flag, it replaces -config
  66 // with legacyConfigArg (e.g., "-legacy-keepstore-config").
  67 //
  68 // This is used by programs that still need to accept "-config" as a
  69 // way to specify a per-component config file until their config has
  70 // been migrated.
  71 //
  72 // If any errors are encountered while reading or parsing a config
  73 // file, the given args are not munged. We presume the same errors
  74 // will be encountered again and reported later on when trying to load
  75 // cluster configuration from the same file, regardless of which
  76 // struct we end up using.
  77 func (ldr *Loader) MungeLegacyConfigArgs(lgr logrus.FieldLogger, args []string, legacyConfigArg string) []string {
  78         munged := append([]string(nil), args...)
  79         for i := 0; i < len(args); i++ {
  80                 if !strings.HasPrefix(args[i], "-") || strings.SplitN(strings.TrimPrefix(args[i], "-"), "=", 2)[0] != "config" {
  81                         continue
  82                 }
  83                 var operand string
  84                 if strings.Contains(args[i], "=") {
  85                         operand = strings.SplitN(args[i], "=", 2)[1]
  86                 } else if i+1 < len(args) && !strings.HasPrefix(args[i+1], "-") {
  87                         i++
  88                         operand = args[i]
  89                 } else {
  90                         continue
  91                 }
  92                 if fi, err := os.Stat(operand); err != nil || !fi.Mode().IsRegular() {
  93                         continue
  94                 }
  95                 f, err := os.Open(operand)
  96                 if err != nil {
  97                         continue
  98                 }
  99                 defer f.Close()
 100                 buf, err := ioutil.ReadAll(f)
 101                 if err != nil {
 102                         continue
 103                 }
 104                 var cfg arvados.Config
 105                 err = yaml.Unmarshal(buf, &cfg)
 106                 if err != nil {
 107                         continue
 108                 }
 109                 if len(cfg.Clusters) == 0 {
 110                         lgr.Warnf("%s is not a cluster config file -- interpreting %s as %s (please migrate your config!)", operand, "-config", legacyConfigArg)
 111                         if operand == args[i] {
 112                                 munged[i-1] = legacyConfigArg
 113                         } else {
 114                                 munged[i] = legacyConfigArg + "=" + operand
 115                         }
 116                 }
 117         }
 118         return munged
 119 }
 120
 121 func (ldr *Loader) loadBytes(path string) ([]byte, error) {
 122         if path == "-" {
 123                 return ioutil.ReadAll(ldr.Stdin)
 124         }
 125         f, err := os.Open(path)
 126         if err != nil {
 127                 return nil, err
 128         }
 129         defer f.Close()
 130         return ioutil.ReadAll(f)
 131 }
 132
 133 func (ldr *Loader) Load() (*arvados.Config, error) {
 134         if ldr.configdata == nil {
 135                 buf, err := ldr.loadBytes(ldr.Path)
 136                 if err != nil {
 137                         return nil, err
 138                 }
 139                 ldr.configdata = buf
 140         }
 141
 142         // Load the config into a dummy map to get the cluster ID
 143         // keys, discarding the values; then set up defaults for each
 144         // cluster ID; then load the real config on top of the
 145         // defaults.
 146         var dummy struct {
 147                 Clusters map[string]struct{}
 148         }
 149         err := yaml.Unmarshal(ldr.configdata, &dummy)
 150         if err != nil {
 151                 return nil, err
 152         }
 153         if len(dummy.Clusters) == 0 {
 154                 return nil, ErrNoClustersDefined
 155         }
 156
 157         // We can't merge deep structs here; instead, we unmarshal the
 158         // default & loaded config files into generic maps, merge
 159         // those, and then json-encode+decode the result into the
 160         // config struct type.
 161         var merged map[string]interface{}
 162         for id := range dummy.Clusters {
 163                 var src map[string]interface{}
 164                 err = yaml.Unmarshal(bytes.Replace(DefaultYAML, []byte(" xxxxx:"), []byte(" "+id+":"), -1), &src)
 165                 if err != nil {
 166                         return nil, fmt.Errorf("loading defaults for %s: %s", id, err)
 167                 }
 168                 err = mergo.Merge(&merged, src, mergo.WithOverride)
 169                 if err != nil {
 170                         return nil, fmt.Errorf("merging defaults for %s: %s", id, err)
 171                 }
 172         }
 173         var src map[string]interface{}
 174         err = yaml.Unmarshal(ldr.configdata, &src)
 175         if err != nil {
 176                 return nil, fmt.Errorf("loading config data: %s", err)
 177         }
 178         ldr.logExtraKeys(merged, src, "")
 179         removeSampleKeys(merged)
 180         err = mergo.Merge(&merged, src, mergo.WithOverride)
 181         if err != nil {
 182                 return nil, fmt.Errorf("merging config data: %s", err)
 183         }
 184
 185         // map[string]interface{} => json => arvados.Config
 186         var cfg arvados.Config
 187         var errEnc error
 188         pr, pw := io.Pipe()
 189         go func() {
 190                 errEnc = json.NewEncoder(pw).Encode(merged)
 191                 pw.Close()
 192         }()
 193         err = json.NewDecoder(pr).Decode(&cfg)
 194         if errEnc != nil {
 195                 err = errEnc
 196         }
 197         if err != nil {
 198                 return nil, fmt.Errorf("transcoding config data: %s", err)
 199         }
 200
 201         if !ldr.SkipDeprecated {
 202                 err = ldr.applyDeprecatedConfig(&cfg)
 203                 if err != nil {
 204                         return nil, err
 205                 }
 206                 for _, err := range []error{
 207                         ldr.loadOldKeepstoreConfig(&cfg),
 208                 } {
 209                         if err != nil {
 210                                 return nil, err
 211                         }
 212                 }
 213         }
 214
 215         // Check for known mistakes
 216         for id, cc := range cfg.Clusters {
 217                 err = checkKeyConflict(fmt.Sprintf("Clusters.%s.PostgreSQL.Connection", id), cc.PostgreSQL.Connection)
 218                 if err != nil {
 219                         return nil, err
 220                 }
 221         }
 222         return &cfg, nil
 223 }
 224
 225 func checkKeyConflict(label string, m map[string]string) error {
 226         saw := map[string]bool{}
 227         for k := range m {
 228                 k = strings.ToLower(k)
 229                 if saw[k] {
 230                         return fmt.Errorf("%s: multiple entries for %q (fix by using same capitalization as default/example file)", label, k)
 231                 }
 232                 saw[k] = true
 233         }
 234         return nil
 235 }
 236
 237 func removeSampleKeys(m map[string]interface{}) {
 238         delete(m, "SAMPLE")
 239         for _, v := range m {
 240                 if v, _ := v.(map[string]interface{}); v != nil {
 241                         removeSampleKeys(v)
 242                 }
 243         }
 244 }
 245
 246 func (ldr *Loader) logExtraKeys(expected, supplied map[string]interface{}, prefix string) {
 247         if ldr.Logger == nil {
 248                 return
 249         }
 250         allowed := map[string]interface{}{}
 251         for k, v := range expected {
 252                 allowed[strings.ToLower(k)] = v
 253         }
 254         for k, vsupp := range supplied {
 255                 vexp, ok := allowed[strings.ToLower(k)]
 256                 if !ok && expected["SAMPLE"] != nil {
 257                         vexp = expected["SAMPLE"]
 258                 } else if !ok {
 259                         ldr.Logger.Warnf("deprecated or unknown config entry: %s%s", prefix, k)
 260                         continue
 261                 }
 262                 if vsupp, ok := vsupp.(map[string]interface{}); !ok {
 263                         // if vsupp is a map but vexp isn't map, this
 264                         // will be caught elsewhere; see TestBadType.
 265                         continue
 266                 } else if vexp, ok := vexp.(map[string]interface{}); !ok {
 267                         ldr.Logger.Warnf("unexpected object in config entry: %s%s", prefix, k)
 268                 } else {
 269                         ldr.logExtraKeys(vexp, vsupp, prefix+k+".")
 270                 }
 271         }
 272 }