Merge lp:~chipaca/ubuntu-push/client-session into lp:ubuntu-push

[John Lenton]

A wild client session appears!

Client session, volume 1: Introduction to client session.

[Samuele Pedroni (pedronis)]

21 +package session

missing package description

74 + return nil, errors.New("dial: could not parse certificate")

not in dial anymore

98 + sess.Connection = nil

does it make sense not do this in case of error?

[Samuele Pedroni (pedronis)]

106 + return errors.New("Can't run disconnected.")

+ return errors.New("Can't run without a protocol constructor.")

maybe they should start lowercase? there's chance they will be printed/logged: ...: err-msg

[Samuele Pedroni (pedronis)]

218 + badpem, _ := ioutil.ReadFile("/etc/passwd")

you can just make a []byte constant there, no?

[Samuele Pedroni (pedronis)]

237 + lp, err := net.Listen("tcp", ":0")

:0 doesn't mean localhost, I personally don't like tests opening port for the world, so localhost:0 would be better

what does lp stand for?

[John Lenton (chipaca)]

Added package description. Am still missing descriptions for a number of things.

Fixed the "dial:" thing. Uncapitalized the other things. Need to get used to the latter.

Nice catch wrt badpem. Fixed.

Not sure where I got "lp" from. Changed to "srv". There's probably a few more of these in down-pipe branches; I'll try to catch them now.

[Samuele Pedroni (pedronis)]

good

review: Approve

[lp:~chipaca/ubuntu-push/client-session]

34. By John Lenton on 2014-01-31

[r=pedronis] A wild client session appears!

=== added file 'client/session/session.go'
--- client/session/session.go	1970-01-01 00:00:00 +0000
+++ client/session/session.go	2014-01-31 12:44:37 +0000
@@ -0,0 +1,109 @@
+/*
+ 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/>.
+*/
+
+// The client/session package handles the minutiae of interacting with
+// the Ubuntu Push Notifications server.
+package session
+
+import (
+	"crypto/tls"
+	"crypto/x509"
+	"errors"
+	"launchpad.net/ubuntu-push/client/session/levelmap"
+	"launchpad.net/ubuntu-push/logger"
+	"launchpad.net/ubuntu-push/protocol"
+	"net"
+	"time"
+)
+
+var wireVersionBytes = []byte{protocol.ProtocolWireVersion}
+
+type Notification struct {
+	// something something something
+}
+
+// ClienSession holds a client<->server session and its configuration.
+type ClientSession struct {
+	// configuration
+	DeviceId        string
+	ServerAddr      string
+	ExchangeTimeout time.Duration
+	Levels          levelmap.LevelMap
+	Protocolator    func(net.Conn) protocol.Protocol
+	// connection
+	Connection   net.Conn
+	Log          logger.Logger
+	TLS          *tls.Config
+	proto        protocol.Protocol
+	pingInterval time.Duration
+	// status
+	ErrCh chan error
+	MsgCh chan *Notification
+}
+
+func NewSession(serverAddr string, pem []byte, exchangeTimeout time.Duration,
+	deviceId string, log logger.Logger) (*ClientSession, error) {
+	sess := &ClientSession{
+		ExchangeTimeout: exchangeTimeout,
+		ServerAddr:      serverAddr,
+		DeviceId:        deviceId,
+		Log:             log,
+		Protocolator:    protocol.NewProtocol0,
+		Levels:          levelmap.NewLevelMap(),
+		TLS:             &tls.Config{InsecureSkipVerify: true}, // XXX
+	}
+	if pem != nil {
+		cp := x509.NewCertPool()
+		ok := cp.AppendCertsFromPEM(pem)
+		if !ok {
+			return nil, errors.New("could not parse certificate")
+		}
+		sess.TLS.RootCAs = cp
+	}
+	return sess, nil
+}
+
+// Dial connects to a server using the configuration in the ClientSession
+// and sets up the connection.
+func (sess *ClientSession) Dial() error {
+	conn, err := net.DialTimeout("tcp", sess.ServerAddr, sess.ExchangeTimeout)
+	if err != nil {
+		return err
+	}
+	sess.Connection = tls.Client(conn, sess.TLS)
+	return nil
+}
+
+func (sess *ClientSession) Close() {
+	if sess.Connection != nil {
+		sess.Connection.Close()
+		// we ignore Close errors, on purpose (the thinking being that
+		// the connection isn't really usable, and you've got nothing
+		// you could do to recover at this stage).
+		sess.Connection = nil
+	}
+}
+
+// call this to ensure the session is sane to run
+func (sess *ClientSession) checkRunnable() error {
+	if sess.Connection == nil {
+		return errors.New("can't run disconnected.")
+	}
+	if sess.Protocolator == nil {
+		return errors.New("can't run without a protocol constructor.")
+	}
+	return nil
+}

