Merge lp:~pedronis/ubuntu-push/empty into lp:ubuntu-push

[Samuele Pedroni]

empty merge for testing

Unmerged revisions

=== modified file 'client/client.go'
--- client/client.go	2014-04-11 16:37:48 +0000
+++ client/client.go	2014-04-15 15:10:41 +0000
@@ -57,7 +57,7 @@
 	// The PEM-encoded server certificate
 	CertPEMFile string `json:"cert_pem_file"`
 	// The logging level (one of "debug", "info", "error")
-	LogLevel string `json:"log_level"`
+	LogLevel logger.ConfigLogLevel `json:"log_level"`
 }
 
 // PushClient is the Ubuntu Push Notifications client-side daemon.
@@ -95,13 +95,13 @@
 
 // configure loads its configuration, and sets it up.
 func (client *PushClient) configure() error {
-	f, err := os.Open(client.configPath)
+	_, err := os.Stat(client.configPath)
 	if err != nil {
-		return fmt.Errorf("opening config: %v", err)
+		return fmt.Errorf("config: %v", err)
 	}
-	err = config.ReadConfig(f, &client.config)
+	err = config.ReadFiles(&client.config, client.configPath, "<flags>")
 	if err != nil {
-		return fmt.Errorf("reading config: %v", err)
+		return fmt.Errorf("config: %v", err)
 	}
 	// ignore spaces
 	client.config.Addr = strings.Replace(client.config.Addr, " ", "", -1)
@@ -110,7 +110,7 @@
 	}
 
 	// later, we'll be specifying more logging options in the config file
-	client.log = logger.NewSimpleLogger(os.Stderr, client.config.LogLevel)
+	client.log = logger.NewSimpleLogger(os.Stderr, client.config.LogLevel.Level())
 
 	// overridden for testing
 	client.idder = identifier.New()

=== modified file 'client/client_test.go'
--- client/client_test.go	2014-04-11 16:21:45 +0000
+++ client/client_test.go	2014-04-15 15:10:41 +0000
@@ -19,10 +19,12 @@
 import (
 	"encoding/json"
 	"errors"
+	"flag"
 	"fmt"
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
+	"os"
 	"path/filepath"
 	"reflect"
 	"testing"
@@ -37,6 +39,7 @@
 	testibus "launchpad.net/ubuntu-push/bus/testing"
 	"launchpad.net/ubuntu-push/client/session"
 	"launchpad.net/ubuntu-push/client/session/levelmap"
+	"launchpad.net/ubuntu-push/config"
 	helpers "launchpad.net/ubuntu-push/testing"
 	"launchpad.net/ubuntu-push/testing/condition"
 	"launchpad.net/ubuntu-push/util"
@@ -79,6 +82,7 @@
 }
 
 func (cs *clientSuite) SetUpSuite(c *C) {
+	config.IgnoreParsedFlags = true // because configure() uses <flags>
 	cs.timeouts = util.SwapTimeouts([]time.Duration{0})
 	cs.leveldbPath = ""
 }
@@ -142,6 +146,16 @@
 	c.Check(cli.config.ExchangeTimeout.TimeDuration(), Equals, time.Duration(10*time.Millisecond))
 }
 
+func (cs *clientSuite) TestConfigureWorksWithFlags(c *C) {
+	flag.CommandLine = flag.NewFlagSet("client", flag.ContinueOnError)
+	os.Args = []string{"client", "-addr", "foo:7777"}
+	cli := NewPushClient(cs.configPath, cs.leveldbPath)
+	err := cli.configure()
+	c.Assert(err, IsNil)
+	c.Assert(cli.config, NotNil)
+	c.Check(cli.config.Addr, Equals, "foo:7777")
+}
+
 func (cs *clientSuite) TestConfigureSetsUpLog(c *C) {
 	cli := NewPushClient(cs.configPath, cs.leveldbPath)
 	c.Check(cli.log, IsNil)

=== modified file 'config/config.go'
--- config/config.go	2014-03-25 18:49:18 +0000
+++ config/config.go	2014-04-15 15:10:41 +0000
@@ -20,6 +20,7 @@
 import (
 	"encoding/json"
 	"errors"
+	"flag"
 	"fmt"
 	"io"
 	"io/ioutil"
@@ -27,6 +28,7 @@
 	"os"
 	"path/filepath"
 	"reflect"
+	"strconv"
 	"strings"
 	"time"
 )
@@ -118,6 +120,22 @@
 	return fillDestConfig(destValue, p1)
 }
 
