X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0f644e242ef37c911ad3dc25aca8135c339de349..d49403ac749fffe24ac6357597e6014bb65efa30:/services/ws/session_v0_test.go?ds=sidebyside

diff --git a/services/ws/session_v0_test.go b/services/ws/session_v0_test.go
index 0ae8ceb1c4..7986cc7b08 100644
--- a/services/ws/session_v0_test.go
+++ b/services/ws/session_v0_test.go
@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: AGPL-3.0
 
-package main
+package ws
 
 import (
 	"bytes"
@@ -11,11 +11,13 @@ import (
 	"io"
 	"net/url"
 	"os"
+	"strings"
+	"sync"
 	"time"
 
-	"git.curoverse.com/arvados.git/sdk/go/arvados"
-	"git.curoverse.com/arvados.git/sdk/go/arvadostest"
-	"git.curoverse.com/arvados.git/sdk/go/ctxlog"
+	"git.arvados.org/arvados.git/sdk/go/arvados"
+	"git.arvados.org/arvados.git/sdk/go/arvadostest"
+	"git.arvados.org/arvados.git/sdk/go/ctxlog"
 	"golang.org/x/net/websocket"
 	check "gopkg.in/check.v1"
 )
@@ -29,17 +31,31 @@ func init() {
 var _ = check.Suite(&v0Suite{})
 
 type v0Suite struct {
-	serverSuite serverSuite
-	token       string
-	toDelete    []string
+	serviceSuite serviceSuite
+	token        string
+	toDelete     []string
+	wg           sync.WaitGroup
+	ignoreLogID  uint64
 }
 
 func (s *v0Suite) SetUpTest(c *check.C) {
-	s.serverSuite.SetUpTest(c)
+	s.serviceSuite.SetUpTest(c)
+	s.serviceSuite.start(c)
+
 	s.token = arvadostest.ActiveToken
+	s.ignoreLogID = s.lastLogID(c)
+}
+
+func (s *v0Suite) TearDownTest(c *check.C) {
+	s.wg.Wait()
+	s.serviceSuite.TearDownTest(c)
 }
 
 func (s *v0Suite) TearDownSuite(c *check.C) {
+	s.deleteTestObjects(c)
+}
+
+func (s *v0Suite) deleteTestObjects(c *check.C) {
 	ac := arvados.NewClientFromEnv()
 	ac.AuthToken = arvadostest.AdminToken
 	for _, path := range s.toDelete {
@@ -48,34 +64,72 @@ func (s *v0Suite) TearDownSuite(c *check.C) {
 			panic(err)
 		}
 	}
+	s.toDelete = nil
 }
 
 func (s *v0Suite) TestFilters(c *check.C) {
-	srv, conn, r, w := s.testClient()
-	defer srv.Close()
+	conn, r, w := s.testClient()
 	defer conn.Close()
 
-	c.Check(w.Encode(map[string]interface{}{
-		"method":  "subscribe",
-		"filters": [][]interface{}{{"event_type", "in", []string{"update"}}},
-	}), check.IsNil)
-	s.expectStatus(c, r, 200)
+	cmd := func(method, eventType string, status int) {
+		c.Check(w.Encode(map[string]interface{}{
+			"method":  method,
+			"filters": [][]interface{}{{"event_type", "in", []string{eventType}}},
+		}), check.IsNil)
+		s.expectStatus(c, r, status)
+	}
+	cmd("subscribe", "update", 200)
+	cmd("subscribe", "update", 200)
+	cmd("subscribe", "create", 200)
+	cmd("subscribe", "update", 200)
+	cmd("unsubscribe", "blip", 400)
+	cmd("unsubscribe", "create", 200)
+	cmd("unsubscribe", "update", 200)
 
 	go s.emitEvents(nil)
 	lg := s.expectLog(c, r)
 	c.Check(lg.EventType, check.Equals, "update")
+
+	cmd("unsubscribe", "update", 200)
+	cmd("unsubscribe", "update", 200)
+	cmd("unsubscribe", "update", 400)
 }
 
 func (s *v0Suite) TestLastLogID(c *check.C) {
-	var lastID uint64
-	c.Assert(testDB().QueryRow(`SELECT MAX(id) FROM logs`).Scan(&lastID), check.IsNil)
+	lastID := s.lastLogID(c)
 
-	srv, conn, r, w := s.testClient()
-	defer srv.Close()
-	defer conn.Close()
+	checkLogs := func(r *json.Decoder, uuid string) {
+		for _, etype := range []string{"create", "blip", "update"} {
+			lg := s.expectLog(c, r)
+			for lg.ObjectUUID != uuid {
+				lg = s.expectLog(c, r)
+			}
+			c.Check(lg.EventType, check.Equals, etype)
+		}
+	}
 
-	uuidChan := make(chan string, 2)
+	// Connecting connEarly (before sending the early events) lets
+	// us confirm all of the "early" events have already passed
+	// through the server.
+	connEarly, rEarly, wEarly := s.testClient()
+	defer connEarly.Close()
+	c.Check(wEarly.Encode(map[string]interface{}{
+		"method": "subscribe",
+	}), check.IsNil)
+	s.expectStatus(c, rEarly, 200)
+
+	// Send the early events.
+	uuidChan := make(chan string, 1)
 	s.emitEvents(uuidChan)
+	uuidEarly := <-uuidChan
+
+	// Wait for the early events to pass through.
+	checkLogs(rEarly, uuidEarly)
+
+	// Connect the client that wants to get old events via
+	// last_log_id.
+	conn, r, w := s.testClient()
+	defer conn.Close()
 
 	c.Check(w.Encode(map[string]interface{}{
 		"method":      "subscribe",
@@ -83,33 +137,13 @@ func (s *v0Suite) TestLastLogID(c *check.C) {
 	}), check.IsNil)
 	s.expectStatus(c, r, 200)
 
-	go func() {
-		s.emitEvents(uuidChan)
-		close(uuidChan)
-	}()
-
-	done := make(chan bool)
-	go func() {
-		for uuid := range uuidChan {
-			for _, etype := range []string{"create", "blip", "update"} {
-				lg := s.expectLog(c, r)
-				c.Check(lg.ObjectUUID, check.Equals, uuid)
-				c.Check(lg.EventType, check.Equals, etype)
-			}
-		}
-		close(done)
-	}()
-
-	select {
-	case <-time.After(10 * time.Second):
-		c.Fatal("timeout")
-	case <-done:
-	}
+	checkLogs(r, uuidEarly)
+	s.emitEvents(uuidChan)
+	checkLogs(r, <-uuidChan)
 }
 
 func (s *v0Suite) TestPermission(c *check.C) {
-	srv, conn, r, w := s.testClient()
-	defer srv.Close()
+	conn, r, w := s.testClient()
 	defer conn.Close()
 
 	c.Check(w.Encode(map[string]interface{}{
@@ -117,21 +151,88 @@ func (s *v0Suite) TestPermission(c *check.C) {
 	}), check.IsNil)
 	s.expectStatus(c, r, 200)
 
-	uuidChan := make(chan string, 1)
+	uuidChan := make(chan string, 2)
 	go func() {
 		s.token = arvadostest.AdminToken
-		s.emitEvents(nil)
+		s.emitEvents(uuidChan)
 		s.token = arvadostest.ActiveToken
 		s.emitEvents(uuidChan)
 	}()
 
+	wrongUUID := <-uuidChan
+	rightUUID := <-uuidChan
+	lg := s.expectLog(c, r)
+	for lg.ObjectUUID != rightUUID {
+		c.Check(lg.ObjectUUID, check.Not(check.Equals), wrongUUID)
+		lg = s.expectLog(c, r)
+	}
+}
+
+// Two users create private objects; admin deletes both objects; each
+// user receives a "delete" event for their own object (not for the
+// other user's object).
+func (s *v0Suite) TestEventTypeDelete(c *check.C) {
+	clients := []struct {
+		token string
+		uuid  string
+		conn  *websocket.Conn
+		r     *json.Decoder
+		w     *json.Encoder
+	}{{token: arvadostest.ActiveToken}, {token: arvadostest.SpectatorToken}}
+	for i := range clients {
+		uuidChan := make(chan string, 1)
+		s.token = clients[i].token
+		s.emitEvents(uuidChan)
+		clients[i].uuid = <-uuidChan
+		clients[i].conn, clients[i].r, clients[i].w = s.testClient()
+
+		c.Check(clients[i].w.Encode(map[string]interface{}{
+			"method": "subscribe",
+		}), check.IsNil)
+		s.expectStatus(c, clients[i].r, 200)
+	}
+
+	s.ignoreLogID = s.lastLogID(c)
+	s.deleteTestObjects(c)
+
+	for _, client := range clients {
+		lg := s.expectLog(c, client.r)
+		c.Check(lg.ObjectUUID, check.Equals, client.uuid)
+		c.Check(lg.EventType, check.Equals, "delete")
+	}
+}
+
+// Trashing/deleting a collection produces an "update" event with
+// properties["new_attributes"]["is_trashed"] == true.
+func (s *v0Suite) TestTrashedCollection(c *check.C) {
+	ac := arvados.NewClientFromEnv()
+	ac.AuthToken = s.token
+
+	var coll arvados.Collection
+	err := ac.RequestAndDecode(&coll, "POST", "arvados/v1/collections", s.jsonBody("collection", `{"manifest_text":""}`), map[string]interface{}{"ensure_unique_name": true})
+	c.Assert(err, check.IsNil)
+	s.ignoreLogID = s.lastLogID(c)
+
+	conn, r, w := s.testClient()
+	defer conn.Close()
+
+	c.Check(w.Encode(map[string]interface{}{
+		"method": "subscribe",
+	}), check.IsNil)
+	s.expectStatus(c, r, 200)
+
+	err = ac.RequestAndDecode(nil, "DELETE", "arvados/v1/collections/"+coll.UUID, nil, nil)
+	c.Assert(err, check.IsNil)
+
 	lg := s.expectLog(c, r)
-	c.Check(lg.ObjectUUID, check.Equals, <-uuidChan)
+	c.Check(lg.ObjectUUID, check.Equals, coll.UUID)
+	c.Check(lg.EventType, check.Equals, "update")
+	c.Check(lg.Properties["old_attributes"].(map[string]interface{})["is_trashed"], check.Equals, false)
+	c.Check(lg.Properties["new_attributes"].(map[string]interface{})["is_trashed"], check.Equals, true)
 }
 
 func (s *v0Suite) TestSendBadJSON(c *check.C) {
-	srv, conn, r, w := s.testClient()
-	defer srv.Close()
+	conn, r, w := s.testClient()
 	defer conn.Close()
 
 	c.Check(w.Encode(map[string]interface{}{
@@ -150,8 +251,7 @@ func (s *v0Suite) TestSendBadJSON(c *check.C) {
 }
 
 func (s *v0Suite) TestSubscribe(c *check.C) {
-	srv, conn, r, w := s.testClient()
-	defer srv.Close()
+	conn, r, w := s.testClient()
 	defer conn.Close()
 
 	s.emitEvents(nil)
@@ -170,7 +270,9 @@ func (s *v0Suite) TestSubscribe(c *check.C) {
 
 	for _, etype := range []string{"create", "blip", "update"} {
 		lg := s.expectLog(c, r)
-		c.Check(lg.ObjectUUID, check.Equals, uuid)
+		for lg.ObjectUUID != uuid {
+			lg = s.expectLog(c, r)
+		}
 		c.Check(lg.EventType, check.Equals, etype)
 	}
 }
@@ -180,12 +282,15 @@ func (s *v0Suite) TestSubscribe(c *check.C) {
 // created workflow. If uuidChan is not nil, send the new workflow
 // UUID to uuidChan as soon as it's known.
 func (s *v0Suite) emitEvents(uuidChan chan<- string) {
+	s.wg.Add(1)
+	defer s.wg.Done()
+
 	ac := arvados.NewClientFromEnv()
 	ac.AuthToken = s.token
 	wf := &arvados.Workflow{
 		Name: "ws_test",
 	}
-	err := ac.RequestAndDecode(wf, "POST", "arvados/v1/workflows", s.jsonBody("workflow", wf), map[string]interface{}{"ensure_unique_name": true})
+	err := ac.RequestAndDecode(wf, "POST", "arvados/v1/workflows", s.jsonBody("workflow", `{"name":"ws_test"}`), map[string]interface{}{"ensure_unique_name": true})
 	if err != nil {
 		panic(err)
 	}
@@ -193,17 +298,17 @@ func (s *v0Suite) emitEvents(uuidChan chan<- string) {
 		uuidChan <- wf.UUID
 	}
 	lg := &arvados.Log{}
-	err = ac.RequestAndDecode(lg, "POST", "arvados/v1/logs", s.jsonBody("log", &arvados.Log{
-		ObjectUUID: wf.UUID,
-		EventType:  "blip",
-		Properties: map[string]interface{}{
+	err = ac.RequestAndDecode(lg, "POST", "arvados/v1/logs", s.jsonBody("log", map[string]interface{}{
+		"object_uuid": wf.UUID,
+		"event_type":  "blip",
+		"properties": map[string]interface{}{
 			"beep": "boop",
 		},
 	}), nil)
 	if err != nil {
 		panic(err)
 	}
-	err = ac.RequestAndDecode(wf, "PUT", "arvados/v1/workflows/"+wf.UUID, s.jsonBody("workflow", wf), nil)
+	err = ac.RequestAndDecode(wf, "PUT", "arvados/v1/workflows/"+wf.UUID, s.jsonBody("workflow", `{"name":"ws_test"}`), nil)
 	if err != nil {
 		panic(err)
 	}
@@ -211,12 +316,16 @@ func (s *v0Suite) emitEvents(uuidChan chan<- string) {
 }
 
 func (s *v0Suite) jsonBody(rscName string, ob interface{}) io.Reader {
-	j, err := json.Marshal(ob)
-	if err != nil {
-		panic(err)
+	val, ok := ob.(string)
+	if !ok {
+		j, err := json.Marshal(ob)
+		if err != nil {
+			panic(err)
+		}
+		val = string(j)
 	}
 	v := url.Values{}
-	v[rscName] = []string{string(j)}
+	v[rscName] = []string{val}
 	return bytes.NewBufferString(v.Encode())
 }
 
@@ -228,19 +337,34 @@ func (s *v0Suite) expectStatus(c *check.C, r *json.Decoder, status int) {
 
 func (s *v0Suite) expectLog(c *check.C, r *json.Decoder) *arvados.Log {
 	lg := &arvados.Log{}
-	c.Check(r.Decode(lg), check.IsNil)
-	return lg
+	ok := make(chan struct{})
+	go func() {
+		for lg.ID <= s.ignoreLogID {
+			c.Check(r.Decode(lg), check.IsNil)
+		}
+		close(ok)
+	}()
+	select {
+	case <-time.After(10 * time.Second):
+		panic("timed out")
+	case <-ok:
+		return lg
+	}
 }
 
-func (s *v0Suite) testClient() (*server, *websocket.Conn, *json.Decoder, *json.Encoder) {
-	go s.serverSuite.srv.Run()
-	s.serverSuite.srv.WaitReady()
-	srv := s.serverSuite.srv
-	conn, err := websocket.Dial("ws://"+srv.listener.Addr().String()+"/websocket?api_token="+s.token, "", "http://"+srv.listener.Addr().String())
+func (s *v0Suite) testClient() (*websocket.Conn, *json.Decoder, *json.Encoder) {
+	srv := s.serviceSuite.srv
+	conn, err := websocket.Dial(strings.Replace(srv.URL, "http", "ws", 1)+"/websocket?api_token="+s.token, "", srv.URL)
 	if err != nil {
 		panic(err)
 	}
 	w := json.NewEncoder(conn)
 	r := json.NewDecoder(conn)
-	return srv, conn, r, w
+	return conn, r, w
+}
+
+func (s *v0Suite) lastLogID(c *check.C) uint64 {
+	var lastID uint64
+	c.Assert(testDB().QueryRow(`SELECT MAX(id) FROM logs`).Scan(&lastID), check.IsNil)
+	return lastID
 }