Merge lp:~chipaca/ubuntu-push/out-with-the-new-in-with-the-oh-wait into lp:ubuntu-push/automatic

[John Lenton]

Move to an external helper for auth bits.

Move to an external helper for auth bits.

[Samuele Pedroni (pedronis)]

123 + if sess.AuthHelper == nil || len(sess.AuthHelper) == 0 {

len() is enough, len of a nil slice is legal in go and also gives 0

[Samuele Pedroni (pedronis)]

review: Approve

[lp:~chipaca/ubuntu-push/out-with-the-new-in-with-the-oh-wait]

139. By John Lenton on 2014-05-01

len() of nil slice is legal and zero

=== modified file 'Makefile'
--- Makefile	2014-04-15 14:43:02 +0000
+++ Makefile	2014-05-01 09:16:09 +0000
@@ -11,8 +11,6 @@
 GODEPS += launchpad.net/go-dbus/v1
 GODEPS += launchpad.net/go-xdg/v0
 GODEPS += code.google.com/p/gosqlite/sqlite3
-GODEPS += gopkg.in/qml.v0
-GODEPS += gopkg.in/niemeyer/uoneauth.v1
 
 TOTEST = $(shell env GOPATH=$(GOPATH) go list $(PROJECT)/...|grep -v acceptance|grep -v http13client )
 

=== modified file 'README'
--- README	2014-04-28 08:12:30 +0000
+++ README	2014-05-01 09:16:09 +0000
@@ -10,10 +10,6 @@
 
                build-essential
                libsqlite3-dev
-               qtbase5-private-dev
-               qtdeclarative5-dev
-               libqt5opengl5-dev
-               libubuntuoneauth-2.0-dev
 
 and run:
 

=== modified file 'client/client.go'
--- client/client.go	2014-04-16 18:17:07 +0000
+++ client/client.go	2014-05-01 09:16:09 +0000
@@ -26,7 +26,6 @@
 	"os"
 	"strings"
 
-	"gopkg.in/qml.v0"
 	"launchpad.net/go-dbus/v1"
 
 	"launchpad.net/ubuntu-push/bus"
@@ -112,7 +111,6 @@
 
 	// later, we'll be specifying more logging options in the config file
 	client.log = logger.NewSimpleLogger(os.Stderr, client.config.LogLevel.Level())
-	qml.SetLogger(client.log)
 
 	// overridden for testing
 	client.idder = identifier.New()

=== modified file 'client/client_test.go'
--- client/client_test.go	2014-04-18 10:36:20 +0000
+++ client/client_test.go	2014-05-01 09:16:09 +0000
@@ -265,8 +265,9 @@
 		ExchangeTimeout:        10 * time.Millisecond,
 		HostsCachingExpiryTime: 1 * time.Hour,
 		ExpectAllRepairedTime:  30 * time.Minute,
-		PEM:  cli.pem,
-		Info: info,
+		PEM:        cli.pem,
+		Info:       info,
+		AuthHelper: []string{},
 	}
 	// sanity check that we are looking at all fields
 	vExpected := reflect.ValueOf(expected)
@@ -276,6 +277,8 @@
 		// field isn't empty/zero
 		c.Assert(fv.Interface(), Not(DeepEquals), reflect.Zero(fv.Type()).Interface(), Commentf("forgot about: %s", vExpected.Type().Field(i).Name))
 	}
+	// but AuthHelper really should be nil for now
+	expected.AuthHelper = nil
 	// finally compare
 	conf := cli.deriveSessionConfig(info)
 	c.Check(conf, DeepEquals, expected)

=== modified file 'client/session/session.go'
--- client/session/session.go	2014-04-18 16:15:30 +0000
+++ client/session/session.go	2014-05-01 09:16:09 +0000
@@ -26,6 +26,7 @@
 	"fmt"
 	"math/rand"
 	"net"
+	"os/exec"
 	"strings"
 	"sync"
 	"sync/atomic"
@@ -40,8 +41,6 @@
 
 var (
 	wireVersionBytes = []byte{protocol.ProtocolWireVersion}
-	getAuthorization = util.GetAuthorization
-	shouldGetAuth    = false
 )
 
 type Notification struct {
@@ -88,6 +87,7 @@
 	ExpectAllRepairedTime  time.Duration
 	PEM                    []byte
 	Info                   map[string]interface{}
+	AuthHelper             []string
 }
 
 // ClientSession holds a client<->server session and its configuration.
@@ -240,18 +240,24 @@
 	return nil
 }
 
