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 type Loader struct {
  25         Stdin          io.Reader
  26         Logger         logrus.FieldLogger
  27         SkipDeprecated bool
  28
  29         Path          string
  30         KeepstorePath string
  31
  32         configdata []byte
  33 }
  34
  35 func NewLoader(stdin io.Reader, logger logrus.FieldLogger) *Loader {
  36         ldr := &Loader{Stdin: stdin, Logger: logger}
  37         ldr.SetupFlags(flag.NewFlagSet("", flag.ContinueOnError))
  38         ldr.Path = "-"
  39         return ldr
  40 }
  41
  42 // SetupFlags configures a flagset so arguments like -config X can be
  43 // used to change the loader's Path fields.
  44 //
  45 //      ldr := NewLoader(os.Stdin, logrus.New())
  46 //      flagset := flag.NewFlagSet("", flag.ContinueOnError)
  47 //      ldr.SetupFlags(flagset)
  48 //      // ldr.Path == "/etc/arvados/config.yml"
  49 //      flagset.Parse([]string{"-config", "/tmp/c.yaml"})
  50 //      // ldr.Path == "/tmp/c.yaml"
  51 func (ldr *Loader) SetupFlags(flagset *flag.FlagSet) {
  52         flagset.StringVar(&ldr.Path, "config", arvados.DefaultConfigFile, "Site configuration `file`")
  53         flagset.StringVar(&ldr.KeepstorePath, "legacy-keepstore-config", defaultKeepstoreConfigPath, "Legacy keepstore configuration `file`")
  54 }
  55
  56 func (ldr *Loader) loadBytes(path string) ([]byte, error) {
  57         if path == "-" {
  58                 return ioutil.ReadAll(ldr.Stdin)
  59         }
  60         f, err := os.Open(path)
  61         if err != nil {
  62                 return nil, err
  63         }
  64         defer f.Close()
  65         return ioutil.ReadAll(f)
  66 }
  67
  68 func (ldr *Loader) Load() (*arvados.Config, error) {
  69         if ldr.configdata == nil {
  70                 buf, err := ldr.loadBytes(ldr.Path)
  71                 if err != nil {
  72                         return nil, err
  73                 }
  74                 ldr.configdata = buf
  75         }
  76
  77         // Load the config into a dummy map to get the cluster ID
  78         // keys, discarding the values; then set up defaults for each
  79         // cluster ID; then load the real config on top of the
  80         // defaults.
  81         var dummy struct {
  82                 Clusters map[string]struct{}
  83         }
  84         err := yaml.Unmarshal(ldr.configdata, &dummy)
  85         if err != nil {
  86                 return nil, err
  87         }
  88         if len(dummy.Clusters) == 0 {
  89                 return nil, errors.New("config does not define any clusters")
  90         }
  91
  92         // We can't merge deep structs here; instead, we unmarshal the
  93         // default & loaded config files into generic maps, merge
  94         // those, and then json-encode+decode the result into the
  95         // config struct type.
  96         var merged map[string]interface{}
  97         for id := range dummy.Clusters {
  98                 var src map[string]interface{}
  99                 err = yaml.Unmarshal(bytes.Replace(DefaultYAML, []byte(" xxxxx:"), []byte(" "+id+":"), -1), &src)
 100                 if err != nil {
 101                         return nil, fmt.Errorf("loading defaults for %s: %s", id, err)
 102                 }
 103                 err = mergo.Merge(&merged, src, mergo.WithOverride)
 104                 if err != nil {
 105                         return nil, fmt.Errorf("merging defaults for %s: %s", id, err)
 106                 }
 107         }
 108         var src map[string]interface{}
 109         err = yaml.Unmarshal(ldr.configdata, &src)
 110         if err != nil {
 111                 return nil, fmt.Errorf("loading config data: %s", err)
 112         }
 113         ldr.logExtraKeys(merged, src, "")
 114         removeSampleKeys(merged)
 115         err = mergo.Merge(&merged, src, mergo.WithOverride)
 116         if err != nil {
 117                 return nil, fmt.Errorf("merging config data: %s", err)
 118         }
 119
 120         // map[string]interface{} => json => arvados.Config
 121         var cfg arvados.Config
 122         var errEnc error
 123         pr, pw := io.Pipe()
 124         go func() {
 125                 errEnc = json.NewEncoder(pw).Encode(merged)
 126                 pw.Close()
 127         }()
 128         err = json.NewDecoder(pr).Decode(&cfg)
 129         if errEnc != nil {
 130                 err = errEnc
 131         }
 132         if err != nil {
 133                 return nil, fmt.Errorf("transcoding config data: %s", err)
 134         }
 135
 136         if !ldr.SkipDeprecated {
 137                 err = ldr.applyDeprecatedConfig(&cfg)
 138                 if err != nil {
 139                         return nil, err
 140                 }
 141                 for _, err := range []error{
 142                         ldr.loadOldKeepstoreConfig(&cfg),
 143                 } {
 144                         if err != nil {
 145                                 return nil, err
 146                         }
 147                 }
 148         }
 149
 150         // Check for known mistakes
 151         for id, cc := range cfg.Clusters {
 152                 err = checkKeyConflict(fmt.Sprintf("Clusters.%s.PostgreSQL.Connection", id), cc.PostgreSQL.Connection)
 153                 if err != nil {
 154                         return nil, err
 155                 }
 156         }
 157         return &cfg, nil
 158 }
 159
 160 func checkKeyConflict(label string, m map[string]string) error {
 161         saw := map[string]bool{}
 162         for k := range m {
 163                 k = strings.ToLower(k)
 164                 if saw[k] {
 165                         return fmt.Errorf("%s: multiple entries for %q (fix by using same capitalization as default/example file)", label, k)
 166                 }
 167                 saw[k] = true
 168         }
 169         return nil
 170 }
 171
 172 func removeSampleKeys(m map[string]interface{}) {
 173         delete(m, "SAMPLE")
 174         for _, v := range m {
 175                 if v, _ := v.(map[string]interface{}); v != nil {
 176                         removeSampleKeys(v)
 177                 }
 178         }
 179 }
 180
 181 func (ldr *Loader) logExtraKeys(expected, supplied map[string]interface{}, prefix string) {
 182         if ldr.Logger == nil {
 183                 return
 184         }
 185         allowed := map[string]interface{}{}
 186         for k, v := range expected {
 187                 allowed[strings.ToLower(k)] = v
 188         }
 189         for k, vsupp := range supplied {
 190                 vexp, ok := allowed[strings.ToLower(k)]
 191                 if !ok && expected["SAMPLE"] != nil {
 192                         vexp = expected["SAMPLE"]
 193                 } else if !ok {
 194                         ldr.Logger.Warnf("deprecated or unknown config entry: %s%s", prefix, k)
 195                         continue
 196                 }
 197                 if vsupp, ok := vsupp.(map[string]interface{}); !ok {
 198                         // if vsupp is a map but vexp isn't map, this
 199                         // will be caught elsewhere; see TestBadType.
 200                         continue
 201                 } else if vexp, ok := vexp.(map[string]interface{}); !ok {
 202                         ldr.Logger.Warnf("unexpected object in config entry: %s%s", prefix, k)
 203                 } else {
 204                         ldr.logExtraKeys(vexp, vsupp, prefix+k+".")
 205                 }
 206         }
 207 }