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