+// FromString are config holders that can be set by parsing a string.
+type FromString interface {
+	SetFromString(enc string) error
+}
+
+// UnmarshalJSONViaString helps unmarshalling from JSON for FromString
+// supporting config holders.
+func UnmarshalJSONViaString(dest FromString, b []byte) error {
+	var enc string
+	err := json.Unmarshal(b, &enc)
+	if err != nil {
+		return err
+	}
+	return dest.SetFromString(enc)
+}
+
 // ConfigTimeDuration can hold a time.Duration in a configuration struct,
 // that is parsed from a string as supported by time.ParseDuration.
 type ConfigTimeDuration struct {
@@ -125,13 +143,11 @@
 }
 
 func (ctd *ConfigTimeDuration) UnmarshalJSON(b []byte) error {
-	var enc string
-	var v time.Duration
-	err := json.Unmarshal(b, &enc)
-	if err != nil {
-		return err
-	}
-	v, err = time.ParseDuration(enc)
+	return UnmarshalJSONViaString(ctd, b)
+}
+
+func (ctd *ConfigTimeDuration) SetFromString(enc string) error {
+	v, err := time.ParseDuration(enc)
 	if err != nil {
 		return err
 	}
@@ -148,12 +164,11 @@
 type ConfigHostPort string
 
 func (chp *ConfigHostPort) UnmarshalJSON(b []byte) error {
-	var enc string
-	err := json.Unmarshal(b, &enc)
-	if err != nil {
-		return err
-	}
-	_, _, err = net.SplitHostPort(enc)
+	return UnmarshalJSONViaString(chp, b)
+}
+
+func (chp *ConfigHostPort) SetFromString(enc string) error {
+	_, _, err := net.SplitHostPort(enc)
 	if err != nil {
 		return err
 	}
@@ -198,23 +213,117 @@
 	return ioutil.ReadFile(p)
 }
 
-// ReadFiles reads configuration from a set of files. Uses ReadConfig internally.
+// used to implement getting config values with flag.Parse()
+type val struct {
+	destField destField
+	accu      map[string]json.RawMessage
+}
+
+func (v *val) String() string { // used to show default
+	return string(v.accu[v.destField.configName()])
+}
+
+func (v *val) IsBoolFlag() bool {
+	return v.destField.fld.Type.Kind() == reflect.Bool
+}
+
+func (v *val) marshalAsNeeded(s string) (json.RawMessage, error) {
+	var toMarshal interface{}
+	switch v.destField.dest.(type) {
+	case *string, FromString:
+		toMarshal = s
+	case *bool:
+		bit, err := strconv.ParseBool(s)
+		if err != nil {
+			return nil, err
+		}
+		toMarshal = bit
+	default:
+		return json.RawMessage(s), nil
+	}
+	return json.Marshal(toMarshal)
+}
+
+func (v *val) Set(s string) error {
+	marshalled, err := v.marshalAsNeeded(s)
+	if err != nil {
+		return err
+	}
+	v.accu[v.destField.configName()] = marshalled
+	return nil
+}
+
+func readOneConfig(accu map[string]json.RawMessage, cfgPath string) error {
+	r, err := os.Open(cfgPath)
+	if err != nil {
+		return err
+	}
+	defer r.Close()
+	err = json.NewDecoder(r).Decode(&accu)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// used to implement -cfg@=
+type readConfigAtVal struct {
+	accu map[string]json.RawMessage
+}
+
+func (v *readConfigAtVal) String() string {
+	return "<config.json>"
+}
+
+func (v *readConfigAtVal) Set(path string) error {
+	return readOneConfig(v.accu, path)
+}
+
+// readUsingFlags gets config values from command line flags.
+func readUsingFlags(accu map[string]json.RawMessage, destValue reflect.Value) error {
+	if flag.Parsed() {
+		if IgnoreParsedFlags {
+			return nil
+		}
+		return fmt.Errorf("too late, flags already parsed")
+	}
+	destStruct := destValue.Elem()
+	for destField := range traverseStruct(destStruct) {
+		help := destField.fld.Tag.Get("help")
+		flag.Var(&val{destField, accu}, destField.configName(), help)
+	}
+	flag.Var(&readConfigAtVal{accu}, "cfg@", "get config values from file")
+	flag.Parse()
+	return nil
+}
+
+// IgnoreParsedFlags will just have ReadFiles ignore <flags> if the
+// command line was already parsed.
+var IgnoreParsedFlags = false
+
+// ReadFiles reads configuration from a set of files. The string
+// "<flags>" can be used as a pseudo file-path, it will consider
+// command line flags, invoking flag.Parse(). Among those the flag
+// -cfg@=FILE can be used to get further config values from FILE.
 func ReadFiles(destConfig interface{}, cfgFpaths ...string) error {
 	destValue, err := checkDestConfig("destConfig", destConfig)
 	if err != nil {
 		return err
 	}
 	// do the parsing in two phases for better error handling
-	var p1 map[string]json.RawMessage
+	p1 := make(map[string]json.RawMessage)
 	readOne := false
 	for _, cfgPath := range cfgFpaths {
+		if cfgPath == "<flags>" {
+			err := readUsingFlags(p1, destValue)
+			if err != nil {
+				return err
+			}
+			readOne = true
+			continue
+		}
 		if _, err := os.Stat(cfgPath); err == nil {
-			r, err := os.Open(cfgPath)
-			if err != nil {
-				return err
-			}
-			defer r.Close()
-			err = json.NewDecoder(r).Decode(&p1)
+			err := readOneConfig(p1, cfgPath)
 			if err != nil {
 				return err
 			}

=== modified file 'config/config_test.go'
--- config/config_test.go	2014-03-25 18:49:18 +0000
+++ config/config_test.go	2014-04-15 15:10:41 +0000
@@ -18,6 +18,9 @@
 
 import (
 	"bytes"
+	"encoding/json"
+	"flag"
+	"fmt"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -230,3 +233,105 @@
 	c.Check(res, DeepEquals, []string{"b", "c_list", "d"})
 
 }
+
+type testConfig3 struct {
+	A bool
+	B string
+	C []string           `json:"c_list"`
+	D ConfigTimeDuration `help:"duration"`
+	E ConfigHostPort
+	F string
+}
+
+type configFlagsSuite struct{}
+
+var _ = Suite(&configFlagsSuite{})
+
+func (s *configFlagsSuite) SetUpTest(c *C) {
+	flag.CommandLine = flag.NewFlagSet("cmd", flag.PanicOnError)
+	// supress outputs
+	flag.Usage = func() { flag.PrintDefaults() }
+	flag.CommandLine.SetOutput(ioutil.Discard)
+}
+
+func (s *configFlagsSuite) TestReadUsingFlags(c *C) {
+	os.Args = []string{"cmd", "-a=1", "-b=foo", "-c_list", `["x","y"]`, "-d", "10s", "-e=localhost:80"}
+	var cfg testConfig3
+	p := make(map[string]json.RawMessage)
+	err := readUsingFlags(p, reflect.ValueOf(&cfg))
+	c.Assert(err, IsNil)
+	c.Check(p, DeepEquals, map[string]json.RawMessage{
+		"a":      json.RawMessage("true"),
+		"b":      json.RawMessage(`"foo"`),
+		"c_list": json.RawMessage(`["x","y"]`),
+		"d":      json.RawMessage(`"10s"`),
+		"e":      json.RawMessage(`"localhost:80"`),
+	})
+}
+
+func (s *configFlagsSuite) TestReadUsingFlagsBoolError(c *C) {
+	os.Args = []string{"cmd", "-a=zoo"}
+	var cfg testConfig3
+	p := make(map[string]json.RawMessage)
+	c.Check(func() { readUsingFlags(p, reflect.ValueOf(&cfg)) }, PanicMatches, ".*invalid boolean.*-a.*")
+}
+
+func (s *configFlagsSuite) TestReadFilesAndFlags(c *C) {
+	// test <flags> pseudo file
+	os.Args = []string{"cmd", "-b=x"}
+	tmpDir := c.MkDir()
+	cfgPath := filepath.Join(tmpDir, "cfg.json")
+	err := ioutil.WriteFile(cfgPath, []byte(`{"a": 42, "c_list": ["y", "z"]}`), os.ModePerm)
+	c.Assert(err, IsNil)
+	var cfg testConfig1
+	err = ReadFiles(&cfg, cfgPath, "<flags>")
+	c.Assert(err, IsNil)
+	c.Check(cfg.A, Equals, 42)
+	c.Check(cfg.B, Equals, "x")
+	c.Check(cfg.C, DeepEquals, []string{"y", "z"})
+}
+
+func (s *configFlagsSuite) TestReadFilesAndFlagsConfigAtSupport(c *C) {
+	// test <flags> pseudo file
+	tmpDir := c.MkDir()
+	cfgPath := filepath.Join(tmpDir, "cfg.json")
+	os.Args = []string{"cmd", "-a=42", fmt.Sprintf("-cfg@=%s", cfgPath)}
+	err := ioutil.WriteFile(cfgPath, []byte(`{"b": "x", "c_list": ["y", "z"]}`), os.ModePerm)
+	c.Assert(err, IsNil)
+	var cfg testConfig1
+	err = ReadFiles(&cfg, "<flags>")
+	c.Assert(err, IsNil)
+	c.Check(cfg.A, Equals, 42)
+	c.Check(cfg.B, Equals, "x")
+	c.Check(cfg.C, DeepEquals, []string{"y", "z"})
+}
+
+func (s *configFlagsSuite) TestReadUsingFlagsHelp(c *C) {
+	os.Args = []string{"cmd", "-h"}
+	buf := bytes.NewBufferString("")
+	flag.CommandLine.Init("cmd", flag.ContinueOnError)
+	flag.CommandLine.SetOutput(buf)
+	var cfg testConfig3
+	p := map[string]json.RawMessage{
+		"d": json.RawMessage(`"2s"`),
+	}
+	readUsingFlags(p, reflect.ValueOf(&cfg))
+	c.Check(buf.String(), Matches, `(?s).*-cfg@=<config.json>: get config values from file\n.*-d="2s": duration.*`)
+}
+
+func (s *configFlagsSuite) TestReadUsingFlagsAlreadyParsed(c *C) {
+	os.Args = []string{"cmd"}
+	flag.Parse()
+	var cfg struct{}
+	p := make(map[string]json.RawMessage)
+	err := readUsingFlags(p, reflect.ValueOf(&cfg))
+	c.Assert(err, ErrorMatches, "too late, flags already parsed")
+	err = ReadFiles(&cfg, "<flags>")
+	c.Assert(err, ErrorMatches, "too late, flags already parsed")
+	IgnoreParsedFlags = true
+	defer func() {
+		IgnoreParsedFlags = false
+	}()
+	err = ReadFiles(&cfg, "<flags>")
+	c.Assert(err, IsNil)
+}

=== modified file 'logger/logger.go'
--- logger/logger.go	2014-02-24 10:27:38 +0000
+++ logger/logger.go	2014-04-15 15:10:41 +0000
@@ -23,6 +23,8 @@
 	"log"
 	"os"
 	"runtime"
+
+	"launchpad.net/ubuntu-push/config"
 )
 
 // Logger is a simple logger interface with logging at levels.
@@ -119,3 +121,28 @@
 		lg.outputFunc(2, fmt.Sprintf("DEBUG "+format, v...))
 	}
 }
+
+// config bits
+
+// ConfigLogLevel can hold a log level in a configuration struct.
+type ConfigLogLevel string
+
+func (cll *ConfigLogLevel) ConfigFromJSONString() {}
+
+func (cll *ConfigLogLevel) UnmarshalJSON(b []byte) error {
+	return config.UnmarshalJSONViaString(cll, b)
+}
+
+func (cll *ConfigLogLevel) SetFromString(enc string) error {
+	_, ok := levelToNLevel[enc]
+	if !ok {
+		return fmt.Errorf("not a log level: %s", enc)
+	}
+	*cll = ConfigLogLevel(enc)
+	return nil
+}
+
+// Level returns the log level string held in cll.
+func (cll ConfigLogLevel) Level() string {
+	return string(cll)
+}

=== modified file 'logger/logger_test.go'
--- logger/logger_test.go	2014-02-10 22:51:43 +0000
+++ logger/logger_test.go	2014-04-15 15:10:41 +0000
@@ -25,6 +25,8 @@
 	"testing"
 
 	. "launchpad.net/gocheck"
+
+	"launchpad.net/ubuntu-push/config"
 )
 
 func TestLogger(t *testing.T) { TestingT(t) }
@@ -138,3 +140,26 @@
 	logger.Output(1, "foobaz")
 	c.Check(buf.String(), Matches, "logger_test.go:[0-9]+: foobar\nlogger_test.go:[0-9]+: foobaz\n")
 }
