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