Merge lp:~chipaca/ubuntu-push/introducing-sqlevelmap into lp:ubuntu-push

[John Lenton]

this is sqlevelmap

Here's sqliteLevelMap. Guess what it does.

[Samuele Pedroni (pedronis)]

there is need to update the Makefile to grab the dependency or specify in the README which package to install,

there is still GOPATH tweaking to be done then though

review: Needs Fixing

[John Lenton (chipaca)]

Updated Makefile and dependencies.tsv

[Samuele Pedroni (pedronis)]

I needed this variant of the Makefile change, otherwise it explodes in the build bit: GODEPS += code.google.com/p/gosqlite/sqlite3

[Samuele Pedroni (pedronis)]

PACKAGE DOCUMENTATION

package levelmap
    import "/home/pedronis/canonical/go-ws/src/launchpad.net/ubuntu-push/client/session/levelmap"

    levelmap holds an implementation of the LevelMap that the client session

^^^ implementations

    uses to keep track of what messages it has seen.

TYPES

type LevelMap interface {
    // Set() (re)sets the given level to the given value.
    Set(level string, top int64) error
    // GetAll() returns a "simple" map of the current levels.
    GetAll() (map[string]int64, error)
}

func NewLevelMap() (LevelMap, error)
    default constructor

^^^ in-memory something something

func NewSqliteLevelMap(filename string) (LevelMap, error)

^^^ sqlite-backed something something

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~chipaca/ubuntu-push/introducing-sqlevelmap 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 code.google.com/p/gosqlite/sqlite3

go: missing Mercurial command. See http://golang.org/s/gogetcmd
package launchpad.net/gocheck
 imports launchpad.net/go-dbus/v1
 imports code.google.com/p/gosqlite/sqlite3: exec: "hg": executable file not found in $PATH
make: *** [bootstrap] Error 1

=== modified file 'Makefile'
--- Makefile	2014-01-20 12:36:21 +0000
+++ Makefile	2014-02-12 13:52:27 +0000
@@ -9,6 +9,7 @@
 
 GODEPS = launchpad.net/gocheck
 GODEPS += launchpad.net/go-dbus/v1
+GODEPS += code.google.com/p/gosqlite/sqlite3
 
 bootstrap:
 	mkdir -p $(GOPATH)/bin
 
=== modified file 'client/session/levelmap/levelmap.go'
--- client/session/levelmap/levelmap.go	2014-02-08 13:50:58 +0000
+++ client/session/levelmap/levelmap.go	2014-02-12 13:52:27 +0000
@@ -14,14 +14,10 @@
  with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-// levelmap holds an implementation of the LevelMap that the client
+// levelmap holds implementations of the LevelMap that the client
 // session uses to keep track of what messages it has seen.
 package levelmap
 
