13647: Check ARVADOS_* env vars when loading config.

[arvados.git] / lib / config / load_test.go

diff --git a/lib/config/load_test.go b/lib/config/load_test.go
index fa04c007515c1cf155bdefff87be4b2daa30eee5..2e521ab0932218cd2f2e1e7f7f976dbbdf3c26d4 100644 (file)
--- a/lib/config/load_test.go
+++ b/lib/config/load_test.go
@@ -46,6 +46,12 @@ func testLoader(c *check.C, configdata string, logdst io.Writer) *Loader {
 
 type LoadSuite struct{}
 
+func (s *LoadSuite) SetUpSuite(c *check.C) {
+       os.Unsetenv("ARVADOS_API_HOST")
+       os.Unsetenv("ARVADOS_API_HOST_INSECURE")
+       os.Unsetenv("ARVADOS_API_TOKEN")
+}
+
 func (s *LoadSuite) TestEmpty(c *check.C) {
        cfg, err := testLoader(c, "", nil).Load()
        c.Check(cfg, check.IsNil)
@@ -321,7 +327,7 @@ Clusters:
 }
 
 func (s *LoadSuite) TestMovedKeys(c *check.C) {
-       s.checkEquivalent(c, `# config has old keys only
+       checkEquivalent(c, `# config has old keys only
 Clusters:
  zzzzz:
   RequestLimits:
@@ -334,7 +340,7 @@ Clusters:
    MaxRequestAmplification: 3
    MaxItemsPerResponse: 999
 `)
-       s.checkEquivalent(c, `# config has both old and new keys; old values win
+       checkEquivalent(c, `# config has both old and new keys; old values win
 Clusters:
  zzzzz:
   RequestLimits:
@@ -352,26 +358,118 @@ Clusters:
 `)
 }
 
-func (s *LoadSuite) checkEquivalent(c *check.C, goty, expectedy string) {
-       got, err := testLoader(c, goty, nil).Load()
+func checkEquivalent(c *check.C, goty, expectedy string) {
+       gotldr := testLoader(c, goty, nil)
+       expectedldr := testLoader(c, expectedy, nil)
+       checkEquivalentLoaders(c, gotldr, expectedldr)
+}
+
+func checkEqualYAML(c *check.C, got, expected interface{}) {
+       expectedyaml, err := yaml.Marshal(expected)
        c.Assert(err, check.IsNil)
-       expected, err := testLoader(c, expectedy, nil).Load()
+       gotyaml, err := yaml.Marshal(got)
        c.Assert(err, check.IsNil)
-       if !c.Check(got, check.DeepEquals, expected) {
+       if !bytes.Equal(gotyaml, expectedyaml) {
                cmd := exec.Command("diff", "-u", "--label", "expected", "--label", "got", "/dev/fd/3", "/dev/fd/4")
-               for _, obj := range []interface{}{expected, got} {
-                       y, _ := yaml.Marshal(obj)
+               for _, y := range [][]byte{expectedyaml, gotyaml} {
                        pr, pw, err := os.Pipe()
                        c.Assert(err, check.IsNil)
                        defer pr.Close()
-                       go func() {
-                               io.Copy(pw, bytes.NewBuffer(y))
+                       go func(data []byte) {
+                               pw.Write(data)
                                pw.Close()
-                       }()
+                       }(y)
                        cmd.ExtraFiles = append(cmd.ExtraFiles, pr)
                }
                diff, err := cmd.CombinedOutput()
+               // diff should report differences and exit non-zero.
+               c.Check(err, check.NotNil)
                c.Log(string(diff))
-               c.Check(err, check.IsNil)
+               c.Error("got != expected; see diff (-expected +got) above")
+       }
+}
+
+func checkEquivalentLoaders(c *check.C, gotldr, expectedldr *Loader) {
+       got, err := gotldr.Load()
+       c.Assert(err, check.IsNil)
+       expected, err := expectedldr.Load()
+       c.Assert(err, check.IsNil)
+       checkEqualYAML(c, got, expected)
+}
+
+func checkListKeys(path string, x interface{}) (err error) {
+       v := reflect.Indirect(reflect.ValueOf(x))
+       switch v.Kind() {
+       case reflect.Map:
+               iter := v.MapRange()
+               for iter.Next() {
+                       k := iter.Key()
+                       if k.Kind() == reflect.String {
+                               if err = checkListKeys(path+"."+k.String(), iter.Value().Interface()); err != nil {
+                                       return
+                               }
+                       }
+               }
+               return
+
+       case reflect.Struct:
+               for i := 0; i < v.NumField(); i++ {
+                       val := v.Field(i)
+                       structField := v.Type().Field(i)
+                       fieldname := structField.Name
+                       endsWithList := strings.HasSuffix(fieldname, "List")
+                       isAnArray := structField.Type.Kind() == reflect.Slice
+                       if endsWithList != isAnArray {
+                               if endsWithList {
+                                       err = fmt.Errorf("%s.%s ends with 'List' but field is not an array (type %v)", path, fieldname, val.Kind())
+                                       return
+                               }
+                               if isAnArray && structField.Type.Elem().Kind() != reflect.Uint8 {
+                                       err = fmt.Errorf("%s.%s is an array but field name does not end in 'List' (slice of %v)", path, fieldname, structField.Type.Elem().Kind())
+                                       return
+                               }
+                       }
+                       if val.CanInterface() {
+                               checkListKeys(path+"."+fieldname, val.Interface())
+                       }
+               }
+       }
+       return
+}
+
+func (s *LoadSuite) TestListKeys(c *check.C) {
+       v1 := struct {
+               EndInList []string
+       }{[]string{"a", "b"}}
+       var m1 = make(map[string]interface{})
+       m1["c"] = &v1
+       if err := checkListKeys("", m1); err != nil {
+               c.Error(err)
+       }
+
+       v2 := struct {
+               DoesNot []string
+       }{[]string{"a", "b"}}
+       var m2 = make(map[string]interface{})
+       m2["c"] = &v2
+       if err := checkListKeys("", m2); err == nil {
+               c.Errorf("Should have produced an error")
+       }
+
+       v3 := struct {
+               EndInList string
+       }{"a"}
+       var m3 = make(map[string]interface{})
+       m3["c"] = &v3
+       if err := checkListKeys("", m3); err == nil {
+               c.Errorf("Should have produced an error")
+       }
+
+       var logbuf bytes.Buffer
+       loader := testLoader(c, string(DefaultYAML), &logbuf)
+       cfg, err := loader.Load()
+       c.Assert(err, check.IsNil)
+       if err := checkListKeys("", cfg); err != nil {
+               c.Error(err)
        }
 }