# before trying "go test". Otherwise, coverage-reporting
# mode makes Go show the wrong line numbers when reporting
# compilation errors.
- go get -ldflags "-X main.version=${ARVADOS_VERSION:-$(git log -n1 --format=%H)-dev}" -t "git.curoverse.com/arvados.git/$1" && \
+ go get -ldflags "-X git.curoverse.com/arvados.git/lib/cmd.version=${ARVADOS_VERSION:-$(git log -n1 --format=%H)-dev}" -t "git.curoverse.com/arvados.git/$1" && \
cd "$GOPATH/src/git.curoverse.com/arvados.git/$1" && \
if [[ -n "${testargs[$1]}" ]]
then
result=1
elif [[ "$2" == "go" ]]
then
- go get -ldflags "-X main.version=${ARVADOS_VERSION:-$(git log -n1 --format=%H)-dev}" -t "git.curoverse.com/arvados.git/$1"
+ go get -ldflags "-X git.curoverse.com/arvados.git/lib/cmd.version=${ARVADOS_VERSION:-$(git log -n1 --format=%H)-dev}" -t "git.curoverse.com/arvados.git/$1"
elif [[ "$2" == "pip" ]]
then
# $3 can name a path directory for us to use, including trailing
)
var (
- version = "dev"
handler = cmd.Multi(map[string]cmd.Handler{
- "-e": cmd.Version(version),
- "version": cmd.Version(version),
- "-version": cmd.Version(version),
- "--version": cmd.Version(version),
+ "-e": cmd.Version,
+ "version": cmd.Version,
+ "-version": cmd.Version,
+ "--version": cmd.Version,
"copy": cli.Copy,
"create": cli.Create,
)
var (
- version = "dev"
handler = cmd.Multi(map[string]cmd.Handler{
- "version": cmd.Version(version),
- "-version": cmd.Version(version),
- "--version": cmd.Version(version),
+ "version": cmd.Version,
+ "-version": cmd.Version,
+ "--version": cmd.Version,
"cloudtest": cloudtest.Command,
"config-check": config.CheckCommand,
logger.Info("exiting")
}()
- cfg, err := config.LoadFile(*configFile, logger)
+ loader := config.NewLoader(stdin, logger)
+ loader.Path = *configFile
+ cfg, err := loader.Load()
if err != nil {
return 1
}
return f(prog, args, stdin, stdout, stderr)
}
-type Version string
+// Version is a Handler that prints the package version (set at build
+// time using -ldflags) and Go runtime version to stdout, and returns
+// 0.
+var Version versionCommand
-func (v Version) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
+var version = "dev"
+
+type versionCommand struct{}
+
+func (versionCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
prog = regexp.MustCompile(` -*version$`).ReplaceAllLiteralString(prog, "")
- fmt.Fprintf(stdout, "%s %s (%s)\n", prog, v, runtime.Version())
+ fmt.Fprintf(stdout, "%s %s (%s)\n", prog, version, runtime.Version())
return 0
}
"flag"
"fmt"
"io"
- "io/ioutil"
"os"
"os/exec"
- "git.curoverse.com/arvados.git/sdk/go/arvados"
"git.curoverse.com/arvados.git/sdk/go/ctxlog"
"github.com/ghodss/yaml"
+ "github.com/sirupsen/logrus"
)
var DumpCommand dumpCommand
}
}()
+ loader := &Loader{
+ Stdin: stdin,
+ Logger: ctxlog.New(stderr, "text", "info"),
+ }
+
flags := flag.NewFlagSet("", flag.ContinueOnError)
flags.SetOutput(stderr)
- configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`")
+ loader.SetupFlags(flags)
+
err = flags.Parse(args)
if err == flag.ErrHelp {
err = nil
flags.Usage()
return 2
}
- log := ctxlog.New(stderr, "text", "info")
- cfg, err := loadFileOrStdin(*configFile, stdin, log)
+
+ cfg, err := loader.Load()
if err != nil {
return 1
}
func (checkCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
var err error
+ var logbuf = &bytes.Buffer{}
defer func() {
+ io.Copy(stderr, logbuf)
if err != nil {
fmt.Fprintf(stderr, "%s\n", err)
}
}()
+ logger := logrus.New()
+ logger.Out = logbuf
+ loader := &Loader{
+ Stdin: stdin,
+ Logger: logger,
+ }
+
flags := flag.NewFlagSet("", flag.ContinueOnError)
flags.SetOutput(stderr)
- configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`")
+ loader.SetupFlags(flags)
+
err = flags.Parse(args)
if err == flag.ErrHelp {
err = nil
flags.Usage()
return 2
}
- log := &plainLogger{w: stderr}
- var buf []byte
- if *configFile == "-" {
- buf, err = ioutil.ReadAll(stdin)
- } else {
- buf, err = ioutil.ReadFile(*configFile)
- }
- if err != nil {
- return 1
- }
- withoutDepr, err := load(bytes.NewBuffer(buf), log, false)
+
+ loader.SkipDeprecated = true
+ withoutDepr, err := loader.Load()
if err != nil {
return 1
}
- withDepr, err := load(bytes.NewBuffer(buf), nil, true)
+ loader.SkipDeprecated = false
+ withDepr, err := loader.Load()
if err != nil {
return 1
}
} else if err != nil {
return 1
}
- if log.used {
+ if logbuf.Len() > 0 {
return 1
}
return 0
}
-type plainLogger struct {
- w io.Writer
- used bool
-}
-
-func (pl *plainLogger) Warnf(format string, args ...interface{}) {
- pl.used = true
- fmt.Fprintf(pl.w, format+"\n", args...)
-}
-
var DumpDefaultsCommand defaultsCommand
type defaultsCommand struct{}
func (defaultsCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
- var err error
- defer func() {
- if err != nil {
- fmt.Fprintf(stderr, "%s\n", err)
- }
- }()
-
- _, err = stdout.Write(DefaultYAML)
+ _, err := stdout.Write(DefaultYAML)
if err != nil {
+ fmt.Fprintln(stderr, err)
return 1
}
return 0
import (
"bytes"
+ "io"
+ "io/ioutil"
+ "os"
"git.curoverse.com/arvados.git/lib/cmd"
check "gopkg.in/check.v1"
c.Check(stdout.String(), check.Matches, `(?ms).*\n\- +.*MaxItemsPerResponse: 1000\n\+ +MaxItemsPerResponse: 1234\n.*`)
}
+func (s *CommandSuite) TestCheckOldKeepstoreConfigFile(c *check.C) {
+ f, err := ioutil.TempFile("", "")
+ c.Assert(err, check.IsNil)
+ defer os.Remove(f.Name())
+
+ io.WriteString(f, "Debug: 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, `.*you should remove the legacy keepstore config file.*\n`)
+}
+
func (s *CommandSuite) TestCheckUnknownKey(c *check.C) {
var stdout, stderr bytes.Buffer
in := `
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.*`)
+ 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) TestDumpFormatting(c *check.C) {
import (
"fmt"
+ "io/ioutil"
"os"
"strings"
Insecure bool
}
-func applyDeprecatedConfig(cfg *arvados.Config, configdata []byte, log logger) error {
+func (ldr *Loader) applyDeprecatedConfig(cfg *arvados.Config) error {
var dc deprecatedConfig
- err := yaml.Unmarshal(configdata, &dc)
+ err := yaml.Unmarshal(ldr.configdata, &dc)
if err != nil {
return err
}
for name, np := range dcluster.NodeProfiles {
if name == "*" || name == os.Getenv("ARVADOS_NODE_PROFILE") || name == hostname {
name = "localhost"
- } else if log != nil {
- log.Warnf("overriding Clusters.%s.Services using Clusters.%s.NodeProfiles.%s (guessing %q is a hostname)", id, id, name, name)
+ } else if ldr.Logger != nil {
+ ldr.Logger.Warnf("overriding Clusters.%s.Services using Clusters.%s.NodeProfiles.%s (guessing %q is a hostname)", id, id, name, name)
}
applyDeprecatedNodeProfile(name, np.RailsAPI, &cluster.Services.RailsAPI)
applyDeprecatedNodeProfile(name, np.Controller, &cluster.Services.Controller)
}
svc.InternalURLs[arvados.URL{Scheme: scheme, Host: host}] = arvados.ServiceInstance{}
}
+
+const defaultKeepstoreConfigPath = "/etc/arvados/keepstore/keepstore.yml"
+
+type oldKeepstoreConfig struct {
+ Debug *bool
+}
+
+// update config using values from an old-style keepstore config file.
+func (ldr *Loader) loadOldKeepstoreConfig(cfg *arvados.Config) error {
+ path := ldr.KeepstorePath
+ if path == "" {
+ return nil
+ }
+ buf, err := ioutil.ReadFile(path)
+ if os.IsNotExist(err) && path == defaultKeepstoreConfigPath {
+ return nil
+ } else if err != nil {
+ return err
+ } else {
+ ldr.Logger.Warnf("you should remove the legacy keepstore config file (%s) after migrating all config keys to the cluster configuration file (%s)", path, ldr.Path)
+ }
+ cluster, err := cfg.GetCluster("")
+ if err != nil {
+ return err
+ }
+
+ var oc oldKeepstoreConfig
+ err = yaml.Unmarshal(buf, &oc)
+ if err != nil {
+ return fmt.Errorf("%s: %s", path, err)
+ }
+
+ if v := oc.Debug; v == nil {
+ } else if *v && cluster.SystemLogs.LogLevel != "debug" {
+ cluster.SystemLogs.LogLevel = "debug"
+ } else if !*v && cluster.SystemLogs.LogLevel != "info" {
+ cluster.SystemLogs.LogLevel = "info"
+ }
+
+ cfg.Clusters[cluster.ClusterID] = *cluster
+ return nil
+}
func (s *ExportSuite) TestExport(c *check.C) {
confdata := bytes.Replace(DefaultYAML, []byte("SAMPLE"), []byte("testkey"), -1)
- cfg, err := Load(bytes.NewBuffer(confdata), ctxlog.TestLogger(c))
+ cfg, err := NewLoader(bytes.NewBuffer(confdata), ctxlog.TestLogger(c)).Load()
c.Assert(err, check.IsNil)
cluster := cfg.Clusters["xxxxx"]
cluster.ManagementToken = "abcdefg"
"bytes"
"encoding/json"
"errors"
+ "flag"
"fmt"
"io"
"io/ioutil"
"git.curoverse.com/arvados.git/sdk/go/arvados"
"github.com/ghodss/yaml"
"github.com/imdario/mergo"
+ "github.com/sirupsen/logrus"
)
-type logger interface {
- Warnf(string, ...interface{})
+type Loader struct {
+ Stdin io.Reader
+ Logger logrus.FieldLogger
+ SkipDeprecated bool
+
+ Path string
+ KeepstorePath string
+
+ configdata []byte
}
-func loadFileOrStdin(path string, stdin io.Reader, log logger) (*arvados.Config, error) {
- if path == "-" {
- return load(stdin, log, true)
- } else {
- return LoadFile(path, log)
- }
+func NewLoader(stdin io.Reader, logger logrus.FieldLogger) *Loader {
+ ldr := &Loader{Stdin: stdin, Logger: logger}
+ ldr.SetupFlags(flag.NewFlagSet("", flag.ContinueOnError))
+ ldr.Path = "-"
+ return ldr
}
-func LoadFile(path string, log logger) (*arvados.Config, error) {
+// SetupFlags configures a flagset so arguments like -config X can be
+// used to change the loader's Path fields.
+//
+// ldr := NewLoader(os.Stdin, logrus.New())
+// flagset := flag.NewFlagSet("", flag.ContinueOnError)
+// ldr.SetupFlags(flagset)
+// // ldr.Path == "/etc/arvados/config.yml"
+// flagset.Parse([]string{"-config", "/tmp/c.yaml"})
+// // ldr.Path == "/tmp/c.yaml"
+func (ldr *Loader) SetupFlags(flagset *flag.FlagSet) {
+ flagset.StringVar(&ldr.Path, "config", arvados.DefaultConfigFile, "Site configuration `file`")
+ flagset.StringVar(&ldr.KeepstorePath, "legacy-keepstore-config", defaultKeepstoreConfigPath, "Legacy keepstore configuration `file`")
+}
+
+func (ldr *Loader) loadBytes(path string) ([]byte, error) {
+ if path == "-" {
+ return ioutil.ReadAll(ldr.Stdin)
+ }
f, err := os.Open(path)
if err != nil {
return nil, err
}
defer f.Close()
- return Load(f, log)
+ return ioutil.ReadAll(f)
}
-func Load(rdr io.Reader, log logger) (*arvados.Config, error) {
- return load(rdr, log, true)
-}
-
-func load(rdr io.Reader, log logger, useDeprecated bool) (*arvados.Config, error) {
- buf, err := ioutil.ReadAll(rdr)
- if err != nil {
- return nil, err
+func (ldr *Loader) Load() (*arvados.Config, error) {
+ if ldr.configdata == nil {
+ buf, err := ldr.loadBytes(ldr.Path)
+ if err != nil {
+ return nil, err
+ }
+ ldr.configdata = buf
}
// Load the config into a dummy map to get the cluster ID
var dummy struct {
Clusters map[string]struct{}
}
- err = yaml.Unmarshal(buf, &dummy)
+ err := yaml.Unmarshal(ldr.configdata, &dummy)
if err != nil {
return nil, err
}
}
}
var src map[string]interface{}
- err = yaml.Unmarshal(buf, &src)
+ err = yaml.Unmarshal(ldr.configdata, &src)
if err != nil {
return nil, fmt.Errorf("loading config data: %s", err)
}
- logExtraKeys(log, merged, src, "")
+ ldr.logExtraKeys(merged, src, "")
removeSampleKeys(merged)
err = mergo.Merge(&merged, src, mergo.WithOverride)
if err != nil {
return nil, fmt.Errorf("transcoding config data: %s", err)
}
- if useDeprecated {
- err = applyDeprecatedConfig(&cfg, buf, log)
+ if !ldr.SkipDeprecated {
+ err = ldr.applyDeprecatedConfig(&cfg)
if err != nil {
return nil, err
}
+ for _, err := range []error{
+ ldr.loadOldKeepstoreConfig(&cfg),
+ } {
+ if err != nil {
+ return nil, err
+ }
+ }
}
// Check for known mistakes
}
}
-func logExtraKeys(log logger, expected, supplied map[string]interface{}, prefix string) {
- if log == nil {
+func (ldr *Loader) logExtraKeys(expected, supplied map[string]interface{}, prefix string) {
+ if ldr.Logger == nil {
return
}
allowed := map[string]interface{}{}
if !ok && expected["SAMPLE"] != nil {
vexp = expected["SAMPLE"]
} else if !ok {
- log.Warnf("deprecated or unknown config entry: %s%s", prefix, k)
+ ldr.Logger.Warnf("deprecated or unknown config entry: %s%s", prefix, k)
continue
}
if vsupp, ok := vsupp.(map[string]interface{}); !ok {
// will be caught elsewhere; see TestBadType.
continue
} else if vexp, ok := vexp.(map[string]interface{}); !ok {
- log.Warnf("unexpected object in config entry: %s%s", prefix, k)
+ ldr.Logger.Warnf("unexpected object in config entry: %s%s", prefix, k)
} else {
- logExtraKeys(log, vexp, vsupp, prefix+k+".")
+ ldr.logExtraKeys(vexp, vsupp, prefix+k+".")
}
}
}
type LoadSuite struct{}
func (s *LoadSuite) TestEmpty(c *check.C) {
- cfg, err := Load(&bytes.Buffer{}, ctxlog.TestLogger(c))
+ cfg, err := NewLoader(&bytes.Buffer{}, ctxlog.TestLogger(c)).Load()
c.Check(cfg, check.IsNil)
c.Assert(err, check.ErrorMatches, `config does not define any clusters`)
}
func (s *LoadSuite) TestNoConfigs(c *check.C) {
- cfg, err := Load(bytes.NewBufferString(`Clusters: {"z1111": {}}`), ctxlog.TestLogger(c))
+ cfg, err := NewLoader(bytes.NewBufferString(`Clusters: {"z1111": {}}`), ctxlog.TestLogger(c)).Load()
c.Assert(err, check.IsNil)
c.Assert(cfg.Clusters, check.HasLen, 1)
cc, err := cfg.GetCluster("z1111")
`{"Clusters":{"z1111":{}}}`,
`{"Clusters":{"z1111":{"InstanceTypes":{"Foo":{"RAM": "12345M"}}}}}`,
} {
- cfg, err := Load(bytes.NewBufferString(yaml), ctxlog.TestLogger(c))
+ cfg, err := NewLoader(bytes.NewBufferString(yaml), ctxlog.TestLogger(c)).Load()
c.Assert(err, check.IsNil)
cc, err := cfg.GetCluster("z1111")
_, hasSample := cc.InstanceTypes["SAMPLE"]
}
func (s *LoadSuite) TestMultipleClusters(c *check.C) {
- cfg, err := Load(bytes.NewBufferString(`{"Clusters":{"z1111":{},"z2222":{}}}`), ctxlog.TestLogger(c))
+ cfg, err := NewLoader(bytes.NewBufferString(`{"Clusters":{"z1111":{},"z2222":{}}}`), ctxlog.TestLogger(c)).Load()
c.Assert(err, check.IsNil)
c1, err := cfg.GetCluster("z1111")
c.Assert(err, check.IsNil)
var logbuf bytes.Buffer
logger := logrus.New()
logger.Out = &logbuf
- _, err := Load(bytes.NewBufferString(`
+ _, err := NewLoader(bytes.NewBufferString(`
Clusters:
zzzzz:
postgresql: {}
Host: z2222.arvadosapi.com
Proxy: true
BadKey: badValue
-`), logger)
+`), logger).Load()
c.Assert(err, check.IsNil)
logs := strings.Split(strings.TrimSuffix(logbuf.String(), "\n"), "\n")
for _, log := range logs {
logger.Out = &logbuf
var supplied map[string]interface{}
yaml.Unmarshal(DefaultYAML, &supplied)
- cfg, err := Load(bytes.NewBuffer(DefaultYAML), logger)
+
+ loader := NewLoader(bytes.NewBuffer(DefaultYAML), logger)
+ cfg, err := loader.Load()
c.Assert(err, check.IsNil)
var loaded map[string]interface{}
buf, err := yaml.Marshal(cfg)
err = yaml.Unmarshal(buf, &loaded)
c.Assert(err, check.IsNil)
- logExtraKeys(logger, loaded, supplied, "")
+ loader.logExtraKeys(loaded, supplied, "")
c.Check(logbuf.String(), check.Equals, "")
}
var logbuf bytes.Buffer
logger := logrus.New()
logger.Out = &logbuf
- cfg, err := Load(bytes.NewBufferString(`{"Clusters":{"zzzzz":{}}}`), logger)
+ cfg, err := NewLoader(bytes.NewBufferString(`{"Clusters":{"zzzzz":{}}}`), logger).Load()
c.Assert(err, check.IsNil)
yaml, err := yaml.Marshal(cfg)
c.Assert(err, check.IsNil)
- cfgDumped, err := Load(bytes.NewBuffer(yaml), logger)
+ cfgDumped, err := NewLoader(bytes.NewBuffer(yaml), logger).Load()
c.Assert(err, check.IsNil)
c.Check(cfg, check.DeepEquals, cfgDumped)
c.Check(logbuf.String(), check.Equals, "")
}
func (s *LoadSuite) TestPostgreSQLKeyConflict(c *check.C) {
- _, err := Load(bytes.NewBufferString(`
+ _, err := NewLoader(bytes.NewBufferString(`
Clusters:
zzzzz:
postgresql:
connection:
DBName: dbname
Host: host
-`), ctxlog.TestLogger(c))
+`), ctxlog.TestLogger(c)).Load()
c.Check(err, check.ErrorMatches, `Clusters.zzzzz.PostgreSQL.Connection: multiple entries for "(dbname|host)".*`)
}
`,
} {
c.Log(data)
- v, err := Load(bytes.NewBufferString(data), ctxlog.TestLogger(c))
+ v, err := NewLoader(bytes.NewBufferString(data), ctxlog.TestLogger(c)).Load()
if v != nil {
c.Logf("%#v", v.Clusters["zzzzz"].PostgreSQL.ConnectionPool)
}
}
func (s *LoadSuite) checkEquivalent(c *check.C, goty, expectedy string) {
- got, err := Load(bytes.NewBufferString(goty), ctxlog.TestLogger(c))
+ got, err := NewLoader(bytes.NewBufferString(goty), ctxlog.TestLogger(c)).Load()
c.Assert(err, check.IsNil)
- expected, err := Load(bytes.NewBufferString(expectedy), ctxlog.TestLogger(c))
+ expected, err := NewLoader(bytes.NewBufferString(expectedy), ctxlog.TestLogger(c)).Load()
c.Assert(err, check.IsNil)
if !c.Check(got, check.DeepEquals, expected) {
cmd := exec.Command("diff", "-u", "--label", "expected", "--label", "got", "/dev/fd/3", "/dev/fd/4")
"flag"
"fmt"
"io"
- "io/ioutil"
"net"
"net/http"
"net/url"
log.WithError(err).Info("exiting")
}
}()
+
flags := flag.NewFlagSet("", flag.ContinueOnError)
flags.SetOutput(stderr)
- configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`")
+
+ loader := config.NewLoader(stdin, log)
+ loader.SetupFlags(flags)
+ versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
+
err = flags.Parse(args)
if err == flag.ErrHelp {
err = nil
return 0
} else if err != nil {
return 2
+ } else if *versionFlag {
+ return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
}
- // Logged warnings are discarded for now: the config template
- // is incomplete, which causes extra warnings about keys that
- // are really OK.
- cfg, err := config.LoadFile(*configFile, ctxlog.New(ioutil.Discard, "json", "error"))
+
+ cfg, err := loader.Load()
if err != nil {
return 1
}
projects / arvados.git / commitdiff