-// This implementation is memory-based and does not save state. There
-// is another one that stores the levels in sqlite that is missing a
-// few dependencies still.
-
 type LevelMap interface {
 	// Set() (re)sets the given level to the given value.
 	Set(level string, top int64) error
@@ -41,7 +37,8 @@
 
 var _ LevelMap = &mapLevelMap{}
 
-// default constructor
+// NewLevelMap returns an implementation of LevelMap that is memory-based and
+// does not save state.
 func NewLevelMap() (LevelMap, error) {
 	return &mapLevelMap{}, nil
 }
 
=== added file 'client/session/levelmap/sqlevelmap.go'
--- client/session/levelmap/sqlevelmap.go	1970-01-01 00:00:00 +0000
+++ client/session/levelmap/sqlevelmap.go	2014-02-12 13:52:27 +0000
@@ -0,0 +1,66 @@
+/*
+ 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 levelmap
+
+import (
+	_ "code.google.com/p/gosqlite/sqlite3"
+	"database/sql"
+	"fmt"
+)
+
+type sqliteLevelMap struct {
+	db *sql.DB
+}
+
+// NewSqliteLevelMap returns an implementation of LevelMap that
+// persists the map in an sqlite database.
+func NewSqliteLevelMap(filename string) (LevelMap, error) {
+	db, err := sql.Open("sqlite3", filename)
+	if err != nil {
+		return nil, fmt.Errorf("cannot open sqlite level map %#v: %v", filename, err)
+	}
+	_, err = db.Exec("CREATE TABLE IF NOT EXISTS level_map (level text primary key, top integer)")
+	if err != nil {
+		return nil, fmt.Errorf("cannot (re)create sqlite level map table: %v", err)
+	}
+	return &sqliteLevelMap{db}, nil
+}
+
+func (pm *sqliteLevelMap) Set(level string, top int64) error {
+	_, err := pm.db.Exec("REPLACE INTO level_map (level, top) VALUES (?, ?)", level, top)
+	if err != nil {
+		return fmt.Errorf("cannot set %#v to %#v in level map: %v", level, top, err)
+	}
+	return nil
+}
+func (pm *sqliteLevelMap) GetAll() (map[string]int64, error) {
+	rows, err := pm.db.Query("SELECT * FROM level_map")
+	if err != nil {
+		return nil, fmt.Errorf("cannot retrieve levels from sqlite level map: %v", err)
+	}
+	m := map[string]int64{}
+	for rows.Next() {
+		var level string
+		var top int64
+		err = rows.Scan(&level, &top)
+		if err != nil {
+			return nil, fmt.Errorf("cannot read level from sqlite level map: %v", err)
+		}
+		m[level] = top
+	}
+	return m, nil
+}
 
=== added file 'client/session/levelmap/sqlevelmap_test.go'
--- client/session/levelmap/sqlevelmap_test.go	1970-01-01 00:00:00 +0000
+++ client/session/levelmap/sqlevelmap_test.go	2014-02-12 13:52:27 +0000
@@ -0,0 +1,92 @@
+/*
+ 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 levelmap
+
+import (
+	_ "code.google.com/p/gosqlite/sqlite3"
+	"database/sql"
+	. "launchpad.net/gocheck"
+)
+
+type sqlmSuite struct{ lmSuite }
+
+var _ = Suite(&sqlmSuite{})
+
+func (s *sqlmSuite) SetUpSuite(c *C) {
+	s.constructor = func() (LevelMap, error) { return NewSqliteLevelMap(":memory:") }
+}
+
+func (s *sqlmSuite) TestNewCanFail(c *C) {
+	m, err := NewSqliteLevelMap("/does/not/exist")
+	c.Assert(m, IsNil)
+	c.Check(err, NotNil)
+}
+
+func (s *sqlmSuite) TestSetCanFail(c *C) {
+	dir := c.MkDir()
+	filename := dir + "test.db"
+	db, err := sql.Open("sqlite3", filename)
+	c.Assert(err, IsNil)
+	// create the wrong kind of table
+	_, err = db.Exec("CREATE TABLE level_map (foo)")
+	c.Assert(err, IsNil)
+	// <evil laughter>
+	m, err := NewSqliteLevelMap(filename)
+	c.Check(err, IsNil)
+	c.Assert(m, NotNil)
+	err = m.Set("foo", 42)
+	c.Check(err, ErrorMatches, "cannot set .*")
+}
+
+func (s *sqlmSuite) TestGetAllCanFail(c *C) {
+	dir := c.MkDir()
+	filename := dir + "test.db"
+	db, err := sql.Open("sqlite3", filename)
+	c.Assert(err, IsNil)
+	// create the wrong kind of table
+	_, err = db.Exec("CREATE TABLE level_map AS SELECT 'what'")
+	c.Assert(err, IsNil)
+	// <evil laughter>
+	m, err := NewSqliteLevelMap(filename)
+	c.Check(err, IsNil)
+	c.Assert(m, NotNil)
+	all, err := m.GetAll()
+	c.Check(all, IsNil)
+	c.Check(err, ErrorMatches, "cannot read level .*")
+}
+
+func (s *sqlmSuite) TestGetAllCanFailDifferently(c *C) {
+	dir := c.MkDir()
+	filename := dir + "test.db"
+	db, err := sql.Open("sqlite3", filename)
+	c.Assert(err, IsNil)
+	// create a view with the name the table will have
+	_, err = db.Exec("CREATE TABLE foo (foo)")
+	c.Assert(err, IsNil)
+	_, err = db.Exec("CREATE VIEW level_map AS SELECT * FROM foo")
+	c.Assert(err, IsNil)
+	// break the view
+	_, err = db.Exec("DROP TABLE foo")
+	c.Assert(err, IsNil)
+	// <evil laughter>
+	m, err := NewSqliteLevelMap(filename)
+	c.Check(err, IsNil)
+	c.Assert(m, NotNil)
+	all, err := m.GetAll()
+	c.Check(all, IsNil)
+	c.Check(err, ErrorMatches, "cannot retrieve levels .*")
+}
 
=== modified file 'dependencies.tsv'
--- dependencies.tsv	2014-01-20 06:23:17 +0000
+++ dependencies.tsv	2014-02-12 13:52:27 +0000
@@ -1,2 +1,3 @@
-launchpad.net/go-dbus/v1	bzr	[e-mail]-20140117100040-mmhdtiz5w9pxqtcr	124
-launchpad.net/gocheck	bzr	[e-mail]-20130302024745-6ikofwq2c03h7giu	85
+code.google.com/p/gosqlite	hg	74691fb6f83716190870cde1b658538dd4b18eb0	15
+launchpad.net/go-dbus/v1	bzr	[e-mail]-20140206110213-pbzcr6ucaz3rqmnw	125
+launchpad.net/gocheck	bzr	[e-mail]-20140127131816-zshobk1qqme626xw	86