=== added file 'client/session/session_test.go'
--- client/session/session_test.go	1970-01-01 00:00:00 +0000
+++ client/session/session_test.go	2014-01-31 12:44:37 +0000
@@ -0,0 +1,199 @@
+/*
+ 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 session
+
+import (
+	"errors"
+	"io/ioutil"
+	. "launchpad.net/gocheck"
+	"launchpad.net/ubuntu-push/logger"
+	helpers "launchpad.net/ubuntu-push/testing"
+	"launchpad.net/ubuntu-push/testing/condition"
+	"net"
+	"os"
+	"testing"
+	"time"
+)
+
+func TestSession(t *testing.T) { TestingT(t) }
+
+type clientSessionSuite struct{}
+
+var nullog = logger.NewSimpleLogger(ioutil.Discard, "error")
+var debuglog = logger.NewSimpleLogger(os.Stderr, "debug")
+var _ = Suite(&clientSessionSuite{})
+
+//
+// helpers! candidates to live in their own ../testing/ package.
+//
+
+type xAddr string
+
+func (x xAddr) Network() string { return "<:>" }
+func (x xAddr) String() string  { return string(x) }
+
+// testConn (roughly based on the one in protocol_test)
+
+type testConn struct {
+	Name              string
+	Deadlines         []time.Duration
+	Writes            [][]byte
+	WriteCondition    condition.Interface
+	DeadlineCondition condition.Interface
+	CloseCondition    condition.Interface
+}
+
+func (tc *testConn) LocalAddr() net.Addr { return xAddr(tc.Name) }
+
+func (tc *testConn) RemoteAddr() net.Addr { return xAddr(tc.Name) }
+
+func (tc *testConn) Close() error {
+	if tc.CloseCondition == nil || tc.CloseCondition.OK() {
+		return nil
+	} else {
+		return errors.New("closer on fire")
+	}
+}
+
+func (tc *testConn) SetDeadline(t time.Time) error      { panic("SetDeadline not implemented.") }
+func (tc *testConn) SetReadDeadline(t time.Time) error  { panic("SetReadDeadline not implemented.") }
+func (tc *testConn) SetWriteDeadline(t time.Time) error { panic("SetWriteDeadline not implemented.") }
+func (tc *testConn) Read(buf []byte) (n int, err error) { panic("Read not implemented.") }
+func (tc *testConn) Write(buf []byte) (int, error)      { panic("Write not implemented.") }
+
+/****************************************************************
+  NewSession() tests
+****************************************************************/
+
+func (cs *clientSessionSuite) TestNewSessionPlainWorks(c *C) {
+	sess, err := NewSession("", nil, 0, "", nullog)
+	c.Check(sess, NotNil)
+	c.Check(err, IsNil)
+	// but no root CAs set
+	c.Check(sess.TLS.RootCAs, IsNil)
+}
+
+var certfile string = helpers.SourceRelative("../../server/acceptance/config/testing.cert")
+var pem, _ = ioutil.ReadFile(certfile)
+
+func (cs *clientSessionSuite) TestNewSessionPEMWorks(c *C) {
+	sess, err := NewSession("", pem, 0, "wah", nullog)
+	c.Check(sess, NotNil)
+	c.Assert(err, IsNil)
+	c.Check(sess.TLS.RootCAs, NotNil)
+}
+
+func (cs *clientSessionSuite) TestNewSessionBadPEMFileContentFails(c *C) {
+	badpem := []byte("This is not the PEM you're looking for.")
+	sess, err := NewSession("", badpem, 0, "wah", nullog)
+	c.Check(sess, IsNil)
+	c.Check(err, NotNil)
+}
+
+/****************************************************************
+  Dial() tests
+****************************************************************/
+
+func (cs *clientSessionSuite) TestDialFailsWithNoAddress(c *C) {
+	sess, err := NewSession("", nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	err = sess.Dial()
+	c.Assert(err, NotNil)
+	c.Check(err.Error(), Matches, ".*dial.*address.*")
+}
+
+func (cs *clientSessionSuite) TestDialConnects(c *C) {
+	srv, err := net.Listen("tcp", "localhost:0")
+	c.Assert(err, IsNil)
+	defer srv.Close()
+	sess, err := NewSession(srv.Addr().String(), nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	err = sess.Dial()
+	c.Check(err, IsNil)
+	c.Check(sess.Connection, NotNil)
+}
+
+func (cs *clientSessionSuite) TestDialConnectFail(c *C) {
+	srv, err := net.Listen("tcp", "localhost:0")
+	c.Assert(err, IsNil)
+	sess, err := NewSession(srv.Addr().String(), nil, 0, "wah", debuglog)
+	srv.Close()
+	c.Assert(err, IsNil)
+	err = sess.Dial()
+	c.Check(sess.Connection, IsNil)
+	c.Assert(err, NotNil)
+	c.Check(err.Error(), Matches, ".*connection refused")
+}
+
+/****************************************************************
+  Close() tests
+****************************************************************/
+
+func (cs *clientSessionSuite) TestClose(c *C) {
+	sess, err := NewSession("", nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	sess.Connection = &testConn{Name: "TestClose"}
+	sess.Close()
+	c.Check(sess.Connection, IsNil)
+}
+
+func (cs *clientSessionSuite) TestCloseTwice(c *C) {
+	sess, err := NewSession("", nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	sess.Connection = &testConn{Name: "TestCloseTwice"}
+	sess.Close()
+	c.Check(sess.Connection, IsNil)
+	sess.Close()
+	c.Check(sess.Connection, IsNil)
+}
+
+func (cs *clientSessionSuite) TestCloseFails(c *C) {
+	sess, err := NewSession("", nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	sess.Connection = &testConn{Name: "TestCloseFails", CloseCondition: condition.Work(false)}
+	sess.Close()
+	c.Check(sess.Connection, IsNil) // nothing you can do to clean up anyway
+}
+
+/****************************************************************
+  checkRunnable() tests
+****************************************************************/
+
+func (cs *clientSessionSuite) TestCheckRunnableFailsIfNoConnection(c *C) {
+	sess, err := NewSession("", nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	// no connection!
+	c.Check(sess.checkRunnable(), NotNil)
+}
+
+func (cs *clientSessionSuite) TestCheckRunnableFailsIfNoProtocolator(c *C) {
+	sess, err := NewSession("", nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	// set up the connection
+	sess.Connection = &testConn{}
+	// And stomp on the protocolator
+	sess.Protocolator = nil
+	c.Check(sess.checkRunnable(), NotNil)
+}
+
+func (cs *clientSessionSuite) TestCheckRunnable(c *C) {
+	sess, err := NewSession("", nil, 0, "wah", debuglog)
+	c.Assert(err, IsNil)
+	// set up the connection
+	sess.Connection = &testConn{}
+	c.Check(sess.checkRunnable(), IsNil)
+}