-// checkAuthorization checks the authorization within the phone
-func (sess *ClientSession) checkAuthorization() error {
-	// grab the authorization string from the accounts
-	// TODO: remove this condition when we have a way to deal with failing authorizations
-	if shouldGetAuth {
-		auth, err := getAuthorization()
-		if err != nil {
-			// For now we just log the error, as we don't want to block unauthorized users
-			sess.Log.Errorf("unable to get the authorization token from the account: %v", err)
-		}
-		sess.auth = auth
-	}
+// addAuthorization gets the authorization blob to send to the server
+// and adds it to the session.
+func (sess *ClientSession) addAuthorization() error {
+	sess.Log.Debugf("adding authorization")
+	// using a helper, for now at least
+	if len(sess.AuthHelper) == 0 {
+		// do nothing if helper is unset or empty
+		return nil
+	}
+
+	auth, err := exec.Command(sess.AuthHelper[0], sess.AuthHelper[1:]...).Output()
+	if err != nil {
+		// For now we just log the error, as we don't want to block unauthorized users
+		sess.Log.Errorf("unable to get the authorization token from the account: %v", err)
+	} else {
+		sess.auth = strings.TrimSpace(string(auth))
+	}
+
 	return nil
 }
 
@@ -553,7 +559,7 @@
 		// keep on trying.
 		panic("can't Dial() without a protocol constructor.")
 	}
-	return sess.run(sess.doClose, sess.checkAuthorization, sess.getHosts, sess.connect, sess.start, sess.loop)
+	return sess.run(sess.doClose, sess.addAuthorization, sess.getHosts, sess.connect, sess.start, sess.loop)
 }
 
 func init() {

=== modified file 'client/session/session_test.go'
--- client/session/session_test.go	2014-04-18 16:15:30 +0000
+++ client/session/session_test.go	2014-05-01 09:16:09 +0000
@@ -169,22 +169,10 @@
 	lvls func() (levelmap.LevelMap, error)
 }
 
-func (cs *clientSessionSuite) SetUpSuite(c *C) {
-	getAuthorization = func() (string, error) {
-		return "some auth", nil
-	}
-	shouldGetAuth = true
-}
-
 func (cs *clientSessionSuite) SetUpTest(c *C) {
 	cs.log = helpers.NewTestLogger(c, "debug")
 }
 
-func (cs *clientSessionSuite) TearDownSuite(c *C) {
-	getAuthorization = util.GetAuthorization
-	shouldGetAuth = false
-}
-
 // in-memory level map testing
 var _ = Suite(&clientSessionSuite{lvls: levelmap.NewLevelMap})
 
@@ -194,7 +182,6 @@
 var _ = Suite(&clientSqlevelsSessionSuite{})
 
 func (cs *clientSqlevelsSessionSuite) SetUpSuite(c *C) {
-	cs.clientSessionSuite.SetUpSuite(c)
 	cs.lvls = func() (levelmap.LevelMap, error) { return levelmap.NewSqliteLevelMap(":memory:") }
 }
 
@@ -359,17 +346,42 @@
 }
 
 /****************************************************************
-  checkAuthorization() tests
+  addAuthorization() tests
 ****************************************************************/
 