+
+type testLogLevelConfig struct {
+	Lvl ConfigLogLevel
+}
+
+func (s *loggerSuite) TestReadConfigLogLevel(c *C) {
+	buf := bytes.NewBufferString(`{"lvl": "debug"}`)
+	var cfg testLogLevelConfig
+	err := config.ReadConfig(buf, &cfg)
+	c.Assert(err, IsNil)
+	c.Check(cfg.Lvl.Level(), Equals, "debug")
+}
+
+func (s *loggerSuite) TestReadConfigLogLevelErrors(c *C) {
+	var cfg testLogLevelConfig
+	checkError := func(jsonCfg string, expectedError string) {
+		buf := bytes.NewBufferString(jsonCfg)
+		err := config.ReadConfig(buf, &cfg)
+		c.Check(err, ErrorMatches, expectedError)
+	}
+	checkError(`{"lvl": 1}`, "lvl:.*type string")
+	checkError(`{"lvl": "foo"}`, "lvl: not a log level: foo")
+}

=== modified file 'server/acceptance/cmd/acceptanceclient.go'
--- server/acceptance/cmd/acceptanceclient.go	2014-04-10 13:52:31 +0000
+++ server/acceptance/cmd/acceptanceclient.go	2014-04-15 15:10:41 +0000
@@ -48,13 +48,18 @@
 		fmt.Fprintf(os.Stderr, "Usage: acceptancclient [options] <config.json> <device id>\n")
 		flag.PrintDefaults()
 	}
