lib/config/cmd_test.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         "io"
  10         "io/ioutil"
  11         "os"
  12
  13         "git.curoverse.com/arvados.git/lib/cmd"
  14         check "gopkg.in/check.v1"
  15 )
  16
  17 var _ = check.Suite(&CommandSuite{})
  18
  19 var (
  20         // Commands must satisfy cmd.Handler interface
  21         _ cmd.Handler = dumpCommand{}
  22         _ cmd.Handler = checkCommand{}
  23 )
  24
  25 type CommandSuite struct{}
  26
  27 func (s *CommandSuite) TestBadArg(c *check.C) {
  28         var stderr bytes.Buffer
  29         code := DumpCommand.RunCommand("arvados config-dump", []string{"-badarg"}, bytes.NewBuffer(nil), bytes.NewBuffer(nil), &stderr)
  30         c.Check(code, check.Equals, 2)
  31         c.Check(stderr.String(), check.Matches, `(?ms)flag provided but not defined: -badarg\nUsage:\n.*`)
  32 }
  33
  34 func (s *CommandSuite) TestEmptyInput(c *check.C) {
  35         var stdout, stderr bytes.Buffer
  36         code := DumpCommand.RunCommand("arvados config-dump", []string{"-config", "-"}, &bytes.Buffer{}, &stdout, &stderr)
  37         c.Check(code, check.Equals, 1)
  38         c.Check(stderr.String(), check.Matches, `config does not define any clusters\n`)
  39 }
  40
  41 func (s *CommandSuite) TestCheckNoDeprecatedKeys(c *check.C) {
  42         var stdout, stderr bytes.Buffer
  43         in := `
  44 Clusters:
  45  z1234:
  46   API:
  47     MaxItemsPerResponse: 1234
  48 `
  49         code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr)
  50         c.Check(code, check.Equals, 0)
  51         c.Check(stdout.String(), check.Equals, "")
  52         c.Check(stderr.String(), check.Equals, "")
  53 }
  54
  55 func (s *CommandSuite) TestCheckDeprecatedKeys(c *check.C) {
  56         var stdout, stderr bytes.Buffer
  57         in := `
  58 Clusters:
  59  z1234:
  60   RequestLimits:
  61     MaxItemsPerResponse: 1234
  62 `
  63         code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr)
  64         c.Check(code, check.Equals, 1)
  65         c.Check(stdout.String(), check.Matches, `(?ms).*\n\- +.*MaxItemsPerResponse: 1000\n\+ +MaxItemsPerResponse: 1234\n.*`)
  66 }
  67
  68 func (s *CommandSuite) TestCheckOldKeepstoreConfigFile(c *check.C) {
  69         f, err := ioutil.TempFile("", "")
  70         c.Assert(err, check.IsNil)
  71         defer os.Remove(f.Name())
  72
  73         io.WriteString(f, "Debug: true\n")
  74
  75         var stdout, stderr bytes.Buffer
  76         in := `
  77 Clusters:
  78  z1234:
  79   SystemLogs:
  80     LogLevel: info
  81 `
  82         code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-", "-legacy-keepstore-config", f.Name()}, bytes.NewBufferString(in), &stdout, &stderr)
  83         c.Check(code, check.Equals, 1)
  84         c.Check(stdout.String(), check.Matches, `(?ms).*\n\- +.*LogLevel: info\n\+ +LogLevel: debug\n.*`)
  85         c.Check(stderr.String(), check.Matches, `.*you should remove the legacy keepstore config file.*\n`)
  86 }
  87
  88 func (s *CommandSuite) TestCheckUnknownKey(c *check.C) {
  89         var stdout, stderr bytes.Buffer
  90         in := `
  91 Clusters:
  92  z1234:
  93   Bogus1: foo
  94   BogusSection:
  95     Bogus2: foo
  96   API:
  97     Bogus3:
  98      Bogus4: true
  99   PostgreSQL:
 100     ConnectionPool:
 101       {Bogus5: true}
 102 `
 103         code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr)
 104         c.Log(stderr.String())
 105         c.Check(code, check.Equals, 1)
 106         c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.Bogus1"\n.*`)
 107         c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.BogusSection"\n.*`)
 108         c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.API.Bogus3"\n.*`)
 109         c.Check(stderr.String(), check.Matches, `(?ms).*unexpected object in config entry: Clusters.z1234.PostgreSQL.ConnectionPool"\n.*`)
 110 }
 111
 112 func (s *CommandSuite) TestDumpFormatting(c *check.C) {
 113         var stdout, stderr bytes.Buffer
 114         in := `
 115 Clusters:
 116  z1234:
 117   Containers:
 118    CloudVMs:
 119     TimeoutBooting: 600s
 120   Services:
 121    Controller:
 122     InternalURLs:
 123      http://localhost:12345: {}
 124 `
 125         code := DumpCommand.RunCommand("arvados config-dump", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr)
 126         c.Check(code, check.Equals, 0)
 127         c.Check(stdout.String(), check.Matches, `(?ms).*TimeoutBooting: 10m\n.*`)
 128         c.Check(stdout.String(), check.Matches, `(?ms).*http://localhost:12345: {}\n.*`)
 129 }
 130
 131 func (s *CommandSuite) TestDumpUnknownKey(c *check.C) {
 132         var stdout, stderr bytes.Buffer
 133         in := `
 134 Clusters:
 135  z1234:
 136   UnknownKey: foobar
 137   ManagementToken: secret
 138 `
 139         code := DumpCommand.RunCommand("arvados config-dump", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr)
 140         c.Check(code, check.Equals, 0)
 141         c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.UnknownKey.*`)
 142         c.Check(stdout.String(), check.Matches, `(?ms)Clusters:\n  z1234:\n.*`)
 143         c.Check(stdout.String(), check.Matches, `(?ms).*\n *ManagementToken: secret\n.*`)
 144         c.Check(stdout.String(), check.Not(check.Matches), `(?ms).*UnknownKey.*`)
 145 }