9 "git.curoverse.com/arvados.git/sdk/go/arvadosclient"
10 "git.curoverse.com/arvados.git/sdk/go/keepclient"
11 "git.curoverse.com/arvados.git/sdk/go/manifest"
12 "github.com/curoverse/dockerclient"
24 // Gocheck boilerplate
25 func TestCrunchExec(t *testing.T) {
29 type TestSuite struct{}
31 // Gocheck boilerplate
32 var _ = Suite(&TestSuite{})
34 type ArvTestClient struct {
37 Content arvadosclient.Dict
39 Logs map[string]*bytes.Buffer
43 type KeepTestClient struct {
48 var hwManifest = ". 82ab40c24fc8df01798e57ba66795bb1+841216+Aa124ac75e5168396c73c0a18eda641a4f41791c0@569fa8c3 0:841216:9c31ee32b3d15268a0754e8edc74d4f815ee014b693bc5109058e431dd5caea7.tar\n"
49 var hwPDH = "a45557269dcb65a6b78f9ac061c0850b+120"
50 var hwImageId = "9c31ee32b3d15268a0754e8edc74d4f815ee014b693bc5109058e431dd5caea7"
52 var otherManifest = ". 68a84f561b1d1708c6baff5e019a9ab3+46+Ae5d0af96944a3690becb1decdf60cc1c937f556d@5693216f 0:46:md5sum.txt\n"
53 var otherPDH = "a3e8f74c6f101eae01fa08bfb4e49b3a+54"
55 type TestDockerClient struct {
57 stdoutReader io.ReadCloser
58 stderrReader io.ReadCloser
59 stdoutWriter io.WriteCloser
60 stderrWriter io.WriteCloser
61 fn func(t *TestDockerClient)
62 finish chan dockerclient.WaitResult
68 func NewTestDockerClient() *TestDockerClient {
69 t := &TestDockerClient{}
70 t.stdoutReader, t.stdoutWriter = io.Pipe()
71 t.stderrReader, t.stderrWriter = io.Pipe()
72 t.finish = make(chan dockerclient.WaitResult)
73 t.stop = make(chan bool)
78 func (t *TestDockerClient) StopContainer(id string, timeout int) error {
83 func (t *TestDockerClient) InspectImage(id string) (*dockerclient.ImageInfo, error) {
84 if t.imageLoaded == id {
85 return &dockerclient.ImageInfo{}, nil
87 return nil, errors.New("")
91 func (t *TestDockerClient) LoadImage(reader io.Reader) error {
92 _, err := io.Copy(ioutil.Discard, reader)
96 t.imageLoaded = hwImageId
101 func (t *TestDockerClient) CreateContainer(config *dockerclient.ContainerConfig, name string, authConfig *dockerclient.AuthConfig) (string, error) {
102 if config.WorkingDir != "" {
103 t.cwd = config.WorkingDir
109 func (t *TestDockerClient) StartContainer(id string, config *dockerclient.HostConfig) error {
114 return errors.New("Invalid container id")
118 func (t *TestDockerClient) ContainerLogs(id string, options *dockerclient.LogOptions) (io.ReadCloser, error) {
120 return t.stdoutReader, nil
123 return t.stderrReader, nil
128 func (t *TestDockerClient) Wait(id string) <-chan dockerclient.WaitResult {
132 func (*TestDockerClient) RemoveImage(name string, force bool) ([]*dockerclient.ImageDelete, error) {
136 func (this *ArvTestClient) Create(resourceType string,
137 parameters arvadosclient.Dict,
138 output interface{}) error {
141 this.Content = parameters
143 if resourceType == "logs" {
144 et := parameters["log"].(arvadosclient.Dict)["event_type"].(string)
145 if this.Logs == nil {
146 this.Logs = make(map[string]*bytes.Buffer)
148 if this.Logs[et] == nil {
149 this.Logs[et] = &bytes.Buffer{}
151 this.Logs[et].Write([]byte(parameters["log"].(arvadosclient.Dict)["properties"].(map[string]string)["text"]))
154 if resourceType == "collections" && output != nil {
155 mt := parameters["collection"].(arvadosclient.Dict)["manifest_text"].(string)
156 outmap := output.(*CollectionRecord)
157 outmap.PortableDataHash = fmt.Sprintf("%x+%d", md5.Sum([]byte(mt)), len(mt))
163 func (this *ArvTestClient) Get(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error {
164 if resourceType == "collections" {
166 output.(*CollectionRecord).ManifestText = hwManifest
167 } else if uuid == otherPDH {
168 output.(*CollectionRecord).ManifestText = otherManifest
171 if resourceType == "containers" {
172 (*output.(*ContainerRecord)) = this.ContainerRecord
177 func (this *ArvTestClient) Update(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) (err error) {
179 this.Content = parameters
180 if resourceType == "containers" {
181 if parameters["container"].(arvadosclient.Dict)["state"] == "Running" {
182 this.WasSetRunning = true
189 func (this *KeepTestClient) PutHB(hash string, buf []byte) (string, int, error) {
191 return fmt.Sprintf("%s+%d", hash, len(buf)), len(buf), nil
194 type FileWrapper struct {
199 func (this FileWrapper) Len() uint64 {
203 func (this *KeepTestClient) ManifestFileReader(m manifest.Manifest, filename string) (keepclient.ReadCloserWithLen, error) {
204 if filename == hwImageId+".tar" {
205 rdr := ioutil.NopCloser(&bytes.Buffer{})
207 return FileWrapper{rdr, 1321984}, nil
212 func (s *TestSuite) TestLoadImage(c *C) {
213 kc := &KeepTestClient{}
214 docker := NewTestDockerClient()
215 cr := NewContainerRunner(&ArvTestClient{}, kc, docker, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
217 _, err := cr.Docker.RemoveImage(hwImageId, true)
219 _, err = cr.Docker.InspectImage(hwImageId)
222 cr.ContainerRecord.ContainerImage = hwPDH
224 // (1) Test loading image from keep
225 c.Check(kc.Called, Equals, false)
226 c.Check(cr.ContainerConfig.Image, Equals, "")
232 cr.Docker.RemoveImage(hwImageId, true)
235 c.Check(kc.Called, Equals, true)
236 c.Check(cr.ContainerConfig.Image, Equals, hwImageId)
238 _, err = cr.Docker.InspectImage(hwImageId)
241 // (2) Test using image that's already loaded
243 cr.ContainerConfig.Image = ""
247 c.Check(kc.Called, Equals, false)
248 c.Check(cr.ContainerConfig.Image, Equals, hwImageId)
252 type ArvErrorTestClient struct{}
253 type KeepErrorTestClient struct{}
254 type KeepReadErrorTestClient struct{}
256 func (this ArvErrorTestClient) Create(resourceType string,
257 parameters arvadosclient.Dict,
258 output interface{}) error {
262 func (this ArvErrorTestClient) Get(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error {
263 return errors.New("ArvError")
266 func (this ArvErrorTestClient) Update(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) (err error) {
270 func (this KeepErrorTestClient) PutHB(hash string, buf []byte) (string, int, error) {
271 return "", 0, errors.New("KeepError")
274 func (this KeepErrorTestClient) ManifestFileReader(m manifest.Manifest, filename string) (keepclient.ReadCloserWithLen, error) {
275 return nil, errors.New("KeepError")
278 func (this KeepReadErrorTestClient) PutHB(hash string, buf []byte) (string, int, error) {
282 type ErrorReader struct{}
284 func (this ErrorReader) Read(p []byte) (n int, err error) {
285 return 0, errors.New("ErrorReader")
288 func (this ErrorReader) Close() error {
292 func (this ErrorReader) Len() uint64 {
296 func (this KeepReadErrorTestClient) ManifestFileReader(m manifest.Manifest, filename string) (keepclient.ReadCloserWithLen, error) {
297 return ErrorReader{}, nil
300 func (s *TestSuite) TestLoadImageArvError(c *C) {
302 cr := NewContainerRunner(ArvErrorTestClient{}, &KeepTestClient{}, nil, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
303 cr.ContainerRecord.ContainerImage = hwPDH
305 err := cr.LoadImage()
306 c.Check(err.Error(), Equals, "While getting container image collection: ArvError")
309 func (s *TestSuite) TestLoadImageKeepError(c *C) {
311 docker := NewTestDockerClient()
312 cr := NewContainerRunner(&ArvTestClient{}, KeepErrorTestClient{}, docker, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
313 cr.ContainerRecord.ContainerImage = hwPDH
315 err := cr.LoadImage()
316 c.Check(err.Error(), Equals, "While creating ManifestFileReader for container image: KeepError")
319 func (s *TestSuite) TestLoadImageCollectionError(c *C) {
320 // (3) Collection doesn't contain image
321 cr := NewContainerRunner(&ArvTestClient{}, KeepErrorTestClient{}, nil, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
322 cr.ContainerRecord.ContainerImage = otherPDH
324 err := cr.LoadImage()
325 c.Check(err.Error(), Equals, "First file in the container image collection does not end in .tar")
328 func (s *TestSuite) TestLoadImageKeepReadError(c *C) {
329 // (4) Collection doesn't contain image
330 docker := NewTestDockerClient()
331 cr := NewContainerRunner(&ArvTestClient{}, KeepReadErrorTestClient{}, docker, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
332 cr.ContainerRecord.ContainerImage = hwPDH
334 err := cr.LoadImage()
338 type ClosableBuffer struct {
342 type TestLogs struct {
343 Stdout ClosableBuffer
344 Stderr ClosableBuffer
347 func (this *ClosableBuffer) Close() error {
351 func (this *TestLogs) NewTestLoggingWriter(logstr string) io.WriteCloser {
352 if logstr == "stdout" {
355 if logstr == "stderr" {
361 func (s *TestSuite) TestRunContainer(c *C) {
362 docker := NewTestDockerClient()
363 docker.fn = func(t *TestDockerClient) {
364 t.stdoutWriter.Write([]byte("Hello world\n"))
365 t.stdoutWriter.Close()
366 t.stderrWriter.Close()
367 t.finish <- dockerclient.WaitResult{}
369 cr := NewContainerRunner(&ArvTestClient{}, &KeepTestClient{}, docker, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
372 cr.NewLogWriter = logs.NewTestLoggingWriter
373 cr.ContainerRecord.ContainerImage = hwPDH
374 cr.ContainerRecord.Command = []string{"./hw"}
375 err := cr.LoadImage()
378 err = cr.StartContainer()
381 err = cr.AttachLogs()
384 err = cr.WaitFinish()
387 c.Check(strings.HasSuffix(logs.Stdout.String(), "Hello world\n"), Equals, true)
388 c.Check(logs.Stderr.String(), Equals, "")
391 func (s *TestSuite) TestCommitLogs(c *C) {
392 api := &ArvTestClient{}
393 kc := &KeepTestClient{}
394 cr := NewContainerRunner(api, kc, nil, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
395 cr.CrunchLog.Timestamper = (&TestTimestamper{}).Timestamp
397 cr.CrunchLog.Print("Hello world!")
398 cr.CrunchLog.Print("Goodbye")
399 cr.finalState = "Complete"
401 err := cr.CommitLogs()
404 c.Check(api.Content["collection"].(arvadosclient.Dict)["name"], Equals, "logs for zzzzz-zzzzz-zzzzzzzzzzzzzzz")
405 c.Check(api.Content["collection"].(arvadosclient.Dict)["manifest_text"], Equals, ". 744b2e4553123b02fa7b452ec5c18993+123 0:123:crunch-run.txt\n")
406 c.Check(*cr.LogsPDH, Equals, "63da7bdacf08c40f604daad80c261e9a+60")
409 func (s *TestSuite) TestUpdateContainerRecordRunning(c *C) {
410 api := &ArvTestClient{}
411 kc := &KeepTestClient{}
412 cr := NewContainerRunner(api, kc, nil, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
414 err := cr.UpdateContainerRecordRunning()
417 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Running")
420 func (s *TestSuite) TestUpdateContainerRecordComplete(c *C) {
421 api := &ArvTestClient{}
422 kc := &KeepTestClient{}
423 cr := NewContainerRunner(api, kc, nil, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
425 cr.LogsPDH = new(string)
426 *cr.LogsPDH = "d3a229d2fe3690c2c3e75a71a153c6a3+60"
428 cr.ExitCode = new(int)
430 cr.finalState = "Complete"
432 err := cr.UpdateContainerRecordComplete()
435 c.Check(api.Content["container"].(arvadosclient.Dict)["log"], Equals, *cr.LogsPDH)
436 c.Check(api.Content["container"].(arvadosclient.Dict)["exit_code"], Equals, *cr.ExitCode)
437 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Complete")
440 func (s *TestSuite) TestUpdateContainerRecordCancelled(c *C) {
441 api := &ArvTestClient{}
442 kc := &KeepTestClient{}
443 cr := NewContainerRunner(api, kc, nil, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
445 cr.finalState = "Cancelled"
447 err := cr.UpdateContainerRecordComplete()
450 c.Check(api.Content["container"].(arvadosclient.Dict)["log"], IsNil)
451 c.Check(api.Content["container"].(arvadosclient.Dict)["exit_code"], IsNil)
452 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Cancelled")
455 // Used by the TestFullRun*() test below to DRY up boilerplate setup to do full
456 // dress rehersal of the Run() function, starting from a JSON container record.
457 func FullRunHelper(c *C, record string, fn func(t *TestDockerClient)) (api *ArvTestClient, cr *ContainerRunner) {
458 rec := ContainerRecord{}
459 err := json.NewDecoder(strings.NewReader(record)).Decode(&rec)
462 docker := NewTestDockerClient()
464 docker.RemoveImage(hwImageId, true)
466 api = &ArvTestClient{ContainerRecord: rec}
467 cr = NewContainerRunner(api, &KeepTestClient{}, docker, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
471 c.Check(api.WasSetRunning, Equals, true)
473 c.Check(api.Content["container"].(arvadosclient.Dict)["log"], NotNil)
476 for k, v := range api.Logs {
485 func (s *TestSuite) TestFullRunHello(c *C) {
486 api, _ := FullRunHelper(c, `{
487 "command": ["echo", "hello world"],
488 "container_image": "d4ab34d3d4f8a72f5c4973051ae69fab+122",
491 "mounts": {"/tmp": {"kind": "tmp"} },
492 "output_path": "/tmp",
494 "runtime_constraints": {}
495 }`, func(t *TestDockerClient) {
496 t.stdoutWriter.Write([]byte("hello world\n"))
497 t.stdoutWriter.Close()
498 t.stderrWriter.Close()
499 t.finish <- dockerclient.WaitResult{}
502 c.Check(api.Content["container"].(arvadosclient.Dict)["exit_code"], Equals, 0)
503 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Complete")
505 c.Check(strings.HasSuffix(api.Logs["stdout"].String(), "hello world\n"), Equals, true)
509 func (s *TestSuite) TestFullRunStderr(c *C) {
510 api, _ := FullRunHelper(c, `{
511 "command": ["/bin/sh", "-c", "echo hello ; echo world 1>&2 ; exit 1"],
512 "container_image": "d4ab34d3d4f8a72f5c4973051ae69fab+122",
515 "mounts": {"/tmp": {"kind": "tmp"} },
516 "output_path": "/tmp",
518 "runtime_constraints": {}
519 }`, func(t *TestDockerClient) {
520 t.stdoutWriter.Write([]byte("hello\n"))
521 t.stderrWriter.Write([]byte("world\n"))
522 t.stdoutWriter.Close()
523 t.stderrWriter.Close()
524 t.finish <- dockerclient.WaitResult{ExitCode: 1}
527 c.Check(api.Content["container"].(arvadosclient.Dict)["log"], NotNil)
528 c.Check(api.Content["container"].(arvadosclient.Dict)["exit_code"], Equals, 1)
529 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Complete")
531 c.Check(strings.HasSuffix(api.Logs["stdout"].String(), "hello\n"), Equals, true)
532 c.Check(strings.HasSuffix(api.Logs["stderr"].String(), "world\n"), Equals, true)
535 func (s *TestSuite) TestFullRunDefaultCwd(c *C) {
536 api, _ := FullRunHelper(c, `{
538 "container_image": "d4ab34d3d4f8a72f5c4973051ae69fab+122",
541 "mounts": {"/tmp": {"kind": "tmp"} },
542 "output_path": "/tmp",
544 "runtime_constraints": {}
545 }`, func(t *TestDockerClient) {
546 t.stdoutWriter.Write([]byte(t.cwd + "\n"))
547 t.stdoutWriter.Close()
548 t.stderrWriter.Close()
549 t.finish <- dockerclient.WaitResult{ExitCode: 0}
552 c.Check(api.Content["container"].(arvadosclient.Dict)["exit_code"], Equals, 0)
553 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Complete")
555 c.Check(strings.HasSuffix(api.Logs["stdout"].String(), "/\n"), Equals, true)
558 func (s *TestSuite) TestFullRunSetCwd(c *C) {
559 api, _ := FullRunHelper(c, `{
561 "container_image": "d4ab34d3d4f8a72f5c4973051ae69fab+122",
564 "mounts": {"/tmp": {"kind": "tmp"} },
565 "output_path": "/tmp",
567 "runtime_constraints": {}
568 }`, func(t *TestDockerClient) {
569 t.stdoutWriter.Write([]byte(t.cwd + "\n"))
570 t.stdoutWriter.Close()
571 t.stderrWriter.Close()
572 t.finish <- dockerclient.WaitResult{ExitCode: 0}
575 c.Check(api.Content["container"].(arvadosclient.Dict)["exit_code"], Equals, 0)
576 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Complete")
578 c.Check(strings.HasSuffix(api.Logs["stdout"].String(), "/bin\n"), Equals, true)
581 func (s *TestSuite) TestCancel(c *C) {
583 "command": ["/bin/sh", "-c", "echo foo && sleep 30 && echo bar"],
584 "container_image": "d4ab34d3d4f8a72f5c4973051ae69fab+122",
587 "mounts": {"/tmp": {"kind": "tmp"} },
588 "output_path": "/tmp",
590 "runtime_constraints": {}
593 rec := ContainerRecord{}
594 err := json.NewDecoder(strings.NewReader(record)).Decode(&rec)
597 docker := NewTestDockerClient()
598 docker.fn = func(t *TestDockerClient) {
600 t.stdoutWriter.Write([]byte("foo\n"))
601 t.stdoutWriter.Close()
602 t.stderrWriter.Close()
603 t.finish <- dockerclient.WaitResult{ExitCode: 0}
605 docker.RemoveImage(hwImageId, true)
607 api := &ArvTestClient{ContainerRecord: rec}
608 cr := NewContainerRunner(api, &KeepTestClient{}, docker, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
611 for cr.ContainerID == "" {
612 time.Sleep(1 * time.Second)
614 cr.SigChan <- syscall.SIGINT
621 c.Check(api.Content["container"].(arvadosclient.Dict)["log"], NotNil)
624 for k, v := range api.Logs {
630 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Cancelled")
632 c.Check(strings.HasSuffix(api.Logs["stdout"].String(), "foo\n"), Equals, true)
636 func (s *TestSuite) TestFullRunSetEnv(c *C) {
637 api, _ := FullRunHelper(c, `{
638 "command": ["/bin/sh", "-c", "echo $FROBIZ"],
639 "container_image": "d4ab34d3d4f8a72f5c4973051ae69fab+122",
641 "environment": {"FROBIZ": "bilbo"},
642 "mounts": {"/tmp": {"kind": "tmp"} },
643 "output_path": "/tmp",
645 "runtime_constraints": {}
646 }`, func(t *TestDockerClient) {
647 t.stdoutWriter.Write([]byte(t.env[0][7:] + "\n"))
648 t.stdoutWriter.Close()
649 t.stderrWriter.Close()
650 t.finish <- dockerclient.WaitResult{ExitCode: 0}
653 c.Check(api.Content["container"].(arvadosclient.Dict)["exit_code"], Equals, 0)
654 c.Check(api.Content["container"].(arvadosclient.Dict)["state"], Equals, "Complete")
656 c.Check(strings.HasSuffix(api.Logs["stdout"].String(), "bilbo\n"), Equals, true)
659 type ArvMountCmdLine struct {
663 func (am *ArvMountCmdLine) ArvMountTest(c []string) (*exec.Cmd, error) {
668 func (s *TestSuite) TestSetupMounts(c *C) {
669 api := &ArvTestClient{}
670 kc := &KeepTestClient{}
671 cr := NewContainerRunner(api, kc, nil, "zzzzz-zzzzz-zzzzzzzzzzzzzzz")
672 am := &ArvMountCmdLine{}
673 cr.RunArvMount = am.ArvMountTest
676 cr.MkTempDir = func(string, string) (string, error) {
678 return fmt.Sprintf("/tmp/mktmpdir%d", i), nil
681 cr.ContainerRecord.Mounts = make(map[string]Mount)
682 cr.ContainerRecord.Mounts["/tmp"] = Mount{Kind: "tmp"}
683 cr.OutputPath = "/tmp"
685 err := cr.SetupMounts()
687 c.Check(am.Cmd, DeepEquals, []string{"--foreground", "--mount-by-pdh", "by_id", "/tmp/mktmpdir1"})
688 c.Check(cr.Binds, DeepEquals, []string{"/tmp/mktmpdir2:/tmp"})
691 cr.ContainerRecord.Mounts = make(map[string]Mount)
692 cr.ContainerRecord.Mounts["/keeptmp"] = Mount{Kind: "collection", Writable: true}
693 cr.OutputPath = "/keeptmp"
695 os.MkdirAll("/tmp/mktmpdir1/tmp0", os.ModePerm)
697 err = cr.SetupMounts()
699 c.Check(am.Cmd, DeepEquals, []string{"--foreground", "--mount-tmp", "tmp0", "--mount-by-pdh", "by_id", "/tmp/mktmpdir1"})
700 c.Check(cr.Binds, DeepEquals, []string{"/tmp/mktmpdir1/tmp0:/keeptmp"})
703 cr.ContainerRecord.Mounts = make(map[string]Mount)
704 cr.ContainerRecord.Mounts["/keepinp"] = Mount{Kind: "collection", PortableDataHash: "59389a8f9ee9d399be35462a0f92541c+53"}
705 cr.ContainerRecord.Mounts["/keeptmp"] = Mount{Kind: "collection", Writable: true}
706 cr.OutputPath = "/keeptmp"
708 os.MkdirAll("/tmp/mktmpdir1/by_id/59389a8f9ee9d399be35462a0f92541c+53", os.ModePerm)
710 err = cr.SetupMounts()
712 c.Check(am.Cmd, DeepEquals, []string{"--foreground", "--mount-tmp", "tmp0", "--mount-by-pdh", "by_id", "/tmp/mktmpdir1"})
713 c.Check(cr.Binds, DeepEquals, []string{"/tmp/mktmpdir1/by_id/59389a8f9ee9d399be35462a0f92541c+53:/keepinp:ro", "/tmp/mktmpdir1/tmp0:/keeptmp"})