// Copyright (C) The Arvados Authors. All rights reserved. // // SPDX-License-Identifier: AGPL-3.0 package config import ( "bytes" "io" "io/ioutil" "os" "git.arvados.org/arvados.git/lib/cmd" check "gopkg.in/check.v1" ) var _ = check.Suite(&CommandSuite{}) var ( // Commands must satisfy cmd.Handler interface _ cmd.Handler = dumpCommand{} _ cmd.Handler = checkCommand{} ) type CommandSuite struct{} func (s *CommandSuite) SetUpSuite(c *check.C) { os.Unsetenv("ARVADOS_API_HOST") os.Unsetenv("ARVADOS_API_HOST_INSECURE") os.Unsetenv("ARVADOS_API_TOKEN") } func (s *CommandSuite) TestDump_BadArg(c *check.C) { var stderr bytes.Buffer code := DumpCommand.RunCommand("arvados config-dump", []string{"-badarg"}, bytes.NewBuffer(nil), bytes.NewBuffer(nil), &stderr) c.Check(code, check.Equals, cmd.EXIT_INVALIDARGUMENT) c.Check(stderr.String(), check.Equals, "error parsing command line arguments: flag provided but not defined: -badarg (try -help)\n") } func (s *CommandSuite) TestDump_EmptyInput(c *check.C) { var stdout, stderr bytes.Buffer code := DumpCommand.RunCommand("arvados config-dump", []string{"-config", "-"}, &bytes.Buffer{}, &stdout, &stderr) c.Check(code, check.Equals, 1) c.Check(stderr.String(), check.Matches, `config does not define any clusters\n`) } func (s *CommandSuite) TestCheck_NoWarnings(c *check.C) { var stdout, stderr bytes.Buffer in := ` Clusters: z1234: ManagementToken: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa SystemRootToken: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa API: MaxItemsPerResponse: 1234 VocabularyPath: /this/path/does/not/exist Collections: BlobSigningKey: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa PostgreSQL: Connection: sslmode: require Services: RailsAPI: InternalURLs: "http://0.0.0.0:8000": {} Workbench: UserProfileFormFields: color: Type: select Options: fuchsia: {} ` code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Check(code, check.Equals, 0) c.Check(stdout.String(), check.Equals, "") c.Check(stderr.String(), check.Equals, "") } func (s *CommandSuite) TestCheck_VocabularyErrors(c *check.C) { tmpFile, err := ioutil.TempFile("", "") c.Assert(err, check.IsNil) defer os.Remove(tmpFile.Name()) _, err = tmpFile.WriteString(` { "tags": { "IDfoo": { "labels": [ {"label": "foo"} ] }, "IDfoo": { "labels": [ {"label": "baz"} ] } } }`) c.Assert(err, check.IsNil) tmpFile.Close() vocPath := tmpFile.Name() var stdout, stderr bytes.Buffer in := ` Clusters: z1234: ManagementToken: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa SystemRootToken: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa API: MaxItemsPerResponse: 1234 VocabularyPath: ` + vocPath + ` Collections: BlobSigningKey: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa PostgreSQL: Connection: sslmode: require Services: RailsAPI: InternalURLs: "http://0.0.0.0:8000": {} Workbench: UserProfileFormFields: color: Type: select Options: fuchsia: {} ` code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Check(code, check.Equals, 1) c.Check(stderr.String(), check.Matches, `(?ms).*Error loading vocabulary file.*for cluster.*duplicate JSON key.*tags.IDfoo.*`) } func (s *CommandSuite) TestCheck_DeprecatedKeys(c *check.C) { var stdout, stderr bytes.Buffer in := ` Clusters: z1234: RequestLimits: MaxItemsPerResponse: 1234 ` code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Check(code, check.Equals, 1) c.Check(stdout.String(), check.Matches, `(?ms).*\n\- +.*MaxItemsPerResponse: 1000\n\+ +MaxItemsPerResponse: 1234\n.*`) } func (s *CommandSuite) TestCheck_OldKeepstoreConfigFile(c *check.C) { f, err := ioutil.TempFile("", "") c.Assert(err, check.IsNil) defer os.Remove(f.Name()) io.WriteString(f, "Listen: :12345\nDebug: true\n") var stdout, stderr bytes.Buffer in := ` Clusters: z1234: SystemLogs: LogLevel: info ` code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-", "-legacy-keepstore-config", f.Name()}, bytes.NewBufferString(in), &stdout, &stderr) c.Check(code, check.Equals, 1) c.Check(stdout.String(), check.Matches, `(?ms).*\n\- +.*LogLevel: info\n\+ +LogLevel: debug\n.*`) c.Check(stderr.String(), check.Matches, `(?ms).*you should remove the legacy keepstore config file.*\n`) } func (s *CommandSuite) TestCheck_UnknownKey(c *check.C) { var stdout, stderr bytes.Buffer in := ` Clusters: z1234: Bogus1: foo BogusSection: Bogus2: foo API: Bogus3: Bogus4: true PostgreSQL: ConnectionPool: {Bogus5: true} ` code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Log(stderr.String()) c.Check(code, check.Equals, 1) c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.Bogus1"\n.*`) c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.BogusSection"\n.*`) c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.API.Bogus3"\n.*`) c.Check(stderr.String(), check.Matches, `(?ms).*unexpected object in config entry: Clusters.z1234.PostgreSQL.ConnectionPool"\n.*`) } func (s *CommandSuite) TestCheck_DuplicateWarnings(c *check.C) { var stdout, stderr bytes.Buffer in := ` Clusters: z1234: {} ` code := CheckCommand.RunCommand("arvados config-check", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Check(code, check.Equals, 1) c.Check(stderr.String(), check.Matches, `(?ms).*SystemRootToken.*`) c.Check(stderr.String(), check.Not(check.Matches), `(?ms).*SystemRootToken.*SystemRootToken.*`) } func (s *CommandSuite) TestDump_Formatting(c *check.C) { var stdout, stderr bytes.Buffer in := ` Clusters: z1234: Containers: CloudVMs: TimeoutBooting: 600s Services: Controller: InternalURLs: http://localhost:12345: {} ` code := DumpCommand.RunCommand("arvados config-dump", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Check(code, check.Equals, 0) c.Check(stdout.String(), check.Matches, `(?ms).*TimeoutBooting: 10m\n.*`) c.Check(stdout.String(), check.Matches, `(?ms).*http://localhost:12345/:\n +ListenURL: ""\n.*`) } func (s *CommandSuite) TestDump_UnknownKey(c *check.C) { var stdout, stderr bytes.Buffer in := ` Clusters: z1234: UnknownKey: foobar ManagementToken: secret ` code := DumpCommand.RunCommand("arvados config-dump", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Check(code, check.Equals, 0) c.Check(stderr.String(), check.Matches, `(?ms).*deprecated or unknown config entry: Clusters.z1234.UnknownKey.*`) c.Check(stdout.String(), check.Matches, `(?ms)(.*\n)?Clusters:\n z1234:\n.*`) c.Check(stdout.String(), check.Matches, `(?ms).*\n *ManagementToken: secret\n.*`) c.Check(stdout.String(), check.Not(check.Matches), `(?ms).*UnknownKey.*`) } func (s *CommandSuite) TestDump_KeyOrder(c *check.C) { in := ` Clusters: z1234: Login: Test: Users: a: {} d: {} c: {} b: {} e: {} ` for trial := 0; trial < 20; trial++ { var stdout, stderr bytes.Buffer code := DumpCommand.RunCommand("arvados config-dump", []string{"-config", "-"}, bytes.NewBufferString(in), &stdout, &stderr) c.Assert(code, check.Equals, 0) if !c.Check(stdout.String(), check.Matches, `(?ms).*a:.*b:.*c:.*d:.*e:.*`) { c.Logf("config-dump did not use lexical key order on trial %d", trial) c.Log("stdout:\n", stdout.String()) c.Log("stderr:\n", stderr.String()) c.FailNow() } } } func (s *CommandSuite) TestCheck_KeyOrder(c *check.C) { in := ` Clusters: z1234: ManagementToken: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa SystemRootToken: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Collections: BlobSigningKey: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa InstanceTypes: a32a: {} a48a: {} a4a: {} ` for trial := 0; trial < 20; trial++ { var stdout, stderr bytes.Buffer code := CheckCommand.RunCommand("arvados config-check", []string{"-config=-", "-strict=true"}, bytes.NewBufferString(in), &stdout, &stderr) if !c.Check(code, check.Equals, 0) || stdout.String() != "" || stderr.String() != "" { c.Logf("config-check returned error or non-empty output on trial %d", trial) c.Log("stdout:\n", stdout.String()) c.Log("stderr:\n", stderr.String()) c.FailNow() } } }