Merge lp:~chipaca/ubuntu-push/notifications into lp:ubuntu-push

[John Lenton]

notifications! first, a low-level api.

Implemented a low-level notifications API.

[Samuele Pedroni (pedronis)]

we have a lot of things that are notifications, wondering if we need a more precise package name

// New returns a new Notifications that'll use the provided bus.Endpoint

it's called Raw and takes a bus.Bus

maybe the Raw* types need a short descr as well

of course this will need some integration testing involving qa

review: Approve

[John Lenton (chipaca)]

Fixed the comment, added a short desc to the Raw* types.
I'm all ears for suggestions for names...

[Samuele Pedroni (pedronis)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~chipaca/ubuntu-push/notifications into lp:ubuntu-push failed. Below is the output from the failed tests.

mkdir -p /mnt/tarmac/cache/ubuntu-push/go-ws/bin
mkdir -p /mnt/tarmac/cache/ubuntu-push/go-ws/pkg
go get -u launchpad.net/godeps
go get -d -u launchpad.net/gocheck launchpad.net/go-dbus/v1
/mnt/tarmac/cache/ubuntu-push/go-ws/bin/godeps -u dependencies.tsv
go install launchpad.net/gocheck launchpad.net/go-dbus/v1
go test launchpad.net/ubuntu-push/...
ok launchpad.net/ubuntu-push/bus 0.009s
ok launchpad.net/ubuntu-push/bus/testing 0.024s
ok launchpad.net/ubuntu-push/config 0.009s
ok launchpad.net/ubuntu-push/connectivity 0.102s
? launchpad.net/ubuntu-push/connectivity/example [no test files]
ok launchpad.net/ubuntu-push/connectivity/webchecker 0.018s
ok launchpad.net/ubuntu-push/logger 0.006s
ok launchpad.net/ubuntu-push/networkmanager 0.036s
ok launchpad.net/ubuntu-push/notifications 0.016s
ok launchpad.net/ubuntu-push/protocol 0.012s
ok launchpad.net/ubuntu-push/server/acceptance 0.006s
? launchpad.net/ubuntu-push/server/acceptance/cmd [no test files]
ok launchpad.net/ubuntu-push/server/api 0.015s
ok launchpad.net/ubuntu-push/server/broker 0.007s
ok launchpad.net/ubuntu-push/server/dev 0.027s
ok launchpad.net/ubuntu-push/server/listener 0.358s
ok launchpad.net/ubuntu-push/server/session 0.074s
ok launchpad.net/ubuntu-push/server/store 0.006s
? launchpad.net/ubuntu-push/testing [no test files]
ok launchpad.net/ubuntu-push/testing/condition 0.004s
ok launchpad.net/ubuntu-push/whoopsie/identifier 0.018s
ok launchpad.net/ubuntu-push/whoopsie/identifier/testing 0.018s
scripts/check_fmt launchpad.net/ubuntu-push
pkg launchpad.net/ubuntu-push/connectivity has some gofmt non-compliant files:
connectivity_test.go

make: *** [check-format] Error 1

[lp:~chipaca/ubuntu-push/notifications]

18. By John Lenton on 2014-01-22

[r=pedronis] notifications! first, a low-level api.

=== modified file 'connectivity/connectivity_test.go'
--- connectivity/connectivity_test.go	2014-01-20 17:37:55 +0000
+++ connectivity/connectivity_test.go	2014-01-22 12:27:44 +0000
@@ -128,11 +128,11 @@
 */
 
 func (s *ConnSuite) TestSteps(c *C) {
-	webget_works := func(ch chan<- bool) { ch <- true }
-	webget_fails := func(ch chan<- bool) { ch <- false }
+	var webget_p condition.Interface = condition.Work(true)
+	recheck_timeout := 50 * time.Millisecond
 
 	cfg := Config{
-		RecheckTimeout: config.ConfigTimeDuration{10 * time.Millisecond},
+		RecheckTimeout: config.ConfigTimeDuration{recheck_timeout},
 	}
 	ch := make(chan networkmanager.State, 10)
 	cs := &connectedState{
@@ -140,7 +140,7 @@
 		networkStateCh: ch,
 		timer:          time.NewTimer(time.Second),
 		log:            nullog,
-		webget:         webget_works,
+		webget:         func(ch chan<- bool) { ch <- webget_p.OK() },
 		lastSent:       false,
 	}
 	ch <- networkmanager.ConnectedGlobal
@@ -156,7 +156,7 @@
 	c.Check(f, Equals, true) // and if the web check works, go back to connected
 
 	// same scenario, but with failing web check
-	cs.webget = webget_fails
+	webget_p = condition.Fail2Work(1)
 	ch <- networkmanager.ConnectedGlobal
 	f, e = cs.connectedStateStep()
 	c.Check(e, IsNil)
@@ -164,7 +164,7 @@
 
 	// the next call to Step will time out
 	_ch := make(chan bool, 1)
-	_t := time.NewTimer(10 * time.Millisecond)
+	_t := time.NewTimer(recheck_timeout / 2)
 
 	go func() {
 		f, e := cs.connectedStateStep()
@@ -178,8 +178,6 @@
 	case <-_t.C:
 	}
 
-	// put it back together again
-	cs.webget = webget_works
 	// now an recheckTimeout later, we'll get true
 	c.Check(<-_ch, Equals, true)
 

=== added directory 'notifications'
=== added file 'notifications/raw.go'
--- notifications/raw.go	1970-01-01 00:00:00 +0000
+++ notifications/raw.go	2014-01-22 12:27:44 +0000
@@ -0,0 +1,97 @@
+/*
+ Copyright 2013-2014 Canonical Ltd.
+
+ This program is free software: you can redistribute it and/or modify it
+ under the terms of the GNU General Public License version 3, as published
+ by the Free Software Foundation.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranties of
+ MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ PURPOSE.  See the GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+// Package notifications wraps a couple of Notifications's DBus API points:
+// the org.freedesktop.Notifications.Notify call, and listening for the
+// ActionInvoked signal.
+package notifications
+
+// this is the lower-level api
+
+import (
+	"launchpad.net/go-dbus/v1"
+	"launchpad.net/ubuntu-push/bus"
+	"launchpad.net/ubuntu-push/logger"
+)
+
+// Notifications lives on a well-knwon bus.Address
+var BusAddress bus.Address = bus.Address{
+	Interface: "org.freedesktop.Notifications",
+	Path:      "/org/freedesktop/Notifications",
+	Name:      "org.freedesktop.Notifications",
+}
+
+/*****************************************************************
+ *    RawNotifications
+ */
+
+// convenience type for the (uint32, string) ActionInvoked signal data
+type RawActionReply struct {
+	NotificationId uint32
+	ActionId       string
+}
+
+// a raw notification provides a low-level interface to the f.d.o. dbus
+// notifications api
+type RawNotifications struct {
+	bus bus.Endpoint
+	log logger.Logger
+}
+
+// Raw returns a new RawNotifications connected to the provided bus.Bus
+func Raw(bt bus.Bus, log logger.Logger) (*RawNotifications, error) {
+	endp, err := bt.Connect(BusAddress, log)
+	if err != nil {
+		return nil, err
+	}
+
+	return &RawNotifications{endp, log}, nil
+}
+
+/*
+   public methods
+*/
+
+// Notify fires a notification
+func (raw *RawNotifications) Notify(
+	app_name string, reuse_id uint32,
+	icon, summary, body string,
+	actions []string, hints map[string]*dbus.Variant,
+	timeout int32) (uint32, error) {
+	// that's a long argument list! Take a breather.
+	//
+	rv, err := raw.bus.Call("Notify", app_name, reuse_id, icon,
+		summary, body, actions, hints, timeout)
+	if err != nil {
+		return 0, err
+	}
+	return rv.(uint32), nil
+}
+
+// WatchActions listens for ActionInvoked signals from the notification daemon
+// and sends them over the channel provided
+func (raw *RawNotifications) WatchActions() (<-chan RawActionReply, error) {
+	ch := make(chan RawActionReply)
+	err := raw.bus.WatchSignal("ActionInvoked",
+		func(ns ...interface{}) {
+			ch <- RawActionReply{ns[0].(uint32), ns[1].(string)}
+		}, func() { close(ch) })
+	if err != nil {
+		raw.log.Debugf("Failed to set up the watch: %s", err)
+		return nil, err
+	}
+	return ch, nil
+}

=== added file 'notifications/raw_test.go'
--- notifications/raw_test.go	1970-01-01 00:00:00 +0000
+++ notifications/raw_test.go	2014-01-22 12:27:44 +0000
@@ -0,0 +1,94 @@
+/*
+ Copyright 2013-2014 Canonical Ltd.
+
+ This program is free software: you can redistribute it and/or modify it
+ under the terms of the GNU General Public License version 3, as published
+ by the Free Software Foundation.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranties of
+ MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ PURPOSE.  See the GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+// Package notifications wraps a couple of Notifications's DBus API points:
+// the org.freedesktop.Notifications.Notify call, and listening for the
+// ActionInvoked signal.
+package notifications
+
+import (
+	"io/ioutil"
+	. "launchpad.net/gocheck"
+	testibus "launchpad.net/ubuntu-push/bus/testing"
+	"launchpad.net/ubuntu-push/logger"
+	"launchpad.net/ubuntu-push/testing/condition"
+	"testing"
+	"time"
+)
+
+// hook up gocheck
+func TestRaw(t *testing.T) { TestingT(t) }
+
+type RawSuite struct{}
+
+var _ = Suite(&RawSuite{})
+
+var nullog = logger.NewSimpleLogger(ioutil.Discard, "error")
+
+func (s *RawSuite) TestConnects(c *C) {
+	bus := testibus.NewTestingBus(condition.Work(false), condition.Work(false))
+	_, err := Raw(bus, nullog)
+	c.Check(err, NotNil)
+	bus = testibus.NewTestingBus(condition.Work(true), condition.Work(false))
+	_, err = Raw(bus, nullog)
+	c.Check(err, IsNil)
+}
+
+func (s *RawSuite) TestNotifies(c *C) {
+	bus := testibus.NewTestingBus(condition.Work(true), condition.Work(true),
+		uint32(1))
+	raw, err := Raw(bus, nullog)
+	c.Assert(err, IsNil)
+	nid, err := raw.Notify("", 0, "", "", "", nil, nil, 0)
+	c.Check(err, IsNil)
+	c.Check(nid, Equals, uint32(1))
+}
+
+func (s *RawSuite) TestNotifiesFails(c *C) {
+	bus := testibus.NewTestingBus(condition.Work(true), condition.Work(false))
+	raw, err := Raw(bus, nullog)
+	c.Assert(err, IsNil)
+	_, err = raw.Notify("", 0, "", "", "", nil, nil, 0)
+	c.Check(err, NotNil)
+}
+
+func (s *RawSuite) TestWatchActions(c *C) {
+	bus := testibus.NewMultiValuedTestingBus(condition.Work(true), condition.Work(true),
+		[]interface{}{uint32(1), "hello"})
+	raw, err := Raw(bus, nullog)
+	c.Assert(err, IsNil)
+	ch, err := raw.WatchActions()
+	c.Assert(err, IsNil)
+	// check we get the right action reply
+	select {
+	case p := <-ch:
+		c.Check(p.NotificationId, Equals, uint32(1))
+		c.Check(p.ActionId, Equals, "hello")
+	case <-time.NewTimer(time.Second / 10).C:
+		c.Error("timed out?")
+	}
+	// and that the channel is closed if/when the watch fails
+	_, ok := <-ch
+	c.Check(ok, Equals, false)
+}
+
+func (s *RawSuite) TestWatchActionsFails(c *C) {
+	bus := testibus.NewTestingBus(condition.Work(true), condition.Work(false))
+	raw, err := Raw(bus, nullog)
+	c.Assert(err, IsNil)
+	_, err = raw.WatchActions()
+	c.Check(err, NotNil)
+}