Merge lp:~chipaca/snappy/daemon-daemon-please-add-a-task---no-by-the-chin-of-my-chinny-chin-chin into lp:~snappy-dev/snappy/snappy-moved-to-github

[John Lenton]

GET /1.0/operation/{uuid}

[Michael Vogt (mvo)]

Nice!

review: Approve

[Michael Vogt (mvo)]

LTGTM

review: Approve

=== modified file 'daemon/api.go'
--- daemon/api.go	2015-09-14 12:48:41 +0000
+++ daemon/api.go	2015-09-14 12:48:41 +0000
@@ -37,6 +37,7 @@
 	v1Cmd,
 	packagesCmd,
 	packageCmd,
+	operationCmd,
 }
 
 var (
@@ -59,6 +60,11 @@
 		Path: "/1.0/packages/{package}",
 		GET:  getPackageInfo,
 	}
+
+	operationCmd = &Command{
+		Path: "/1.0/operations/{uuid}",
+		GET:  getOpInfo,
+	}
 )
 
 func v1Get(c *Command, r *http.Request) Response {
@@ -265,3 +271,24 @@
 		},
 	})
 }
+
+func getOpInfo(c *Command, r *http.Request) Response {
+	route := c.d.router.Get(c.Path)
+	if route == nil {
+		logger.Noticef("router can't find route for operation")
+		return InternalError
+	}
+
+	id := muxVars(r)["uuid"]
+	if id == "" {
+		// can't happen, i think? mux won't let it
+		return BadRequest
+	}
+
+	task := c.d.GetTask(id)
+	if task == nil {
+		return NotFound
+	}
+
+	return SyncResponse(task.Map(route))
+}

=== modified file 'daemon/api_test.go'
--- daemon/api_test.go	2015-09-14 12:48:41 +0000
+++ daemon/api_test.go	2015-09-14 12:48:41 +0000
@@ -31,6 +31,7 @@
 	"os"
 	"path/filepath"
 	"testing"
+	"time"
 
 	"gopkg.in/check.v1"
 
@@ -345,3 +346,55 @@
 		c.Check(got["origin"], check.Equals, part.origin)
 	}
 }
+
+func (s *apiSuite) TestGetOpInfoIntegration(c *check.C) {
+	d := New()
+	d.addRoutes()
+
+	s.vars = map[string]string{"uuid": "42"}
+	c.Check(getOpInfo(operationCmd, nil), check.Equals, NotFound)
+
+	ch := make(chan struct{})
+
+	t := d.AddTask(func() interface{} {
+		ch <- struct{}{}
+		return "hello"
+	})
+
+	id := t.UUID()
+	s.vars = map[string]string{"uuid": id}
+
+	rsp := getOpInfo(operationCmd, nil).(*resp)
+
+	c.Check(rsp.Status, check.Equals, http.StatusOK)
+	c.Check(rsp.Type, check.Equals, ResponseTypeSync)
+	c.Check(rsp.Metadata, check.DeepEquals, map[string]interface{}{
+		"resource":   "/1.0/operations/" + id,
+		"status":     TaskRunning,
+		"may_cancel": false,
+		"created_at": FormatTime(t.CreatedAt()),
+		"updated_at": FormatTime(t.UpdatedAt()),
+		"metadata":   nil,
+	})
+	tf1 := t.UpdatedAt().UTC().UnixNano()
+
+	<-ch
+	time.Sleep(time.Millisecond)
+
+	rsp = getOpInfo(operationCmd, nil).(*resp)
+
+	c.Check(rsp.Status, check.Equals, http.StatusOK)
+	c.Check(rsp.Type, check.Equals, ResponseTypeSync)
+	c.Check(rsp.Metadata, check.DeepEquals, map[string]interface{}{
+		"resource":   "/1.0/operations/" + id,
+		"status":     TaskSucceeded,
+		"may_cancel": false,
+		"created_at": FormatTime(t.CreatedAt()),
+		"updated_at": FormatTime(t.UpdatedAt()),
+		"metadata":   "hello",
+	})
+
+	tf2 := t.UpdatedAt().UTC().UnixNano()
+
+	c.Check(tf1 < tf2, check.Equals, true)
+}

=== modified file 'daemon/daemon.go'
--- daemon/daemon.go	2015-09-14 12:48:41 +0000
+++ daemon/daemon.go	2015-09-14 12:48:41 +0000
@@ -23,6 +23,7 @@
 	"fmt"
 	"net"
 	"net/http"
+	"sync"
 	"time"
 
 	"github.com/coreos/go-systemd/activation"