-func (cs *clientSessionSuite) TestChecksAuthorizationFromServer(c *C) {
-	sess := &ClientSession{}
+func (cs *clientSessionSuite) TestAddAuthorizationAddsAuthorization(c *C) {
+	sess := &ClientSession{Log: cs.log}
+	sess.AuthHelper = []string{"echo", "some auth"}
 	c.Assert(sess.auth, Equals, "")
-	err := sess.checkAuthorization()
+	err := sess.addAuthorization()
 	c.Assert(err, IsNil)
 	c.Check(sess.auth, Equals, "some auth")
 }
 
+func (cs *clientSessionSuite) TestAddAuthorizationIgnoresErrors(c *C) {
+	sess := &ClientSession{Log: cs.log}
+	sess.AuthHelper = []string{"sh", "-c", "echo hello; false"}
+
+	c.Assert(sess.auth, Equals, "")
+	err := sess.addAuthorization()
+	c.Assert(err, IsNil)
+	c.Check(sess.auth, Equals, "")
+}
+
+func (cs *clientSessionSuite) TestAddAuthorizationSkipsIfUnsetOrNil(c *C) {
+	sess := &ClientSession{Log: cs.log}
+	sess.AuthHelper = nil
+	c.Assert(sess.auth, Equals, "")
+	err := sess.addAuthorization()
+	c.Assert(err, IsNil)
+	c.Check(sess.auth, Equals, "")
+
+	sess.AuthHelper = []string{}
+	err = sess.addAuthorization()
+	c.Assert(err, IsNil)
+	c.Check(sess.auth, Equals, "")
+}
+
 /****************************************************************
   startConnectionAttempt()/nextHostToTry()/started tests
 ****************************************************************/

=== modified file 'debian/control'
--- debian/control	2014-04-15 14:20:09 +0000
+++ debian/control	2014-05-01 09:16:09 +0000
@@ -14,10 +14,6 @@
                libgcrypt11-dev,
                libglib2.0-dev (>= 2.31.6),
                libwhoopsie-dev,
-               qtbase5-private-dev,
-               qtdeclarative5-dev,
-               libqt5opengl5-dev,
-               libubuntuoneauth-2.0-dev,
 Standards-Version: 3.9.5
 Homepage: http://launchpad.net/ubuntu-push
 Vcs-Bzr: lp:ubuntu-push

=== modified file 'dependencies.tsv'
--- dependencies.tsv	2014-04-08 21:37:59 +0000
+++ dependencies.tsv	2014-05-01 09:16:09 +0000
@@ -2,5 +2,3 @@
 launchpad.net/go-dbus/v1	bzr	[e-mail]-20140206110213-pbzcr6ucaz3rqmnw	125
 launchpad.net/go-xdg/v0	bzr	[e-mail]-20140208094800-gubd5md7cro3mtxa	10
 launchpad.net/gocheck	bzr	[e-mail]-20140127131816-zshobk1qqme626xw	86
-gopkg.in/qml.v0	git	master	8adbc8c2bf2da9f609df366683ad0f47a89c3d49
-gopkg.in/niemeyer/uoneauth.v1	git	v1	0758ba882a143ad2862dbcac85a7ca145750b640

=== modified file 'ubuntu-push-client.go'
--- ubuntu-push-client.go	2014-04-15 13:01:05 +0000
+++ ubuntu-push-client.go	2014-05-01 09:16:09 +0000
@@ -19,7 +19,6 @@
 import (
 	"log"
 
-	"gopkg.in/qml.v0"
 	"launchpad.net/go-dbus/v1"
 	"launchpad.net/go-xdg/v0"
 
@@ -60,8 +59,6 @@
 		log.Fatalf("unable to open the levels database: %v", err)
 	}
 
-	qml.Init(nil)
-
 	cli := client.NewPushClient(cfgFname, lvlFname)
 	err = cli.Start()
 	if err != nil {

=== removed file 'util/auth.go'
--- util/auth.go	2014-04-09 22:36:14 +0000
+++ util/auth.go	1970-01-01 00:00:00 +0000
@@ -1,36 +0,0 @@
-/*
- 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 util
-
-import (
-	"gopkg.in/niemeyer/uoneauth.v1"
-	"gopkg.in/qml.v0"
-)
-
-func GetAuthorization() (string, error) {
-	engine := qml.NewEngine()
-	defer engine.Destroy()
-	authService := uoneauth.NewService(engine)
-	var auth string
-	token, err := authService.Token()
-	if err != nil {
-		return "", err
-	} else {
-		auth = token.HeaderSignature("POST", "https://push.ubuntu.com")
-	}
-	return auth, nil
-}

=== removed file 'util/auth_test.go'
--- util/auth_test.go	2014-04-15 13:05:37 +0000
+++ util/auth_test.go	1970-01-01 00:00:00 +0000
@@ -1,53 +0,0 @@
-/*
- 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 util
-
-import (
-	"os"
-
-	"gopkg.in/qml.v0"
-
-	. "launchpad.net/gocheck"
-)
-
-type authSuite struct{}
-
-var _ = Suite(&authSuite{})
-
-func (s *authSuite) SetUpSuite(c *C) {
-	if os.Getenv("PUSH_AUTH_TEST") == "1" {
-		qml.Init(nil)
-	}
-}
-
-func (s *authSuite) SetUpTest(c *C) {
-	qml.SetLogger(c)
-}
-
-func (s *authSuite) TestGetAuth(c *C) {
-	/*
-	 * This test is only useful when the PUSH_AUTH_TEST environment
-	 * variable is set to "1" - in which case the runner should have
-	 * a Ubuntu One account setup via system-settings.
-	 */
-	if os.Getenv("PUSH_AUTH_TEST") != "1" {
-		c.Skip("PUSH_AUTH_TEST not set to '1'")
-	}
-	auth, err := GetAuthorization()
-	c.Assert(err, IsNil)
-	c.Assert(auth, Matches, "OAuth .*oauth_consumer_key=.*")
-}