services/ws/session_v0_test.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 import (
   8         "bytes"
   9         "encoding/json"
  10         "fmt"
  11         "io"
  12         "net/url"
  13         "os"
  14         "time"
  15
  16         "git.curoverse.com/arvados.git/sdk/go/arvados"
  17         "git.curoverse.com/arvados.git/sdk/go/arvadostest"
  18         "git.curoverse.com/arvados.git/sdk/go/ctxlog"
  19         "golang.org/x/net/websocket"
  20         check "gopkg.in/check.v1"
  21 )
  22
  23 func init() {
  24         if os.Getenv("ARVADOS_DEBUG") != "" {
  25                 ctxlog.SetLevel("debug")
  26         }
  27 }
  28
  29 var _ = check.Suite(&v0Suite{})
  30
  31 type v0Suite struct {
  32         serverSuite serverSuite
  33         token       string
  34         toDelete    []string
  35 }
  36
  37 func (s *v0Suite) SetUpTest(c *check.C) {
  38         s.serverSuite.SetUpTest(c)
  39         s.token = arvadostest.ActiveToken
  40 }
  41
  42 func (s *v0Suite) TearDownSuite(c *check.C) {
  43         ac := arvados.NewClientFromEnv()
  44         ac.AuthToken = arvadostest.AdminToken
  45         for _, path := range s.toDelete {
  46                 err := ac.RequestAndDecode(nil, "DELETE", path, nil, nil)
  47                 if err != nil {
  48                         panic(err)
  49                 }
  50         }
  51 }
  52
  53 func (s *v0Suite) TestFilters(c *check.C) {
  54         srv, conn, r, w := s.testClient()
  55         defer srv.Close()
  56         defer conn.Close()
  57
  58         c.Check(w.Encode(map[string]interface{}{
  59                 "method":  "subscribe",
  60                 "filters": [][]interface{}{{"event_type", "in", []string{"update"}}},
  61         }), check.IsNil)
  62         s.expectStatus(c, r, 200)
  63
  64         go s.emitEvents(nil)
  65         lg := s.expectLog(c, r)
  66         c.Check(lg.EventType, check.Equals, "update")
  67 }
  68
  69 func (s *v0Suite) TestLastLogID(c *check.C) {
  70         var lastID uint64
  71         c.Assert(testDB().QueryRow(`SELECT MAX(id) FROM logs`).Scan(&lastID), check.IsNil)
  72
  73         srv, conn, r, w := s.testClient()
  74         defer srv.Close()
  75         defer conn.Close()
  76
  77         uuidChan := make(chan string, 2)
  78         s.emitEvents(uuidChan)
  79
  80         c.Check(w.Encode(map[string]interface{}{
  81                 "method":      "subscribe",
  82                 "last_log_id": lastID,
  83         }), check.IsNil)
  84         s.expectStatus(c, r, 200)
  85
  86         go func() {
  87                 s.emitEvents(uuidChan)
  88                 close(uuidChan)
  89         }()
  90
  91         done := make(chan bool)
  92         go func() {
  93                 for uuid := range uuidChan {
  94                         for _, etype := range []string{"create", "blip", "update"} {
  95                                 lg := s.expectLog(c, r)
  96                                 c.Check(lg.ObjectUUID, check.Equals, uuid)
  97                                 c.Check(lg.EventType, check.Equals, etype)
  98                         }
  99                 }
 100                 close(done)
 101         }()
 102
 103         select {
 104         case <-time.After(10 * time.Second):
 105                 c.Fatal("timeout")
 106         case <-done:
 107         }
 108 }
 109
 110 func (s *v0Suite) TestPermission(c *check.C) {
 111         srv, conn, r, w := s.testClient()
 112         defer srv.Close()
 113         defer conn.Close()
 114
 115         c.Check(w.Encode(map[string]interface{}{
 116                 "method": "subscribe",
 117         }), check.IsNil)
 118         s.expectStatus(c, r, 200)
 119
 120         uuidChan := make(chan string, 1)
 121         go func() {
 122                 s.token = arvadostest.AdminToken
 123                 s.emitEvents(nil)
 124                 s.token = arvadostest.ActiveToken
 125                 s.emitEvents(uuidChan)
 126         }()
 127
 128         lg := s.expectLog(c, r)
 129         c.Check(lg.ObjectUUID, check.Equals, <-uuidChan)
 130 }
 131
 132 func (s *v0Suite) TestSendBadJSON(c *check.C) {
 133         srv, conn, r, w := s.testClient()
 134         defer srv.Close()
 135         defer conn.Close()
 136
 137         c.Check(w.Encode(map[string]interface{}{
 138                 "method": "subscribe",
 139         }), check.IsNil)
 140         s.expectStatus(c, r, 200)
 141
 142         _, err := fmt.Fprint(conn, "^]beep\n")
 143         c.Check(err, check.IsNil)
 144         s.expectStatus(c, r, 400)
 145
 146         c.Check(w.Encode(map[string]interface{}{
 147                 "method": "subscribe",
 148         }), check.IsNil)
 149         s.expectStatus(c, r, 200)
 150 }
 151
 152 func (s *v0Suite) TestSubscribe(c *check.C) {
 153         srv, conn, r, w := s.testClient()
 154         defer srv.Close()
 155         defer conn.Close()
 156
 157         s.emitEvents(nil)
 158
 159         err := w.Encode(map[string]interface{}{"21": 12})
 160         c.Check(err, check.IsNil)
 161         s.expectStatus(c, r, 400)
 162
 163         err = w.Encode(map[string]interface{}{"method": "subscribe", "filters": []string{}})
 164         c.Check(err, check.IsNil)
 165         s.expectStatus(c, r, 200)
 166
 167         uuidChan := make(chan string, 1)
 168         go s.emitEvents(uuidChan)
 169         uuid := <-uuidChan
 170
 171         for _, etype := range []string{"create", "blip", "update"} {
 172                 lg := s.expectLog(c, r)
 173                 c.Check(lg.ObjectUUID, check.Equals, uuid)
 174                 c.Check(lg.EventType, check.Equals, etype)
 175         }
 176 }
 177
 178 // Generate some events by creating and updating a workflow object,
 179 // and creating a custom log entry (event_type="blip") about the newly
 180 // created workflow. If uuidChan is not nil, send the new workflow
 181 // UUID to uuidChan as soon as it's known.
 182 func (s *v0Suite) emitEvents(uuidChan chan<- string) {
 183         ac := arvados.NewClientFromEnv()
 184         ac.AuthToken = s.token
 185         wf := &arvados.Workflow{
 186                 Name: "ws_test",
 187         }
 188         err := ac.RequestAndDecode(wf, "POST", "arvados/v1/workflows", s.jsonBody("workflow", wf), map[string]interface{}{"ensure_unique_name": true})
 189         if err != nil {
 190                 panic(err)
 191         }
 192         if uuidChan != nil {
 193                 uuidChan <- wf.UUID
 194         }
 195         lg := &arvados.Log{}
 196         err = ac.RequestAndDecode(lg, "POST", "arvados/v1/logs", s.jsonBody("log", &arvados.Log{
 197                 ObjectUUID: wf.UUID,
 198                 EventType:  "blip",
 199                 Properties: map[string]interface{}{
 200                         "beep": "boop",
 201                 },
 202         }), nil)
 203         if err != nil {
 204                 panic(err)
 205         }
 206         err = ac.RequestAndDecode(wf, "PUT", "arvados/v1/workflows/"+wf.UUID, s.jsonBody("workflow", wf), nil)
 207         if err != nil {
 208                 panic(err)
 209         }
 210         s.toDelete = append(s.toDelete, "arvados/v1/workflows/"+wf.UUID, "arvados/v1/logs/"+lg.UUID)
 211 }
 212
 213 func (s *v0Suite) jsonBody(rscName string, ob interface{}) io.Reader {
 214         j, err := json.Marshal(ob)
 215         if err != nil {
 216                 panic(err)
 217         }
 218         v := url.Values{}
 219         v[rscName] = []string{string(j)}
 220         return bytes.NewBufferString(v.Encode())
 221 }
 222
 223 func (s *v0Suite) expectStatus(c *check.C, r *json.Decoder, status int) {
 224         msg := map[string]interface{}{}
 225         c.Check(r.Decode(&msg), check.IsNil)
 226         c.Check(int(msg["status"].(float64)), check.Equals, status)
 227 }
 228
 229 func (s *v0Suite) expectLog(c *check.C, r *json.Decoder) *arvados.Log {
 230         lg := &arvados.Log{}
 231         c.Check(r.Decode(lg), check.IsNil)
 232         return lg
 233 }
 234
 235 func (s *v0Suite) testClient() (*server, *websocket.Conn, *json.Decoder, *json.Encoder) {
 236         go s.serverSuite.srv.Run()
 237         s.serverSuite.srv.WaitReady()
 238         srv := s.serverSuite.srv
 239         conn, err := websocket.Dial("ws://"+srv.listener.Addr().String()+"/websocket?api_token="+s.token, "", "http://"+srv.listener.Addr().String())
 240         if err != nil {
 241                 panic(err)
 242         }
 243         w := json.NewEncoder(conn)
 244         r := json.NewDecoder(conn)
 245         return srv, conn, r, w
 246 }