17296: Skip integration tests if docker is not installed.
[arvados.git] / lib / crunchrun / integration_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         "fmt"
10         "io"
11         "io/ioutil"
12         "os"
13         "os/exec"
14         "strings"
15
16         "git.arvados.org/arvados.git/sdk/go/arvados"
17         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
18         "git.arvados.org/arvados.git/sdk/go/arvadostest"
19         "git.arvados.org/arvados.git/sdk/go/keepclient"
20         . "gopkg.in/check.v1"
21 )
22
23 var _ = Suite(&integrationSuite{})
24
25 type integrationSuite struct {
26         engine string
27         image  arvados.Collection
28         input  arvados.Collection
29         stdin  bytes.Buffer
30         stdout bytes.Buffer
31         stderr bytes.Buffer
32         cr     arvados.ContainerRequest
33         client *arvados.Client
34         ac     *arvadosclient.ArvadosClient
35         kc     *keepclient.KeepClient
36 }
37
38 func (s *integrationSuite) SetUpSuite(c *C) {
39         _, err := exec.LookPath("docker")
40         if err != nil {
41                 c.Skip("looks like docker is not installed")
42         }
43
44         arvadostest.StartKeep(2, true)
45
46         out, err := exec.Command("docker", "load", "--input", busyboxDockerImage(c)).CombinedOutput()
47         c.Log(string(out))
48         c.Assert(err, IsNil)
49         out, err = exec.Command("arv-keepdocker", "--no-resume", "busybox:uclibc").Output()
50         imageUUID := strings.TrimSpace(string(out))
51         c.Logf("image uuid %s", imageUUID)
52         c.Assert(err, IsNil)
53         err = arvados.NewClientFromEnv().RequestAndDecode(&s.image, "GET", "arvados/v1/collections/"+imageUUID, nil, nil)
54         c.Assert(err, IsNil)
55         c.Logf("image pdh %s", s.image.PortableDataHash)
56
57         s.client = arvados.NewClientFromEnv()
58         s.ac, err = arvadosclient.New(s.client)
59         c.Assert(err, IsNil)
60         s.kc = keepclient.New(s.ac)
61         fs, err := s.input.FileSystem(s.client, s.kc)
62         c.Assert(err, IsNil)
63         f, err := fs.OpenFile("inputfile", os.O_CREATE|os.O_WRONLY, 0755)
64         c.Assert(err, IsNil)
65         _, err = f.Write([]byte("inputdata"))
66         c.Assert(err, IsNil)
67         err = f.Close()
68         c.Assert(err, IsNil)
69         s.input.ManifestText, err = fs.MarshalManifest(".")
70         c.Assert(err, IsNil)
71         err = s.client.RequestAndDecode(&s.input, "POST", "arvados/v1/collections", nil, map[string]interface{}{
72                 "ensure_unique_name": true,
73                 "collection": map[string]interface{}{
74                         "manifest_text": s.input.ManifestText,
75                 },
76         })
77         c.Assert(err, IsNil)
78         c.Logf("input pdh %s", s.input.PortableDataHash)
79 }
80
81 func (s *integrationSuite) TearDownSuite(c *C) {
82         err := s.client.RequestAndDecode(nil, "POST", "database/reset", nil, nil)
83         c.Check(err, IsNil)
84 }
85
86 func (s *integrationSuite) SetUpTest(c *C) {
87         s.engine = "docker"
88         s.stdin = bytes.Buffer{}
89         s.stdout = bytes.Buffer{}
90         s.stderr = bytes.Buffer{}
91         s.cr = arvados.ContainerRequest{
92                 Priority:       1,
93                 State:          "Committed",
94                 OutputPath:     "/mnt/out",
95                 ContainerImage: s.image.PortableDataHash,
96                 Mounts: map[string]arvados.Mount{
97                         "/mnt/json": {
98                                 Kind: "json",
99                                 Content: []interface{}{
100                                         "foo",
101                                         map[string]string{"foo": "bar"},
102                                         nil,
103                                 },
104                         },
105                         "/mnt/in": {
106                                 Kind:             "collection",
107                                 PortableDataHash: s.input.PortableDataHash,
108                         },
109                         "/mnt/out": {
110                                 Kind:     "tmp",
111                                 Capacity: 1000,
112                         },
113                 },
114                 RuntimeConstraints: arvados.RuntimeConstraints{
115                         RAM:   128000000,
116                         VCPUs: 1,
117                         API:   true,
118                 },
119         }
120 }
121
122 func (s *integrationSuite) setup(c *C) {
123         err := s.client.RequestAndDecode(&s.cr, "POST", "arvados/v1/container_requests", nil, map[string]interface{}{"container_request": map[string]interface{}{
124                 "priority":            s.cr.Priority,
125                 "state":               s.cr.State,
126                 "command":             s.cr.Command,
127                 "output_path":         s.cr.OutputPath,
128                 "container_image":     s.cr.ContainerImage,
129                 "mounts":              s.cr.Mounts,
130                 "runtime_constraints": s.cr.RuntimeConstraints,
131                 "use_existing":        false,
132         }})
133         c.Assert(err, IsNil)
134         c.Assert(s.cr.ContainerUUID, Not(Equals), "")
135         err = s.client.RequestAndDecode(nil, "POST", "arvados/v1/containers/"+s.cr.ContainerUUID+"/lock", nil, nil)
136         c.Assert(err, IsNil)
137 }
138
139 func (s *integrationSuite) TestRunTrivialContainerWithDocker(c *C) {
140         s.engine = "docker"
141         s.testRunTrivialContainer(c)
142 }
143
144 func (s *integrationSuite) TestRunTrivialContainerWithSingularity(c *C) {
145         s.engine = "singularity"
146         s.testRunTrivialContainer(c)
147 }
148
149 func (s *integrationSuite) testRunTrivialContainer(c *C) {
150         if err := exec.Command("which", s.engine).Run(); err != nil {
151                 c.Skip(fmt.Sprintf("%s: %s", s.engine, err))
152         }
153         s.cr.Command = []string{"sh", "-c", "cat /mnt/in/inputfile >/mnt/out/inputfile && cat /mnt/json >/mnt/out/json && ! touch /mnt/in/shouldbereadonly && mkdir /mnt/out/emptydir"}
154         s.setup(c)
155         code := command{}.RunCommand("crunch-run", []string{
156                 "-runtime-engine=" + s.engine,
157                 "-enable-memory-limit=false",
158                 s.cr.ContainerUUID,
159         }, &s.stdin, io.MultiWriter(&s.stdout, os.Stderr), io.MultiWriter(&s.stderr, os.Stderr))
160         c.Check(code, Equals, 0)
161         err := s.client.RequestAndDecode(&s.cr, "GET", "arvados/v1/container_requests/"+s.cr.UUID, nil, nil)
162         c.Assert(err, IsNil)
163         c.Logf("Finished container request: %#v", s.cr)
164
165         var log arvados.Collection
166         err = s.client.RequestAndDecode(&log, "GET", "arvados/v1/collections/"+s.cr.LogUUID, nil, nil)
167         c.Assert(err, IsNil)
168         fs, err := log.FileSystem(s.client, s.kc)
169         c.Assert(err, IsNil)
170         if d, err := fs.Open("/"); c.Check(err, IsNil) {
171                 fis, err := d.Readdir(-1)
172                 c.Assert(err, IsNil)
173                 for _, fi := range fis {
174                         if fi.IsDir() {
175                                 continue
176                         }
177                         f, err := fs.Open(fi.Name())
178                         c.Assert(err, IsNil)
179                         buf, err := ioutil.ReadAll(f)
180                         c.Assert(err, IsNil)
181                         c.Logf("\n===== %s =====\n%s", fi.Name(), buf)
182                 }
183         }
184
185         var output arvados.Collection
186         err = s.client.RequestAndDecode(&output, "GET", "arvados/v1/collections/"+s.cr.OutputUUID, nil, nil)
187         c.Assert(err, IsNil)
188         fs, err = output.FileSystem(s.client, s.kc)
189         c.Assert(err, IsNil)
190         if f, err := fs.Open("inputfile"); c.Check(err, IsNil) {
191                 defer f.Close()
192                 buf, err := ioutil.ReadAll(f)
193                 c.Check(err, IsNil)
194                 c.Check(string(buf), Equals, "inputdata")
195         }
196         if f, err := fs.Open("json"); c.Check(err, IsNil) {
197                 defer f.Close()
198                 buf, err := ioutil.ReadAll(f)
199                 c.Check(err, IsNil)
200                 c.Check(string(buf), Equals, `["foo",{"foo":"bar"},null]`)
201         }
202         if fi, err := fs.Stat("emptydir"); c.Check(err, IsNil) {
203                 c.Check(fi.IsDir(), Equals, true)
204         }
205         if d, err := fs.Open("emptydir"); c.Check(err, IsNil) {
206                 defer d.Close()
207                 fis, err := d.Readdir(-1)
208                 c.Assert(err, IsNil)
209                 // crunch-run still saves a ".keep" file to preserve
210                 // empty dirs even though that shouldn't be
211                 // necessary. Ideally we would do:
212                 // c.Check(fis, HasLen, 0)
213                 for _, fi := range fis {
214                         c.Check(fi.Name(), Equals, ".keep")
215                 }
216         }
217 }