1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
18 "git.arvados.org/arvados.git/sdk/go/arvados"
19 "git.arvados.org/arvados.git/sdk/go/arvadosclient"
20 "git.arvados.org/arvados.git/sdk/go/arvadostest"
21 "git.arvados.org/arvados.git/sdk/go/keepclient"
22 "github.com/AdRoll/goamz/aws"
23 "github.com/AdRoll/goamz/s3"
24 check "gopkg.in/check.v1"
29 ac *arvadosclient.ArvadosClient
30 kc *keepclient.KeepClient
33 coll arvados.Collection
37 func (s *IntegrationSuite) s3setup(c *check.C) s3stage {
38 var proj arvados.Group
39 var coll arvados.Collection
40 arv := arvados.NewClientFromEnv()
41 arv.AuthToken = arvadostest.ActiveToken
42 err := arv.RequestAndDecode(&proj, "POST", "arvados/v1/groups", nil, map[string]interface{}{
43 "group": map[string]interface{}{
44 "group_class": "project",
45 "name": "keep-web s3 test",
47 "ensure_unique_name": true,
49 c.Assert(err, check.IsNil)
50 err = arv.RequestAndDecode(&coll, "POST", "arvados/v1/collections", nil, map[string]interface{}{"collection": map[string]interface{}{
51 "owner_uuid": proj.UUID,
52 "name": "keep-web s3 test collection",
53 "manifest_text": ". d41d8cd98f00b204e9800998ecf8427e+0 0:0:emptyfile\n./emptydir d41d8cd98f00b204e9800998ecf8427e+0 0:0:.\n",
55 c.Assert(err, check.IsNil)
56 ac, err := arvadosclient.New(arv)
57 c.Assert(err, check.IsNil)
58 kc, err := keepclient.MakeKeepClient(ac)
59 c.Assert(err, check.IsNil)
60 fs, err := coll.FileSystem(arv, kc)
61 c.Assert(err, check.IsNil)
62 f, err := fs.OpenFile("sailboat.txt", os.O_CREATE|os.O_WRONLY, 0644)
63 c.Assert(err, check.IsNil)
64 _, err = f.Write([]byte("⛵\n"))
65 c.Assert(err, check.IsNil)
67 c.Assert(err, check.IsNil)
69 c.Assert(err, check.IsNil)
70 err = arv.RequestAndDecode(&coll, "GET", "arvados/v1/collections/"+coll.UUID, nil, nil)
71 c.Assert(err, check.IsNil)
73 auth := aws.NewAuth(arvadostest.ActiveTokenV2, arvadostest.ActiveTokenV2, "", time.Now().Add(time.Hour))
75 Name: s.testServer.Addr,
76 S3Endpoint: "http://" + s.testServer.Addr,
78 client := s3.New(*auth, region)
84 projbucket: &s3.Bucket{
89 collbucket: &s3.Bucket{
96 func (stage s3stage) teardown(c *check.C) {
97 if stage.coll.UUID != "" {
98 err := stage.arv.RequestAndDecode(&stage.coll, "DELETE", "arvados/v1/collections/"+stage.coll.UUID, nil, nil)
99 c.Check(err, check.IsNil)
101 if stage.proj.UUID != "" {
102 err := stage.arv.RequestAndDecode(&stage.proj, "DELETE", "arvados/v1/groups/"+stage.proj.UUID, nil, nil)
103 c.Check(err, check.IsNil)
107 func (s *IntegrationSuite) TestS3HeadBucket(c *check.C) {
108 stage := s.s3setup(c)
109 defer stage.teardown(c)
111 for _, bucket := range []*s3.Bucket{stage.collbucket, stage.projbucket} {
112 c.Logf("bucket %s", bucket.Name)
113 exists, err := bucket.Exists("")
114 c.Check(err, check.IsNil)
115 c.Check(exists, check.Equals, true)
119 func (s *IntegrationSuite) TestS3CollectionGetObject(c *check.C) {
120 stage := s.s3setup(c)
121 defer stage.teardown(c)
122 s.testS3GetObject(c, stage.collbucket, "")
124 func (s *IntegrationSuite) TestS3ProjectGetObject(c *check.C) {
125 stage := s.s3setup(c)
126 defer stage.teardown(c)
127 s.testS3GetObject(c, stage.projbucket, stage.coll.Name+"/")
129 func (s *IntegrationSuite) testS3GetObject(c *check.C, bucket *s3.Bucket, prefix string) {
130 rdr, err := bucket.GetReader(prefix + "emptyfile")
131 c.Assert(err, check.IsNil)
132 buf, err := ioutil.ReadAll(rdr)
133 c.Check(err, check.IsNil)
134 c.Check(len(buf), check.Equals, 0)
136 c.Check(err, check.IsNil)
139 rdr, err = bucket.GetReader(prefix + "missingfile")
140 c.Check(err, check.ErrorMatches, `404 Not Found`)
143 exists, err := bucket.Exists(prefix + "missingfile")
144 c.Check(err, check.IsNil)
145 c.Check(exists, check.Equals, false)
148 rdr, err = bucket.GetReader(prefix + "sailboat.txt")
149 c.Assert(err, check.IsNil)
150 buf, err = ioutil.ReadAll(rdr)
151 c.Check(err, check.IsNil)
152 c.Check(buf, check.DeepEquals, []byte("⛵\n"))
154 c.Check(err, check.IsNil)
157 resp, err := bucket.Head(prefix+"sailboat.txt", nil)
158 c.Check(err, check.IsNil)
159 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
160 c.Check(resp.ContentLength, check.Equals, int64(4))
163 func (s *IntegrationSuite) TestS3CollectionPutObjectSuccess(c *check.C) {
164 stage := s.s3setup(c)
165 defer stage.teardown(c)
166 s.testS3PutObjectSuccess(c, stage.collbucket, "")
168 func (s *IntegrationSuite) TestS3ProjectPutObjectSuccess(c *check.C) {
169 stage := s.s3setup(c)
170 defer stage.teardown(c)
171 s.testS3PutObjectSuccess(c, stage.projbucket, stage.coll.Name+"/")
173 func (s *IntegrationSuite) testS3PutObjectSuccess(c *check.C, bucket *s3.Bucket, prefix string) {
174 for _, trial := range []struct {
182 contentType: "application/octet-stream",
184 path: "newdir/newfile",
186 contentType: "application/octet-stream",
188 path: "newdir1/newdir2/newfile",
190 contentType: "application/octet-stream",
192 path: "newdir1/newdir2/newdir3/",
194 contentType: "application/x-directory",
197 c.Logf("=== %v", trial)
199 objname := prefix + trial.path
201 _, err := bucket.GetReader(objname)
202 c.Assert(err, check.ErrorMatches, `404 Not Found`)
204 buf := make([]byte, trial.size)
207 err = bucket.PutReader(objname, bytes.NewReader(buf), int64(len(buf)), trial.contentType, s3.Private, s3.Options{})
208 c.Check(err, check.IsNil)
210 rdr, err := bucket.GetReader(objname)
211 if strings.HasSuffix(trial.path, "/") && !s.testServer.Config.cluster.Collections.S3FolderObjects {
212 c.Check(err, check.NotNil)
214 } else if !c.Check(err, check.IsNil) {
217 buf2, err := ioutil.ReadAll(rdr)
218 c.Check(err, check.IsNil)
219 c.Check(buf2, check.HasLen, len(buf))
220 c.Check(bytes.Equal(buf, buf2), check.Equals, true)
224 func (s *IntegrationSuite) TestS3ProjectPutObjectNotSupported(c *check.C) {
225 stage := s.s3setup(c)
226 defer stage.teardown(c)
227 bucket := stage.projbucket
229 for _, trial := range []struct {
237 contentType: "application/octet-stream",
239 path: "newdir/newfile",
241 contentType: "application/octet-stream",
245 contentType: "application/x-directory",
248 c.Logf("=== %v", trial)
250 _, err := bucket.GetReader(trial.path)
251 c.Assert(err, check.ErrorMatches, `404 Not Found`)
253 buf := make([]byte, trial.size)
256 err = bucket.PutReader(trial.path, bytes.NewReader(buf), int64(len(buf)), trial.contentType, s3.Private, s3.Options{})
257 c.Check(err, check.ErrorMatches, `400 Bad Request`)
259 _, err = bucket.GetReader(trial.path)
260 c.Assert(err, check.ErrorMatches, `404 Not Found`)
264 func (s *IntegrationSuite) TestS3CollectionDeleteObject(c *check.C) {
265 stage := s.s3setup(c)
266 defer stage.teardown(c)
267 s.testS3DeleteObject(c, stage.collbucket, "")
269 func (s *IntegrationSuite) TestS3ProjectDeleteObject(c *check.C) {
270 stage := s.s3setup(c)
271 defer stage.teardown(c)
272 s.testS3DeleteObject(c, stage.projbucket, stage.coll.Name+"/")
274 func (s *IntegrationSuite) testS3DeleteObject(c *check.C, bucket *s3.Bucket, prefix string) {
275 s.testServer.Config.cluster.Collections.S3FolderObjects = true
276 for _, trial := range []struct {
287 objname := prefix + trial.path
288 comment := check.Commentf("objname %q", objname)
290 err := bucket.Del(objname)
291 if trial.path == "/" {
292 c.Check(err, check.NotNil)
295 c.Check(err, check.IsNil, comment)
296 _, err = bucket.GetReader(objname)
297 c.Check(err, check.NotNil, comment)
301 func (s *IntegrationSuite) TestS3CollectionPutObjectFailure(c *check.C) {
302 stage := s.s3setup(c)
303 defer stage.teardown(c)
304 s.testS3PutObjectFailure(c, stage.collbucket, "")
306 func (s *IntegrationSuite) TestS3ProjectPutObjectFailure(c *check.C) {
307 stage := s.s3setup(c)
308 defer stage.teardown(c)
309 s.testS3PutObjectFailure(c, stage.projbucket, stage.coll.Name+"/")
311 func (s *IntegrationSuite) testS3PutObjectFailure(c *check.C, bucket *s3.Bucket, prefix string) {
312 s.testServer.Config.cluster.Collections.S3FolderObjects = false
313 var wg sync.WaitGroup
314 for _, trial := range []struct {
318 path: "emptyfile/newname", // emptyfile exists, see s3setup()
320 path: "emptyfile/", // emptyfile exists, see s3setup()
322 path: "emptydir", // dir already exists, see s3setup()
345 c.Logf("=== %v", trial)
347 objname := prefix + trial.path
349 buf := make([]byte, 1234)
352 err := bucket.PutReader(objname, bytes.NewReader(buf), int64(len(buf)), "application/octet-stream", s3.Private, s3.Options{})
353 if !c.Check(err, check.ErrorMatches, `400 Bad.*`, check.Commentf("PUT %q should fail", objname)) {
357 if objname != "" && objname != "/" {
358 _, err = bucket.GetReader(objname)
359 c.Check(err, check.ErrorMatches, `404 Not Found`, check.Commentf("GET %q should return 404", objname))
366 func (stage *s3stage) writeBigDirs(c *check.C, dirs int, filesPerDir int) {
367 fs, err := stage.coll.FileSystem(stage.arv, stage.kc)
368 c.Assert(err, check.IsNil)
369 for d := 0; d < dirs; d++ {
370 dir := fmt.Sprintf("dir%d", d)
371 c.Assert(fs.Mkdir(dir, 0755), check.IsNil)
372 for i := 0; i < filesPerDir; i++ {
373 f, err := fs.OpenFile(fmt.Sprintf("%s/file%d.txt", dir, i), os.O_CREATE|os.O_WRONLY, 0644)
374 c.Assert(err, check.IsNil)
375 c.Assert(f.Close(), check.IsNil)
378 c.Assert(fs.Sync(), check.IsNil)
381 func (s *IntegrationSuite) TestS3GetBucketVersioning(c *check.C) {
382 stage := s.s3setup(c)
383 defer stage.teardown(c)
384 for _, bucket := range []*s3.Bucket{stage.collbucket, stage.projbucket} {
385 req, err := http.NewRequest("GET", bucket.URL("/"), nil)
386 c.Check(err, check.IsNil)
387 req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
388 req.URL.RawQuery = "versioning"
389 resp, err := http.DefaultClient.Do(req)
390 c.Assert(err, check.IsNil)
391 c.Check(resp.Header.Get("Content-Type"), check.Equals, "application/xml")
392 buf, err := ioutil.ReadAll(resp.Body)
393 c.Assert(err, check.IsNil)
394 c.Check(string(buf), check.Equals, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<VersioningConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\"/>\n")
398 // If there are no CommonPrefixes entries, the CommonPrefixes XML tag
399 // should not appear at all.
400 func (s *IntegrationSuite) TestS3ListNoCommonPrefixes(c *check.C) {
401 stage := s.s3setup(c)
402 defer stage.teardown(c)
404 req, err := http.NewRequest("GET", stage.collbucket.URL("/"), nil)
405 c.Assert(err, check.IsNil)
406 req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
407 req.URL.RawQuery = "prefix=asdfasdfasdf&delimiter=/"
408 resp, err := http.DefaultClient.Do(req)
409 c.Assert(err, check.IsNil)
410 buf, err := ioutil.ReadAll(resp.Body)
411 c.Assert(err, check.IsNil)
412 c.Check(string(buf), check.Not(check.Matches), `(?ms).*CommonPrefixes.*`)
415 // If there is no delimiter in the request, or the results are not
416 // truncated, the NextMarker XML tag should not appear in the response
418 func (s *IntegrationSuite) TestS3ListNoNextMarker(c *check.C) {
419 stage := s.s3setup(c)
420 defer stage.teardown(c)
422 for _, query := range []string{"prefix=e&delimiter=/", ""} {
423 req, err := http.NewRequest("GET", stage.collbucket.URL("/"), nil)
424 c.Assert(err, check.IsNil)
425 req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
426 req.URL.RawQuery = query
427 resp, err := http.DefaultClient.Do(req)
428 c.Assert(err, check.IsNil)
429 buf, err := ioutil.ReadAll(resp.Body)
430 c.Assert(err, check.IsNil)
431 c.Check(string(buf), check.Not(check.Matches), `(?ms).*NextMarker.*`)
435 // List response should include KeyCount field.
436 func (s *IntegrationSuite) TestS3ListKeyCount(c *check.C) {
437 stage := s.s3setup(c)
438 defer stage.teardown(c)
440 req, err := http.NewRequest("GET", stage.collbucket.URL("/"), nil)
441 c.Assert(err, check.IsNil)
442 req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
443 req.URL.RawQuery = "prefix=&delimiter=/"
444 resp, err := http.DefaultClient.Do(req)
445 c.Assert(err, check.IsNil)
446 buf, err := ioutil.ReadAll(resp.Body)
447 c.Assert(err, check.IsNil)
448 c.Check(string(buf), check.Matches, `(?ms).*<KeyCount>2</KeyCount>.*`)
451 func (s *IntegrationSuite) TestS3CollectionList(c *check.C) {
452 stage := s.s3setup(c)
453 defer stage.teardown(c)
456 for markers, s.testServer.Config.cluster.Collections.S3FolderObjects = range []bool{false, true} {
459 stage.writeBigDirs(c, dirs, filesPerDir)
460 // Total # objects is:
461 // 2 file entries from s3setup (emptyfile and sailboat.txt)
462 // +1 fake "directory" marker from s3setup (emptydir) (if enabled)
463 // +dirs fake "directory" marker from writeBigDirs (dir0/, dir1/) (if enabled)
464 // +filesPerDir*dirs file entries from writeBigDirs (dir0/file0.txt, etc.)
465 s.testS3List(c, stage.collbucket, "", 4000, markers+2+(filesPerDir+markers)*dirs)
466 s.testS3List(c, stage.collbucket, "", 131, markers+2+(filesPerDir+markers)*dirs)
467 s.testS3List(c, stage.collbucket, "dir0/", 71, filesPerDir+markers)
470 func (s *IntegrationSuite) testS3List(c *check.C, bucket *s3.Bucket, prefix string, pageSize, expectFiles int) {
471 c.Logf("testS3List: prefix=%q pageSize=%d S3FolderObjects=%v", prefix, pageSize, s.testServer.Config.cluster.Collections.S3FolderObjects)
472 expectPageSize := pageSize
473 if expectPageSize > 1000 {
474 expectPageSize = 1000
476 gotKeys := map[string]s3.Key{}
480 resp, err := bucket.List(prefix, "", nextMarker, pageSize)
481 if !c.Check(err, check.IsNil) {
484 c.Check(len(resp.Contents) <= expectPageSize, check.Equals, true)
485 if pages++; !c.Check(pages <= (expectFiles/expectPageSize)+1, check.Equals, true) {
488 for _, key := range resp.Contents {
489 gotKeys[key.Key] = key
490 if strings.Contains(key.Key, "sailboat.txt") {
491 c.Check(key.Size, check.Equals, int64(4))
494 if !resp.IsTruncated {
495 c.Check(resp.NextMarker, check.Equals, "")
498 if !c.Check(resp.NextMarker, check.Not(check.Equals), "") {
501 nextMarker = resp.NextMarker
503 c.Check(len(gotKeys), check.Equals, expectFiles)
506 func (s *IntegrationSuite) TestS3CollectionListRollup(c *check.C) {
507 for _, s.testServer.Config.cluster.Collections.S3FolderObjects = range []bool{false, true} {
508 s.testS3CollectionListRollup(c)
512 func (s *IntegrationSuite) testS3CollectionListRollup(c *check.C) {
513 stage := s.s3setup(c)
514 defer stage.teardown(c)
518 stage.writeBigDirs(c, dirs, filesPerDir)
519 err := stage.collbucket.PutReader("dingbats", &bytes.Buffer{}, 0, "application/octet-stream", s3.Private, s3.Options{})
520 c.Assert(err, check.IsNil)
521 var allfiles []string
522 for marker := ""; ; {
523 resp, err := stage.collbucket.List("", "", marker, 20000)
524 c.Check(err, check.IsNil)
525 for _, key := range resp.Contents {
526 if len(allfiles) == 0 || allfiles[len(allfiles)-1] != key.Key {
527 allfiles = append(allfiles, key.Key)
530 marker = resp.NextMarker
536 if s.testServer.Config.cluster.Collections.S3FolderObjects {
539 c.Check(allfiles, check.HasLen, dirs*(filesPerDir+markers)+3+markers)
541 gotDirMarker := map[string]bool{}
542 for _, name := range allfiles {
543 isDirMarker := strings.HasSuffix(name, "/")
545 c.Check(isDirMarker, check.Equals, false, check.Commentf("name %q", name))
546 } else if isDirMarker {
547 gotDirMarker[name] = true
548 } else if i := strings.LastIndex(name, "/"); i >= 0 {
549 c.Check(gotDirMarker[name[:i+1]], check.Equals, true, check.Commentf("name %q", name))
550 gotDirMarker[name[:i+1]] = true // skip redundant complaints about this dir marker
554 for _, trial := range []struct {
569 {"dir0", "/", "dir0/file14.txt"}, // no commonprefixes
570 {"", "", "dir0/file14.txt"}, // middle page, skip walking dir1
571 {"", "", "dir1/file14.txt"}, // middle page, skip walking dir0
572 {"", "", "dir1/file498.txt"}, // last page of results
573 {"dir1/file", "", "dir1/file498.txt"}, // last page of results, with prefix
574 {"dir1/file", "/", "dir1/file498.txt"}, // last page of results, with prefix + delimiter
575 {"dir1", "Z", "dir1/file498.txt"}, // delimiter "Z" never appears
576 {"dir2", "/", ""}, // prefix "dir2" does not exist
579 c.Logf("\n\n=== trial %+v markers=%d", trial, markers)
582 resp, err := stage.collbucket.List(trial.prefix, trial.delimiter, trial.marker, maxKeys)
583 c.Check(err, check.IsNil)
584 if resp.IsTruncated && trial.delimiter == "" {
585 // goamz List method fills in the missing
586 // NextMarker field if resp.IsTruncated, so
587 // now we can't really tell whether it was
588 // sent by the server or by goamz. In cases
589 // where it should be empty but isn't, assume
590 // it's goamz's fault.
594 var expectKeys []string
595 var expectPrefixes []string
596 var expectNextMarker string
597 var expectTruncated bool
598 for _, key := range allfiles {
599 full := len(expectKeys)+len(expectPrefixes) >= maxKeys
600 if !strings.HasPrefix(key, trial.prefix) || key < trial.marker {
602 } else if idx := strings.Index(key[len(trial.prefix):], trial.delimiter); trial.delimiter != "" && idx >= 0 {
603 prefix := key[:len(trial.prefix)+idx+1]
604 if len(expectPrefixes) > 0 && expectPrefixes[len(expectPrefixes)-1] == prefix {
605 // same prefix as previous key
607 expectNextMarker = key
608 expectTruncated = true
610 expectPrefixes = append(expectPrefixes, prefix)
613 if trial.delimiter != "" {
614 expectNextMarker = key
616 expectTruncated = true
619 expectKeys = append(expectKeys, key)
624 for _, key := range resp.Contents {
625 gotKeys = append(gotKeys, key.Key)
627 var gotPrefixes []string
628 for _, prefix := range resp.CommonPrefixes {
629 gotPrefixes = append(gotPrefixes, prefix)
631 commentf := check.Commentf("trial %+v markers=%d", trial, markers)
632 c.Check(gotKeys, check.DeepEquals, expectKeys, commentf)
633 c.Check(gotPrefixes, check.DeepEquals, expectPrefixes, commentf)
634 c.Check(resp.NextMarker, check.Equals, expectNextMarker, commentf)
635 c.Check(resp.IsTruncated, check.Equals, expectTruncated, commentf)
636 c.Logf("=== trial %+v keys %q prefixes %q nextMarker %q", trial, gotKeys, gotPrefixes, resp.NextMarker)