+	missingArg := func(what string) {
+		fmt.Fprintf(os.Stderr, "missing %s\n", what)
+		flag.Usage()
+		os.Exit(2)
+	}
 	flag.Parse()
 	narg := flag.NArg()
 	switch {
 	case narg < 1:
-		log.Fatal("missing config file")
+		missingArg("config file")
 	case narg < 2:
-		log.Fatal("missing device-id")
+		missingArg("device-id")
 	}
 	configFName := flag.Arg(0)
 	f, err := os.Open(configFName)

=== modified file 'ubuntu-push-client.go'
--- ubuntu-push-client.go	2014-03-12 13:25:20 +0000
+++ ubuntu-push-client.go	2014-04-15 15:10:41 +0000
@@ -19,12 +19,37 @@
 import (
 	"log"
 
+	"launchpad.net/go-dbus/v1"
 	"launchpad.net/go-xdg/v0"
 
 	"launchpad.net/ubuntu-push/client"
 )
 
+const NAME = "com.ubuntu.PushNotifications"
+
+// grabName grabs ownership of the dbus name, and bails the client as
+// soon as somebody else grabs it.
+func grabName() {
+	conn, err := dbus.Connect(dbus.SessionBus)
+	if err != nil {
+		log.Fatalf("bus: %v", err)
+	}
+
+	flags := dbus.NameFlagAllowReplacement | dbus.NameFlagReplaceExisting
+	n := conn.RequestName(NAME, flags)
+	go func() {
+		for err := range n.C {
+			if err != nil {
+				log.Fatalf("FATAL: name channel got: %v", err)
+			}
+		}
+	}()
+}
+
 func main() {
+	// XXX: this is a quick hack to ensure unicity
+	grabName()
+
 	cfgFname, err := xdg.Config.Find("ubuntu-push-client/config.json")
 	if err != nil {
 		log.Fatalf("unable to find a configuration file: %v", err)