@@ -34,9 +35,11 @@
 
 // A Daemon listens for requests and routes them to the right command
 type Daemon struct {
-	listener net.Listener
-	tomb     tomb.Tomb
-	router   *mux.Router
+	sync.RWMutex // for concurrent access to the tasks map
+	tasks        map[string]*Task
+	listener     net.Listener
+	tomb         tomb.Tomb
+	router       *mux.Router
 }
 
 // A ResponseFunc handles one of the individual verbs for a method
@@ -164,7 +167,26 @@
 	return d.tomb.Dying()
 }
 
+// AddTask runs the given function as a task
+func (d *Daemon) AddTask(f func() interface{}) *Task {
+	t := RunTask(f)
+	d.Lock()
+	defer d.Unlock()
+	d.tasks[t.UUID()] = t
+
+	return t
+}
+
+// GetTask retrieves a task from the tasks map, by uuid.
+func (d *Daemon) GetTask(uuid string) *Task {
+	d.RLock()
+	defer d.RUnlock()
+	return d.tasks[uuid]
+}
+
 // New Daemon
 func New() *Daemon {
-	return &Daemon{}
+	return &Daemon{
+		tasks: make(map[string]*Task),
+	}
 }

=== modified file 'daemon/task.go'
--- daemon/task.go	2015-09-14 12:48:41 +0000
+++ daemon/task.go	2015-09-14 12:48:41 +0000
@@ -20,6 +20,9 @@
 package daemon
 
 import (
+	"strconv"
+	"time"
+
 	"github.com/gorilla/mux"
 	"gopkg.in/tomb.v2"
 )
@@ -28,6 +31,8 @@
 type Task struct {
 	id       UUID
 	tomb     tomb.Tomb
+	t0       time.Time
+	tf       time.Time
 	metadata interface{}
 }
 
@@ -38,6 +43,16 @@
 	TaskFailed    = "failed"
 )
 
+// CreatedAt returns the timestamp at which the task was created
+func (t *Task) CreatedAt() time.Time {
+	return t.t0
+}
+
+// UpdatedAt returns the timestamp at which the task was updated
+func (t *Task) UpdatedAt() time.Time {
+	return t.tf
+}
+
 // Metadata is the outcome of this task. If the task is still running
 // this will be nil.
 func (t *Task) Metadata() interface{} {
@@ -61,6 +76,11 @@
 	}
 }
 
+// UUID of the task
+func (t *Task) UUID() string {
+	return t.id.String()
+}
+
 // Location of the task, based on the given route.
 //
 // If the route can't build a URL for this task, returns the empty
@@ -74,12 +94,38 @@
 	return url.String()
 }
 
+// FormatTime outputs the given time as microseconds since the epoch
+// UTC, formatted as a decimal string
+func FormatTime(t time.Time) string {
+	return strconv.FormatInt(t.UTC().UnixNano()/1000, 10)
+}
+
+// Map the task onto a map[string]interface{}, using the given route for the Location()
+func (t *Task) Map(route *mux.Route) map[string]interface{} {
+	return map[string]interface{}{
+		"resource":   t.Location(route),
+		"status":     t.State(),
+		"created_at": FormatTime(t.CreatedAt()),
+		"updated_at": FormatTime(t.UpdatedAt()),
+		"may_cancel": false,
+		"metadata":   t.Metadata(),
+	}
+}
+
 // RunTask creates a Task for the given function and runs it.
 func RunTask(f func() interface{}) *Task {
 	id := UUID4()
-	t := &Task{id: id}
+	t0 := time.Now()
+	t := &Task{
+		id: id,
+		t0: t0,
+		tf: t0,
+	}
 
 	t.tomb.Go(func() error {
+		defer func() {
+			t.tf = time.Now()
+		}()
 		out := f()
 		t.metadata = out
 

=== modified file 'daemon/task_test.go'
--- daemon/task_test.go	2015-09-14 12:48:41 +0000
+++ daemon/task_test.go	2015-09-14 12:48:41 +0000
@@ -42,6 +42,7 @@
 		return 42
 	})
 
+	c.Check(t.UUID(), check.Equals, t.id.String())
 	c.Check(t.Metadata(), check.IsNil)
 	c.Check(t.State(), check.Equals, TaskRunning)
 	c.Check(t.Location(route), check.Equals, "/xyzzy/"+t.id.String())
@@ -67,6 +68,7 @@
 		return err
 	})
 
+	c.Check(t.UUID(), check.Equals, t.id.String())
 	c.Check(t.Metadata(), check.IsNil)
 	c.Check(t.State(), check.Equals, TaskRunning)
 	c.Check(t.Location(route), check.Equals, "/xyzzy/"+t.id.String())