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         "fmt"
  12         "io"
  13         "io/ioutil"
  14         "os"
  15         "strings"
  16
  17         "git.curoverse.com/arvados.git/sdk/go/arvados"
  18         "github.com/ghodss/yaml"
  19         "github.com/imdario/mergo"
  20 )
  21
  22 type logger interface {
  23         Warnf(string, ...interface{})
  24 }
  25
  26 func loadFileOrStdin(path string, stdin io.Reader, log logger) (*arvados.Config, error) {
  27         if path == "-" {
  28                 return load(stdin, log, true)
  29         } else {
  30                 return LoadFile(path, log)
  31         }
  32 }
  33
  34 func LoadFile(path string, log logger) (*arvados.Config, error) {
  35         f, err := os.Open(path)
  36         if err != nil {
  37                 return nil, err
  38         }
  39         defer f.Close()
  40         return Load(f, log)
  41 }
  42
  43 func Load(rdr io.Reader, log logger) (*arvados.Config, error) {
  44         return load(rdr, log, true)
  45 }
  46
  47 func load(rdr io.Reader, log logger, useDeprecated bool) (*arvados.Config, error) {
  48         buf, err := ioutil.ReadAll(rdr)
  49         if err != nil {
  50                 return nil, err
  51         }
  52
  53         // Load the config into a dummy map to get the cluster ID
  54         // keys, discarding the values; then set up defaults for each
  55         // cluster ID; then load the real config on top of the
  56         // defaults.
  57         var dummy struct {
  58                 Clusters map[string]struct{}
  59         }
  60         err = yaml.Unmarshal(buf, &dummy)
  61         if err != nil {
  62                 return nil, err
  63         }
  64         if len(dummy.Clusters) == 0 {
  65                 return nil, errors.New("config does not define any clusters")
  66         }
  67
  68         // We can't merge deep structs here; instead, we unmarshal the
  69         // default & loaded config files into generic maps, merge
  70         // those, and then json-encode+decode the result into the
  71         // config struct type.
  72         var merged map[string]interface{}
  73         for id := range dummy.Clusters {
  74                 var src map[string]interface{}
  75                 err = yaml.Unmarshal(bytes.Replace(DefaultYAML, []byte(" xxxxx:"), []byte(" "+id+":"), -1), &src)
  76                 if err != nil {
  77                         return nil, fmt.Errorf("loading defaults for %s: %s", id, err)
  78                 }
  79                 err = mergo.Merge(&merged, src, mergo.WithOverride)
  80                 if err != nil {
  81                         return nil, fmt.Errorf("merging defaults for %s: %s", id, err)
  82                 }
  83         }
  84         var src map[string]interface{}
  85         err = yaml.Unmarshal(buf, &src)
  86         if err != nil {
  87                 return nil, fmt.Errorf("loading config data: %s", err)
  88         }
  89         logExtraKeys(log, merged, src, "")
  90         removeSampleKeys(merged)
  91         err = mergo.Merge(&merged, src, mergo.WithOverride)
  92         if err != nil {
  93                 return nil, fmt.Errorf("merging config data: %s", err)
  94         }
  95
  96         // map[string]interface{} => json => arvados.Config
  97         var cfg arvados.Config
  98         var errEnc error
  99         pr, pw := io.Pipe()
 100         go func() {
 101                 errEnc = json.NewEncoder(pw).Encode(merged)
 102                 pw.Close()
 103         }()
 104         err = json.NewDecoder(pr).Decode(&cfg)
 105         if errEnc != nil {
 106                 err = errEnc
 107         }
 108         if err != nil {
 109                 return nil, fmt.Errorf("transcoding config data: %s", err)
 110         }
 111
 112         if useDeprecated {
 113                 err = applyDeprecatedConfig(&cfg, buf, log)
 114                 if err != nil {
 115                         return nil, err
 116                 }
 117         }
 118
 119         // Check for known mistakes
 120         for id, cc := range cfg.Clusters {
 121                 err = checkKeyConflict(fmt.Sprintf("Clusters.%s.PostgreSQL.Connection", id), cc.PostgreSQL.Connection)
 122                 if err != nil {
 123                         return nil, err
 124                 }
 125         }
 126         return &cfg, nil
 127 }
 128
 129 func checkKeyConflict(label string, m map[string]string) error {
 130         saw := map[string]bool{}
 131         for k := range m {
 132                 k = strings.ToLower(k)
 133                 if saw[k] {
 134                         return fmt.Errorf("%s: multiple entries for %q (fix by using same capitalization as default/example file)", label, k)
 135                 }
 136                 saw[k] = true
 137         }
 138         return nil
 139 }
 140
 141 func removeSampleKeys(m map[string]interface{}) {
 142         delete(m, "SAMPLE")
 143         for _, v := range m {
 144                 if v, _ := v.(map[string]interface{}); v != nil {
 145                         removeSampleKeys(v)
 146                 }
 147         }
 148 }
 149
 150 func logExtraKeys(log logger, expected, supplied map[string]interface{}, prefix string) {
 151         if log == nil {
 152                 return
 153         }
 154         allowed := map[string]interface{}{}
 155         for k, v := range expected {
 156                 allowed[strings.ToLower(k)] = v
 157         }
 158         for k, vsupp := range supplied {
 159                 vexp, ok := allowed[strings.ToLower(k)]
 160                 if !ok && expected["SAMPLE"] != nil {
 161                         vexp = expected["SAMPLE"]
 162                 } else if !ok {
 163                         log.Warnf("deprecated or unknown config entry: %s%s", prefix, k)
 164                         continue
 165                 }
 166                 if vsupp, ok := vsupp.(map[string]interface{}); !ok {
 167                         // if vsupp is a map but vexp isn't map, this
 168                         // will be caught elsewhere; see TestBadType.
 169                         continue
 170                 } else if vexp, ok := vexp.(map[string]interface{}); !ok {
 171                         log.Warnf("unexpected object in config entry: %s%s", prefix, k)
 172                 } else {
 173                         logExtraKeys(log, vexp, vsupp, prefix+k+".")
 174                 }
 175         }
 176 }