lib/crunchrun/executor_test.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package crunchrun
   6
   7 import (
   8         "bytes"
   9         "io"
  10         "io/ioutil"
  11         "net/http"
  12         "os"
  13         "strings"
  14         "time"
  15
  16         "golang.org/x/net/context"
  17         . "gopkg.in/check.v1"
  18 )
  19
  20 var _ = Suite(&dockerSuite{})
  21
  22 func busyboxDockerImage(c *C) string {
  23         fnm := "busybox_uclibc.tar"
  24         cachedir := c.MkDir()
  25         cachefile := cachedir + "/" + fnm
  26         if _, err := os.Stat(cachefile); err == nil {
  27                 return cachefile
  28         }
  29
  30         f, err := ioutil.TempFile(cachedir, "")
  31         c.Assert(err, IsNil)
  32         defer f.Close()
  33         defer os.Remove(f.Name())
  34
  35         resp, err := http.Get("http://cache.arvados.org/" + fnm)
  36         c.Assert(err, IsNil)
  37         defer resp.Body.Close()
  38         _, err = io.Copy(f, resp.Body)
  39         c.Assert(err, IsNil)
  40         err = f.Close()
  41         c.Assert(err, IsNil)
  42         err = os.Rename(f.Name(), cachefile)
  43         c.Assert(err, IsNil)
  44
  45         return cachefile
  46 }
  47
  48 type nopWriteCloser struct{ io.Writer }
  49
  50 func (nopWriteCloser) Close() error { return nil }
  51
  52 // embedded by dockerSuite and singularitySuite so they can share
  53 // tests.
  54 type executorSuite struct {
  55         newExecutor func(*C) // embedding struct's SetUpSuite method must set this
  56         executor    containerExecutor
  57         spec        containerSpec
  58         stdout      bytes.Buffer
  59         stderr      bytes.Buffer
  60 }
  61
  62 func (s *executorSuite) SetUpTest(c *C) {
  63         s.newExecutor(c)
  64         s.stdout = bytes.Buffer{}
  65         s.stderr = bytes.Buffer{}
  66         s.spec = containerSpec{
  67                 Image:       "busybox:uclibc",
  68                 VCPUs:       1,
  69                 WorkingDir:  "",
  70                 Env:         map[string]string{"PATH": "/bin:/usr/bin"},
  71                 NetworkMode: "default",
  72                 Stdout:      nopWriteCloser{&s.stdout},
  73                 Stderr:      nopWriteCloser{&s.stderr},
  74         }
  75         err := s.executor.LoadImage(busyboxDockerImage(c))
  76         c.Assert(err, IsNil)
  77 }
  78
  79 func (s *executorSuite) TearDownTest(c *C) {
  80         s.executor.Close()
  81 }
  82
  83 func (s *executorSuite) TestExecTrivialContainer(c *C) {
  84         s.spec.Command = []string{"echo", "ok"}
  85         s.checkRun(c, 0)
  86         c.Check(s.stdout.String(), Equals, "ok\n")
  87         c.Check(s.stderr.String(), Equals, "")
  88 }
  89
  90 func (s *executorSuite) TestExecStop(c *C) {
  91         s.spec.Command = []string{"sh", "-c", "sleep 10; echo ok"}
  92         err := s.executor.Create(s.spec)
  93         c.Assert(err, IsNil)
  94         err = s.executor.Start()
  95         c.Assert(err, IsNil)
  96         go func() {
  97                 time.Sleep(time.Second / 10)
  98                 s.executor.Stop()
  99         }()
 100         ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(10*time.Second))
 101         defer cancel()
 102         code, err := s.executor.Wait(ctx)
 103         c.Check(code, Not(Equals), 0)
 104         c.Check(err, IsNil)
 105         c.Check(s.stdout.String(), Equals, "")
 106         c.Check(s.stderr.String(), Equals, "")
 107 }
 108
 109 func (s *executorSuite) TestExecCleanEnv(c *C) {
 110         s.spec.Command = []string{"env"}
 111         s.checkRun(c, 0)
 112         c.Check(s.stderr.String(), Equals, "")
 113         got := map[string]string{}
 114         for _, kv := range strings.Split(s.stdout.String(), "\n") {
 115                 if kv == "" {
 116                         continue
 117                 }
 118                 kv := strings.SplitN(kv, "=", 2)
 119                 switch kv[0] {
 120                 case "HOSTNAME", "HOME":
 121                         // docker sets these by itself
 122                 case "LD_LIBRARY_PATH", "SINGULARITY_NAME", "PWD", "LANG", "SHLVL", "SINGULARITY_INIT", "SINGULARITY_CONTAINER":
 123                         // singularity sets these by itself (cf. https://sylabs.io/guides/3.5/user-guide/environment_and_metadata.html)
 124                 case "PROMPT_COMMAND", "PS1", "SINGULARITY_APPNAME":
 125                         // singularity also sets these by itself (as of v3.5.2)
 126                 default:
 127                         got[kv[0]] = kv[1]
 128                 }
 129         }
 130         c.Check(got, DeepEquals, s.spec.Env)
 131 }
 132 func (s *executorSuite) TestExecEnableNetwork(c *C) {
 133         for _, enable := range []bool{false, true} {
 134                 s.SetUpTest(c)
 135                 s.spec.Command = []string{"ip", "route"}
 136                 s.spec.EnableNetwork = enable
 137                 s.checkRun(c, 0)
 138                 if enable {
 139                         c.Check(s.stdout.String(), Matches, "(?ms).*default via.*")
 140                 } else {
 141                         c.Check(s.stdout.String(), Equals, "")
 142                 }
 143         }
 144 }
 145
 146 func (s *executorSuite) TestExecStdoutStderr(c *C) {
 147         s.spec.Command = []string{"sh", "-c", "echo foo; echo -n bar >&2; echo baz; echo waz >&2"}
 148         s.checkRun(c, 0)
 149         c.Check(s.stdout.String(), Equals, "foo\nbaz\n")
 150         c.Check(s.stderr.String(), Equals, "barwaz\n")
 151 }
 152
 153 func (s *executorSuite) checkRun(c *C, expectCode int) {
 154         c.Assert(s.executor.Create(s.spec), IsNil)
 155         c.Assert(s.executor.Start(), IsNil)
 156         ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(10*time.Second))
 157         defer cancel()
 158         code, err := s.executor.Wait(ctx)
 159         c.Assert(err, IsNil)
 160         c.Check(code, Equals, expectCode)
 161 }