services/crunch-dispatch-local/crunch-dispatch-local_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         "context"
  10         "io"
  11         "net/http"
  12         "net/http/httptest"
  13         "os"
  14         "os/exec"
  15         "regexp"
  16         "testing"
  17         "time"
  18
  19         "git.arvados.org/arvados.git/sdk/go/arvados"
  20         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
  21         "git.arvados.org/arvados.git/sdk/go/arvadostest"
  22         "git.arvados.org/arvados.git/sdk/go/dispatch"
  23         "github.com/sirupsen/logrus"
  24         . "gopkg.in/check.v1"
  25 )
  26
  27 // Gocheck boilerplate
  28 func Test(t *testing.T) {
  29         TestingT(t)
  30 }
  31
  32 var _ = Suite(&TestSuite{})
  33 var _ = Suite(&MockArvadosServerSuite{})
  34
  35 type TestSuite struct{}
  36 type MockArvadosServerSuite struct{}
  37
  38 var initialArgs []string
  39
  40 func (s *TestSuite) SetUpSuite(c *C) {
  41         initialArgs = os.Args
  42         arvadostest.StartAPI()
  43         runningCmds = make(map[string]*exec.Cmd)
  44         logrus.SetFormatter(&logrus.TextFormatter{DisableColors: true})
  45 }
  46
  47 func (s *TestSuite) TearDownSuite(c *C) {
  48         arvadostest.StopAPI()
  49 }
  50
  51 func (s *TestSuite) SetUpTest(c *C) {
  52         args := []string{"crunch-dispatch-local"}
  53         os.Args = args
  54 }
  55
  56 func (s *TestSuite) TearDownTest(c *C) {
  57         arvadostest.ResetEnv()
  58         os.Args = initialArgs
  59 }
  60
  61 func (s *MockArvadosServerSuite) TearDownTest(c *C) {
  62         arvadostest.ResetEnv()
  63 }
  64
  65 func (s *TestSuite) TestIntegration(c *C) {
  66         arv, err := arvadosclient.MakeArvadosClient()
  67         c.Assert(err, IsNil)
  68
  69         echo := "echo"
  70         crunchRunCommand = &echo
  71
  72         ctx, cancel := context.WithCancel(context.Background())
  73         dispatcher := dispatch.Dispatcher{
  74                 Arv:        arv,
  75                 PollPeriod: time.Second,
  76         }
  77
  78         startCmd := func(container arvados.Container, cmd *exec.Cmd) error {
  79                 dispatcher.UpdateState(container.UUID, "Running")
  80                 dispatcher.UpdateState(container.UUID, "Complete")
  81                 return cmd.Start()
  82         }
  83
  84         cl := arvados.Cluster{Containers: arvados.ContainersConfig{RuntimeEngine: "docker"}}
  85
  86         dispatcher.RunContainer = func(d *dispatch.Dispatcher, c arvados.Container, s <-chan arvados.Container) {
  87                 (&LocalRun{startCmd, make(chan bool, 8), ctx, &cl}).run(d, c, s)
  88                 cancel()
  89         }
  90
  91         err = dispatcher.Run(ctx)
  92         c.Assert(err, Equals, context.Canceled)
  93
  94         // Wait for all running crunch jobs to complete / terminate
  95         waitGroup.Wait()
  96
  97         // There should be no queued containers now
  98         params := arvadosclient.Dict{
  99                 "filters": [][]string{{"state", "=", "Queued"}},
 100         }
 101         var containers arvados.ContainerList
 102         err = arv.List("containers", params, &containers)
 103         c.Check(err, IsNil)
 104         c.Assert(len(containers.Items), Equals, 0)
 105
 106         // Previously "Queued" container should now be in "Complete" state
 107         var container arvados.Container
 108         err = arv.Get("containers", "zzzzz-dz642-queuedcontainer", nil, &container)
 109         c.Check(err, IsNil)
 110         c.Check(string(container.State), Equals, "Complete")
 111 }
 112
 113 func (s *MockArvadosServerSuite) Test_APIErrorGettingContainers(c *C) {
 114         apiStubResponses := make(map[string]arvadostest.StubResponse)
 115         apiStubResponses["/arvados/v1/containers"] = arvadostest.StubResponse{500, string(`{}`)}
 116
 117         testWithServerStub(c, apiStubResponses, "echo", "error getting count of containers")
 118 }
 119
 120 func (s *MockArvadosServerSuite) Test_APIErrorUpdatingContainerState(c *C) {
 121         apiStubResponses := make(map[string]arvadostest.StubResponse)
 122         apiStubResponses["/arvados/v1/containers"] =
 123                 arvadostest.StubResponse{200, string(`{"items_available":1, "items":[{"uuid":"zzzzz-dz642-xxxxxxxxxxxxxx1","State":"Queued","Priority":1}]}`)}
 124         apiStubResponses["/arvados/v1/containers/zzzzz-dz642-xxxxxxxxxxxxxx1"] =
 125                 arvadostest.StubResponse{500, string(`{}`)}
 126
 127         testWithServerStub(c, apiStubResponses, "echo", "error locking container zzzzz-dz642-xxxxxxxxxxxxxx1")
 128 }
 129
 130 func (s *MockArvadosServerSuite) Test_ContainerStillInRunningAfterRun(c *C) {
 131         apiStubResponses := make(map[string]arvadostest.StubResponse)
 132         apiStubResponses["/arvados/v1/containers"] =
 133                 arvadostest.StubResponse{200, string(`{"items_available":1, "items":[{"uuid":"zzzzz-dz642-xxxxxxxxxxxxxx2","State":"Queued","Priority":1}]}`)}
 134         apiStubResponses["/arvados/v1/containers/zzzzz-dz642-xxxxxxxxxxxxxx2/lock"] =
 135                 arvadostest.StubResponse{200, string(`{"uuid":"zzzzz-dz642-xxxxxxxxxxxxxx2", "state":"Locked", "priority":1, "locked_by_uuid": "` + arvadostest.Dispatch1AuthUUID + `"}`)}
 136         apiStubResponses["/arvados/v1/containers/zzzzz-dz642-xxxxxxxxxxxxxx2"] =
 137                 arvadostest.StubResponse{200, string(`{"uuid":"zzzzz-dz642-xxxxxxxxxxxxxx2", "state":"Running", "priority":1, "locked_by_uuid": "` + arvadostest.Dispatch1AuthUUID + `"}`)}
 138
 139         testWithServerStub(c, apiStubResponses, "echo",
 140                 `after \\"echo\\" process termination, container state for zzzzz-dz642-xxxxxxxxxxxxxx2 is \\"Running\\"; updating it to \\"Cancelled\\"`)
 141 }
 142
 143 func (s *MockArvadosServerSuite) Test_ErrorRunningContainer(c *C) {
 144         apiStubResponses := make(map[string]arvadostest.StubResponse)
 145         apiStubResponses["/arvados/v1/containers"] =
 146                 arvadostest.StubResponse{200, string(`{"items_available":1, "items":[{"uuid":"zzzzz-dz642-xxxxxxxxxxxxxx3","State":"Queued","Priority":1}]}`)}
 147
 148         apiStubResponses["/arvados/v1/containers/zzzzz-dz642-xxxxxxxxxxxxxx3/lock"] =
 149                 arvadostest.StubResponse{200, string(`{"uuid":"zzzzz-dz642-xxxxxxxxxxxxxx3", "state":"Locked", "priority":1}`)}
 150
 151         testWithServerStub(c, apiStubResponses, "nosuchcommand", `error starting \\"nosuchcommand\\" for zzzzz-dz642-xxxxxxxxxxxxxx3`)
 152 }
 153
 154 func testWithServerStub(c *C, apiStubResponses map[string]arvadostest.StubResponse, crunchCmd string, expected string) {
 155         apiStubResponses["/arvados/v1/api_client_authorizations/current"] =
 156                 arvadostest.StubResponse{200, string(`{"uuid": "` + arvadostest.Dispatch1AuthUUID + `", "api_token": "xyz"}`)}
 157
 158         apiStub := arvadostest.ServerStub{apiStubResponses}
 159
 160         api := httptest.NewServer(&apiStub)
 161         defer api.Close()
 162
 163         arv := &arvadosclient.ArvadosClient{
 164                 Scheme:    "http",
 165                 ApiServer: api.URL[7:],
 166                 ApiToken:  "abc123",
 167                 Client:    &http.Client{Transport: &http.Transport{}},
 168                 Retries:   0,
 169         }
 170
 171         buf := bytes.NewBuffer(nil)
 172         logrus.SetOutput(io.MultiWriter(buf, os.Stderr))
 173         defer logrus.SetOutput(os.Stderr)
 174
 175         *crunchRunCommand = crunchCmd
 176
 177         ctx, cancel := context.WithCancel(context.Background())
 178         dispatcher := dispatch.Dispatcher{
 179                 Arv:        arv,
 180                 PollPeriod: time.Second / 20,
 181         }
 182
 183         startCmd := func(container arvados.Container, cmd *exec.Cmd) error {
 184                 dispatcher.UpdateState(container.UUID, "Running")
 185                 dispatcher.UpdateState(container.UUID, "Complete")
 186                 return cmd.Start()
 187         }
 188
 189         cl := arvados.Cluster{Containers: arvados.ContainersConfig{RuntimeEngine: "docker"}}
 190
 191         dispatcher.RunContainer = func(d *dispatch.Dispatcher, c arvados.Container, s <-chan arvados.Container) {
 192                 (&LocalRun{startCmd, make(chan bool, 8), ctx, &cl}).run(d, c, s)
 193                 cancel()
 194         }
 195
 196         re := regexp.MustCompile(`(?ms).*` + expected + `.*`)
 197         go func() {
 198                 for i := 0; i < 80 && !re.MatchString(buf.String()); i++ {
 199                         time.Sleep(100 * time.Millisecond)
 200                 }
 201                 cancel()
 202         }()
 203
 204         err := dispatcher.Run(ctx)
 205         c.Assert(err, Equals, context.Canceled)
 206
 207         // Wait for all running crunch jobs to complete / terminate
 208         waitGroup.Wait()
 209
 210         c.Check(buf.String(), Matches, `(?ms).*`+expected+`.*`)
 211 }