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