services/keep-web/s3_test.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 import (
   8         "bytes"
   9         "crypto/rand"
  10         "fmt"
  11         "io/ioutil"
  12         "net/http"
  13         "net/url"
  14         "os"
  15         "os/exec"
  16         "strings"
  17         "sync"
  18         "time"
  19
  20         "git.arvados.org/arvados.git/sdk/go/arvados"
  21         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
  22         "git.arvados.org/arvados.git/sdk/go/arvadostest"
  23         "git.arvados.org/arvados.git/sdk/go/keepclient"
  24         "github.com/AdRoll/goamz/aws"
  25         "github.com/AdRoll/goamz/s3"
  26         check "gopkg.in/check.v1"
  27 )
  28
  29 type s3stage struct {
  30         arv        *arvados.Client
  31         ac         *arvadosclient.ArvadosClient
  32         kc         *keepclient.KeepClient
  33         proj       arvados.Group
  34         projbucket *s3.Bucket
  35         coll       arvados.Collection
  36         collbucket *s3.Bucket
  37 }
  38
  39 func (s *IntegrationSuite) s3setup(c *check.C) s3stage {
  40         var proj arvados.Group
  41         var coll arvados.Collection
  42         arv := arvados.NewClientFromEnv()
  43         arv.AuthToken = arvadostest.ActiveToken
  44         err := arv.RequestAndDecode(&proj, "POST", "arvados/v1/groups", nil, map[string]interface{}{
  45                 "group": map[string]interface{}{
  46                         "group_class": "project",
  47                         "name":        "keep-web s3 test",
  48                 },
  49                 "ensure_unique_name": true,
  50         })
  51         c.Assert(err, check.IsNil)
  52         err = arv.RequestAndDecode(&coll, "POST", "arvados/v1/collections", nil, map[string]interface{}{"collection": map[string]interface{}{
  53                 "owner_uuid":    proj.UUID,
  54                 "name":          "keep-web s3 test collection",
  55                 "manifest_text": ". d41d8cd98f00b204e9800998ecf8427e+0 0:0:emptyfile\n./emptydir d41d8cd98f00b204e9800998ecf8427e+0 0:0:.\n",
  56         }})
  57         c.Assert(err, check.IsNil)
  58         ac, err := arvadosclient.New(arv)
  59         c.Assert(err, check.IsNil)
  60         kc, err := keepclient.MakeKeepClient(ac)
  61         c.Assert(err, check.IsNil)
  62         fs, err := coll.FileSystem(arv, kc)
  63         c.Assert(err, check.IsNil)
  64         f, err := fs.OpenFile("sailboat.txt", os.O_CREATE|os.O_WRONLY, 0644)
  65         c.Assert(err, check.IsNil)
  66         _, err = f.Write([]byte("⛵\n"))
  67         c.Assert(err, check.IsNil)
  68         err = f.Close()
  69         c.Assert(err, check.IsNil)
  70         err = fs.Sync()
  71         c.Assert(err, check.IsNil)
  72         err = arv.RequestAndDecode(&coll, "GET", "arvados/v1/collections/"+coll.UUID, nil, nil)
  73         c.Assert(err, check.IsNil)
  74
  75         auth := aws.NewAuth(arvadostest.ActiveTokenUUID, arvadostest.ActiveToken, "", time.Now().Add(time.Hour))
  76         region := aws.Region{
  77                 Name:       s.testServer.Addr,
  78                 S3Endpoint: "http://" + s.testServer.Addr,
  79         }
  80         client := s3.New(*auth, region)
  81         client.Signature = aws.V4Signature
  82         return s3stage{
  83                 arv:  arv,
  84                 ac:   ac,
  85                 kc:   kc,
  86                 proj: proj,
  87                 projbucket: &s3.Bucket{
  88                         S3:   client,
  89                         Name: proj.UUID,
  90                 },
  91                 coll: coll,
  92                 collbucket: &s3.Bucket{
  93                         S3:   client,
  94                         Name: coll.UUID,
  95                 },
  96         }
  97 }
  98
  99 func (stage s3stage) teardown(c *check.C) {
 100         if stage.coll.UUID != "" {
 101                 err := stage.arv.RequestAndDecode(&stage.coll, "DELETE", "arvados/v1/collections/"+stage.coll.UUID, nil, nil)
 102                 c.Check(err, check.IsNil)
 103         }
 104         if stage.proj.UUID != "" {
 105                 err := stage.arv.RequestAndDecode(&stage.proj, "DELETE", "arvados/v1/groups/"+stage.proj.UUID, nil, nil)
 106                 c.Check(err, check.IsNil)
 107         }
 108 }
 109
 110 func (s *IntegrationSuite) TestS3Signatures(c *check.C) {
 111         stage := s.s3setup(c)
 112         defer stage.teardown(c)
 113
 114         bucket := stage.collbucket
 115         for _, trial := range []struct {
 116                 success   bool
 117                 signature int
 118                 accesskey string
 119                 secretkey string
 120         }{
 121                 {true, aws.V2Signature, arvadostest.ActiveToken, "none"},
 122                 {true, aws.V2Signature, url.QueryEscape(arvadostest.ActiveTokenV2), "none"},
 123                 {true, aws.V2Signature, strings.Replace(arvadostest.ActiveTokenV2, "/", "_", -1), "none"},
 124                 {false, aws.V2Signature, "none", "none"},
 125                 {false, aws.V2Signature, "none", arvadostest.ActiveToken},
 126
 127                 {true, aws.V4Signature, arvadostest.ActiveTokenUUID, arvadostest.ActiveToken},
 128                 {true, aws.V4Signature, arvadostest.ActiveToken, arvadostest.ActiveToken},
 129                 {true, aws.V4Signature, url.QueryEscape(arvadostest.ActiveTokenV2), url.QueryEscape(arvadostest.ActiveTokenV2)},
 130                 {true, aws.V4Signature, strings.Replace(arvadostest.ActiveTokenV2, "/", "_", -1), strings.Replace(arvadostest.ActiveTokenV2, "/", "_", -1)},
 131                 {false, aws.V4Signature, arvadostest.ActiveToken, ""},
 132                 {false, aws.V4Signature, arvadostest.ActiveToken, "none"},
 133                 {false, aws.V4Signature, "none", arvadostest.ActiveToken},
 134                 {false, aws.V4Signature, "none", "none"},
 135         } {
 136                 c.Logf("%#v", trial)
 137                 bucket.S3.Auth = *(aws.NewAuth(trial.accesskey, trial.secretkey, "", time.Now().Add(time.Hour)))
 138                 bucket.S3.Signature = trial.signature
 139                 _, err := bucket.GetReader("emptyfile")
 140                 if trial.success {
 141                         c.Check(err, check.IsNil)
 142                 } else {
 143                         c.Check(err, check.NotNil)
 144                 }
 145         }
 146 }
 147
 148 func (s *IntegrationSuite) TestS3HeadBucket(c *check.C) {
 149         stage := s.s3setup(c)
 150         defer stage.teardown(c)
 151
 152         for _, bucket := range []*s3.Bucket{stage.collbucket, stage.projbucket} {
 153                 c.Logf("bucket %s", bucket.Name)
 154                 exists, err := bucket.Exists("")
 155                 c.Check(err, check.IsNil)
 156                 c.Check(exists, check.Equals, true)
 157         }
 158 }
 159
 160 func (s *IntegrationSuite) TestS3CollectionGetObject(c *check.C) {
 161         stage := s.s3setup(c)
 162         defer stage.teardown(c)
 163         s.testS3GetObject(c, stage.collbucket, "")
 164 }
 165 func (s *IntegrationSuite) TestS3ProjectGetObject(c *check.C) {
 166         stage := s.s3setup(c)
 167         defer stage.teardown(c)
 168         s.testS3GetObject(c, stage.projbucket, stage.coll.Name+"/")
 169 }
 170 func (s *IntegrationSuite) testS3GetObject(c *check.C, bucket *s3.Bucket, prefix string) {
 171         rdr, err := bucket.GetReader(prefix + "emptyfile")
 172         c.Assert(err, check.IsNil)
 173         buf, err := ioutil.ReadAll(rdr)
 174         c.Check(err, check.IsNil)
 175         c.Check(len(buf), check.Equals, 0)
 176         err = rdr.Close()
 177         c.Check(err, check.IsNil)
 178
 179         // GetObject
 180         rdr, err = bucket.GetReader(prefix + "missingfile")
 181         c.Check(err, check.ErrorMatches, `404 Not Found`)
 182
 183         // HeadObject
 184         exists, err := bucket.Exists(prefix + "missingfile")
 185         c.Check(err, check.IsNil)
 186         c.Check(exists, check.Equals, false)
 187
 188         // GetObject
 189         rdr, err = bucket.GetReader(prefix + "sailboat.txt")
 190         c.Assert(err, check.IsNil)
 191         buf, err = ioutil.ReadAll(rdr)
 192         c.Check(err, check.IsNil)
 193         c.Check(buf, check.DeepEquals, []byte("⛵\n"))
 194         err = rdr.Close()
 195         c.Check(err, check.IsNil)
 196
 197         // HeadObject
 198         resp, err := bucket.Head(prefix+"sailboat.txt", nil)
 199         c.Check(err, check.IsNil)
 200         c.Check(resp.StatusCode, check.Equals, http.StatusOK)
 201         c.Check(resp.ContentLength, check.Equals, int64(4))
 202 }
 203
 204 func (s *IntegrationSuite) TestS3CollectionPutObjectSuccess(c *check.C) {
 205         stage := s.s3setup(c)
 206         defer stage.teardown(c)
 207         s.testS3PutObjectSuccess(c, stage.collbucket, "")
 208 }
 209 func (s *IntegrationSuite) TestS3ProjectPutObjectSuccess(c *check.C) {
 210         stage := s.s3setup(c)
 211         defer stage.teardown(c)
 212         s.testS3PutObjectSuccess(c, stage.projbucket, stage.coll.Name+"/")
 213 }
 214 func (s *IntegrationSuite) testS3PutObjectSuccess(c *check.C, bucket *s3.Bucket, prefix string) {
 215         for _, trial := range []struct {
 216                 path        string
 217                 size        int
 218                 contentType string
 219         }{
 220                 {
 221                         path:        "newfile",
 222                         size:        128000000,
 223                         contentType: "application/octet-stream",
 224                 }, {
 225                         path:        "newdir/newfile",
 226                         size:        1 << 26,
 227                         contentType: "application/octet-stream",
 228                 }, {
 229                         path:        "newdir1/newdir2/newfile",
 230                         size:        0,
 231                         contentType: "application/octet-stream",
 232                 }, {
 233                         path:        "newdir1/newdir2/newdir3/",
 234                         size:        0,
 235                         contentType: "application/x-directory",
 236                 },
 237         } {
 238                 c.Logf("=== %v", trial)
 239
 240                 objname := prefix + trial.path
 241
 242                 _, err := bucket.GetReader(objname)
 243                 c.Assert(err, check.ErrorMatches, `404 Not Found`)
 244
 245                 buf := make([]byte, trial.size)
 246                 rand.Read(buf)
 247
 248                 err = bucket.PutReader(objname, bytes.NewReader(buf), int64(len(buf)), trial.contentType, s3.Private, s3.Options{})
 249                 c.Check(err, check.IsNil)
 250
 251                 rdr, err := bucket.GetReader(objname)
 252                 if strings.HasSuffix(trial.path, "/") && !s.testServer.Config.cluster.Collections.S3FolderObjects {
 253                         c.Check(err, check.NotNil)
 254                         continue
 255                 } else if !c.Check(err, check.IsNil) {
 256                         continue
 257                 }
 258                 buf2, err := ioutil.ReadAll(rdr)
 259                 c.Check(err, check.IsNil)
 260                 c.Check(buf2, check.HasLen, len(buf))
 261                 c.Check(bytes.Equal(buf, buf2), check.Equals, true)
 262         }
 263 }
 264
 265 func (s *IntegrationSuite) TestS3ProjectPutObjectNotSupported(c *check.C) {
 266         stage := s.s3setup(c)
 267         defer stage.teardown(c)
 268         bucket := stage.projbucket
 269
 270         for _, trial := range []struct {
 271                 path        string
 272                 size        int
 273                 contentType string
 274         }{
 275                 {
 276                         path:        "newfile",
 277                         size:        1234,
 278                         contentType: "application/octet-stream",
 279                 }, {
 280                         path:        "newdir/newfile",
 281                         size:        1234,
 282                         contentType: "application/octet-stream",
 283                 }, {
 284                         path:        "newdir2/",
 285                         size:        0,
 286                         contentType: "application/x-directory",
 287                 },
 288         } {
 289                 c.Logf("=== %v", trial)
 290
 291                 _, err := bucket.GetReader(trial.path)
 292                 c.Assert(err, check.ErrorMatches, `404 Not Found`)
 293
 294                 buf := make([]byte, trial.size)
 295                 rand.Read(buf)
 296
 297                 err = bucket.PutReader(trial.path, bytes.NewReader(buf), int64(len(buf)), trial.contentType, s3.Private, s3.Options{})
 298                 c.Check(err, check.ErrorMatches, `400 Bad Request`)
 299
 300                 _, err = bucket.GetReader(trial.path)
 301                 c.Assert(err, check.ErrorMatches, `404 Not Found`)
 302         }
 303 }
 304
 305 func (s *IntegrationSuite) TestS3CollectionDeleteObject(c *check.C) {
 306         stage := s.s3setup(c)
 307         defer stage.teardown(c)
 308         s.testS3DeleteObject(c, stage.collbucket, "")
 309 }
 310 func (s *IntegrationSuite) TestS3ProjectDeleteObject(c *check.C) {
 311         stage := s.s3setup(c)
 312         defer stage.teardown(c)
 313         s.testS3DeleteObject(c, stage.projbucket, stage.coll.Name+"/")
 314 }
 315 func (s *IntegrationSuite) testS3DeleteObject(c *check.C, bucket *s3.Bucket, prefix string) {
 316         s.testServer.Config.cluster.Collections.S3FolderObjects = true
 317         for _, trial := range []struct {
 318                 path string
 319         }{
 320                 {"/"},
 321                 {"nonexistentfile"},
 322                 {"emptyfile"},
 323                 {"sailboat.txt"},
 324                 {"sailboat.txt/"},
 325                 {"emptydir"},
 326                 {"emptydir/"},
 327         } {
 328                 objname := prefix + trial.path
 329                 comment := check.Commentf("objname %q", objname)
 330
 331                 err := bucket.Del(objname)
 332                 if trial.path == "/" {
 333                         c.Check(err, check.NotNil)
 334                         continue
 335                 }
 336                 c.Check(err, check.IsNil, comment)
 337                 _, err = bucket.GetReader(objname)
 338                 c.Check(err, check.NotNil, comment)
 339         }
 340 }
 341
 342 func (s *IntegrationSuite) TestS3CollectionPutObjectFailure(c *check.C) {
 343         stage := s.s3setup(c)
 344         defer stage.teardown(c)
 345         s.testS3PutObjectFailure(c, stage.collbucket, "")
 346 }
 347 func (s *IntegrationSuite) TestS3ProjectPutObjectFailure(c *check.C) {
 348         stage := s.s3setup(c)
 349         defer stage.teardown(c)
 350         s.testS3PutObjectFailure(c, stage.projbucket, stage.coll.Name+"/")
 351 }
 352 func (s *IntegrationSuite) testS3PutObjectFailure(c *check.C, bucket *s3.Bucket, prefix string) {
 353         s.testServer.Config.cluster.Collections.S3FolderObjects = false
 354
 355         // Can't use V4 signature for these tests, because
 356         // double-slash is incorrectly cleaned by the aws.V4Signature,
 357         // resulting in a "bad signature" error. (Cleaning the path is
 358         // appropriate for other services, but not in S3 where object
 359         // names "foo//bar" and "foo/bar" are semantically different.)
 360         bucket.S3.Auth = *(aws.NewAuth(arvadostest.ActiveToken, "none", "", time.Now().Add(time.Hour)))
 361         bucket.S3.Signature = aws.V2Signature
 362
 363         var wg sync.WaitGroup
 364         for _, trial := range []struct {
 365                 path string
 366         }{
 367                 {
 368                         path: "emptyfile/newname", // emptyfile exists, see s3setup()
 369                 }, {
 370                         path: "emptyfile/", // emptyfile exists, see s3setup()
 371                 }, {
 372                         path: "emptydir", // dir already exists, see s3setup()
 373                 }, {
 374                         path: "emptydir/",
 375                 }, {
 376                         path: "emptydir//",
 377                 }, {
 378                         path: "newdir/",
 379                 }, {
 380                         path: "newdir//",
 381                 }, {
 382                         path: "/",
 383                 }, {
 384                         path: "//",
 385                 }, {
 386                         path: "foo//bar",
 387                 }, {
 388                         path: "",
 389                 },
 390         } {
 391                 trial := trial
 392                 wg.Add(1)
 393                 go func() {
 394                         defer wg.Done()
 395                         c.Logf("=== %v", trial)
 396
 397                         objname := prefix + trial.path
 398
 399                         buf := make([]byte, 1234)
 400                         rand.Read(buf)
 401
 402                         err := bucket.PutReader(objname, bytes.NewReader(buf), int64(len(buf)), "application/octet-stream", s3.Private, s3.Options{})
 403                         if !c.Check(err, check.ErrorMatches, `400 Bad.*`, check.Commentf("PUT %q should fail", objname)) {
 404                                 return
 405                         }
 406
 407                         if objname != "" && objname != "/" {
 408                                 _, err = bucket.GetReader(objname)
 409                                 c.Check(err, check.ErrorMatches, `404 Not Found`, check.Commentf("GET %q should return 404", objname))
 410                         }
 411                 }()
 412         }
 413         wg.Wait()
 414 }
 415
 416 func (stage *s3stage) writeBigDirs(c *check.C, dirs int, filesPerDir int) {
 417         fs, err := stage.coll.FileSystem(stage.arv, stage.kc)
 418         c.Assert(err, check.IsNil)
 419         for d := 0; d < dirs; d++ {
 420                 dir := fmt.Sprintf("dir%d", d)
 421                 c.Assert(fs.Mkdir(dir, 0755), check.IsNil)
 422                 for i := 0; i < filesPerDir; i++ {
 423                         f, err := fs.OpenFile(fmt.Sprintf("%s/file%d.txt", dir, i), os.O_CREATE|os.O_WRONLY, 0644)
 424                         c.Assert(err, check.IsNil)
 425                         c.Assert(f.Close(), check.IsNil)
 426                 }
 427         }
 428         c.Assert(fs.Sync(), check.IsNil)
 429 }
 430
 431 func (s *IntegrationSuite) TestS3GetBucketVersioning(c *check.C) {
 432         stage := s.s3setup(c)
 433         defer stage.teardown(c)
 434         for _, bucket := range []*s3.Bucket{stage.collbucket, stage.projbucket} {
 435                 req, err := http.NewRequest("GET", bucket.URL("/"), nil)
 436                 c.Check(err, check.IsNil)
 437                 req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
 438                 req.URL.RawQuery = "versioning"
 439                 resp, err := http.DefaultClient.Do(req)
 440                 c.Assert(err, check.IsNil)
 441                 c.Check(resp.Header.Get("Content-Type"), check.Equals, "application/xml")
 442                 buf, err := ioutil.ReadAll(resp.Body)
 443                 c.Assert(err, check.IsNil)
 444                 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")
 445         }
 446 }
 447
 448 // If there are no CommonPrefixes entries, the CommonPrefixes XML tag
 449 // should not appear at all.
 450 func (s *IntegrationSuite) TestS3ListNoCommonPrefixes(c *check.C) {
 451         stage := s.s3setup(c)
 452         defer stage.teardown(c)
 453
 454         req, err := http.NewRequest("GET", stage.collbucket.URL("/"), nil)
 455         c.Assert(err, check.IsNil)
 456         req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
 457         req.URL.RawQuery = "prefix=asdfasdfasdf&delimiter=/"
 458         resp, err := http.DefaultClient.Do(req)
 459         c.Assert(err, check.IsNil)
 460         buf, err := ioutil.ReadAll(resp.Body)
 461         c.Assert(err, check.IsNil)
 462         c.Check(string(buf), check.Not(check.Matches), `(?ms).*CommonPrefixes.*`)
 463 }
 464
 465 // If there is no delimiter in the request, or the results are not
 466 // truncated, the NextMarker XML tag should not appear in the response
 467 // body.
 468 func (s *IntegrationSuite) TestS3ListNoNextMarker(c *check.C) {
 469         stage := s.s3setup(c)
 470         defer stage.teardown(c)
 471
 472         for _, query := range []string{"prefix=e&delimiter=/", ""} {
 473                 req, err := http.NewRequest("GET", stage.collbucket.URL("/"), nil)
 474                 c.Assert(err, check.IsNil)
 475                 req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
 476                 req.URL.RawQuery = query
 477                 resp, err := http.DefaultClient.Do(req)
 478                 c.Assert(err, check.IsNil)
 479                 buf, err := ioutil.ReadAll(resp.Body)
 480                 c.Assert(err, check.IsNil)
 481                 c.Check(string(buf), check.Not(check.Matches), `(?ms).*NextMarker.*`)
 482         }
 483 }
 484
 485 // List response should include KeyCount field.
 486 func (s *IntegrationSuite) TestS3ListKeyCount(c *check.C) {
 487         stage := s.s3setup(c)
 488         defer stage.teardown(c)
 489
 490         req, err := http.NewRequest("GET", stage.collbucket.URL("/"), nil)
 491         c.Assert(err, check.IsNil)
 492         req.Header.Set("Authorization", "AWS "+arvadostest.ActiveTokenV2+":none")
 493         req.URL.RawQuery = "prefix=&delimiter=/"
 494         resp, err := http.DefaultClient.Do(req)
 495         c.Assert(err, check.IsNil)
 496         buf, err := ioutil.ReadAll(resp.Body)
 497         c.Assert(err, check.IsNil)
 498         c.Check(string(buf), check.Matches, `(?ms).*<KeyCount>2</KeyCount>.*`)
 499 }
 500
 501 func (s *IntegrationSuite) TestS3CollectionList(c *check.C) {
 502         stage := s.s3setup(c)
 503         defer stage.teardown(c)
 504
 505         var markers int
 506         for markers, s.testServer.Config.cluster.Collections.S3FolderObjects = range []bool{false, true} {
 507                 dirs := 2
 508                 filesPerDir := 1001
 509                 stage.writeBigDirs(c, dirs, filesPerDir)
 510                 // Total # objects is:
 511                 //                 2 file entries from s3setup (emptyfile and sailboat.txt)
 512                 //                +1 fake "directory" marker from s3setup (emptydir) (if enabled)
 513                 //             +dirs fake "directory" marker from writeBigDirs (dir0/, dir1/) (if enabled)
 514                 // +filesPerDir*dirs file entries from writeBigDirs (dir0/file0.txt, etc.)
 515                 s.testS3List(c, stage.collbucket, "", 4000, markers+2+(filesPerDir+markers)*dirs)
 516                 s.testS3List(c, stage.collbucket, "", 131, markers+2+(filesPerDir+markers)*dirs)
 517                 s.testS3List(c, stage.collbucket, "dir0/", 71, filesPerDir+markers)
 518         }
 519 }
 520 func (s *IntegrationSuite) testS3List(c *check.C, bucket *s3.Bucket, prefix string, pageSize, expectFiles int) {
 521         c.Logf("testS3List: prefix=%q pageSize=%d S3FolderObjects=%v", prefix, pageSize, s.testServer.Config.cluster.Collections.S3FolderObjects)
 522         expectPageSize := pageSize
 523         if expectPageSize > 1000 {
 524                 expectPageSize = 1000
 525         }
 526         gotKeys := map[string]s3.Key{}
 527         nextMarker := ""
 528         pages := 0
 529         for {
 530                 resp, err := bucket.List(prefix, "", nextMarker, pageSize)
 531                 if !c.Check(err, check.IsNil) {
 532                         break
 533                 }
 534                 c.Check(len(resp.Contents) <= expectPageSize, check.Equals, true)
 535                 if pages++; !c.Check(pages <= (expectFiles/expectPageSize)+1, check.Equals, true) {
 536                         break
 537                 }
 538                 for _, key := range resp.Contents {
 539                         gotKeys[key.Key] = key
 540                         if strings.Contains(key.Key, "sailboat.txt") {
 541                                 c.Check(key.Size, check.Equals, int64(4))
 542                         }
 543                 }
 544                 if !resp.IsTruncated {
 545                         c.Check(resp.NextMarker, check.Equals, "")
 546                         break
 547                 }
 548                 if !c.Check(resp.NextMarker, check.Not(check.Equals), "") {
 549                         break
 550                 }
 551                 nextMarker = resp.NextMarker
 552         }
 553         c.Check(len(gotKeys), check.Equals, expectFiles)
 554 }
 555
 556 func (s *IntegrationSuite) TestS3CollectionListRollup(c *check.C) {
 557         for _, s.testServer.Config.cluster.Collections.S3FolderObjects = range []bool{false, true} {
 558                 s.testS3CollectionListRollup(c)
 559         }
 560 }
 561
 562 func (s *IntegrationSuite) testS3CollectionListRollup(c *check.C) {
 563         stage := s.s3setup(c)
 564         defer stage.teardown(c)
 565
 566         dirs := 2
 567         filesPerDir := 500
 568         stage.writeBigDirs(c, dirs, filesPerDir)
 569         err := stage.collbucket.PutReader("dingbats", &bytes.Buffer{}, 0, "application/octet-stream", s3.Private, s3.Options{})
 570         c.Assert(err, check.IsNil)
 571         var allfiles []string
 572         for marker := ""; ; {
 573                 resp, err := stage.collbucket.List("", "", marker, 20000)
 574                 c.Check(err, check.IsNil)
 575                 for _, key := range resp.Contents {
 576                         if len(allfiles) == 0 || allfiles[len(allfiles)-1] != key.Key {
 577                                 allfiles = append(allfiles, key.Key)
 578                         }
 579                 }
 580                 marker = resp.NextMarker
 581                 if marker == "" {
 582                         break
 583                 }
 584         }
 585         markers := 0
 586         if s.testServer.Config.cluster.Collections.S3FolderObjects {
 587                 markers = 1
 588         }
 589         c.Check(allfiles, check.HasLen, dirs*(filesPerDir+markers)+3+markers)
 590
 591         gotDirMarker := map[string]bool{}
 592         for _, name := range allfiles {
 593                 isDirMarker := strings.HasSuffix(name, "/")
 594                 if markers == 0 {
 595                         c.Check(isDirMarker, check.Equals, false, check.Commentf("name %q", name))
 596                 } else if isDirMarker {
 597                         gotDirMarker[name] = true
 598                 } else if i := strings.LastIndex(name, "/"); i >= 0 {
 599                         c.Check(gotDirMarker[name[:i+1]], check.Equals, true, check.Commentf("name %q", name))
 600                         gotDirMarker[name[:i+1]] = true // skip redundant complaints about this dir marker
 601                 }
 602         }
 603
 604         for _, trial := range []struct {
 605                 prefix    string
 606                 delimiter string
 607                 marker    string
 608         }{
 609                 {"", "", ""},
 610                 {"di", "/", ""},
 611                 {"di", "r", ""},
 612                 {"di", "n", ""},
 613                 {"dir0", "/", ""},
 614                 {"dir0/", "/", ""},
 615                 {"dir0/f", "/", ""},
 616                 {"dir0", "", ""},
 617                 {"dir0/", "", ""},
 618                 {"dir0/f", "", ""},
 619                 {"dir0", "/", "dir0/file14.txt"},       // no commonprefixes
 620                 {"", "", "dir0/file14.txt"},            // middle page, skip walking dir1
 621                 {"", "", "dir1/file14.txt"},            // middle page, skip walking dir0
 622                 {"", "", "dir1/file498.txt"},           // last page of results
 623                 {"dir1/file", "", "dir1/file498.txt"},  // last page of results, with prefix
 624                 {"dir1/file", "/", "dir1/file498.txt"}, // last page of results, with prefix + delimiter
 625                 {"dir1", "Z", "dir1/file498.txt"},      // delimiter "Z" never appears
 626                 {"dir2", "/", ""},                      // prefix "dir2" does not exist
 627                 {"", "/", ""},
 628         } {
 629                 c.Logf("\n\n=== trial %+v markers=%d", trial, markers)
 630
 631                 maxKeys := 20
 632                 resp, err := stage.collbucket.List(trial.prefix, trial.delimiter, trial.marker, maxKeys)
 633                 c.Check(err, check.IsNil)
 634                 if resp.IsTruncated && trial.delimiter == "" {
 635                         // goamz List method fills in the missing
 636                         // NextMarker field if resp.IsTruncated, so
 637                         // now we can't really tell whether it was
 638                         // sent by the server or by goamz. In cases
 639                         // where it should be empty but isn't, assume
 640                         // it's goamz's fault.
 641                         resp.NextMarker = ""
 642                 }
 643
 644                 var expectKeys []string
 645                 var expectPrefixes []string
 646                 var expectNextMarker string
 647                 var expectTruncated bool
 648                 for _, key := range allfiles {
 649                         full := len(expectKeys)+len(expectPrefixes) >= maxKeys
 650                         if !strings.HasPrefix(key, trial.prefix) || key < trial.marker {
 651                                 continue
 652                         } else if idx := strings.Index(key[len(trial.prefix):], trial.delimiter); trial.delimiter != "" && idx >= 0 {
 653                                 prefix := key[:len(trial.prefix)+idx+1]
 654                                 if len(expectPrefixes) > 0 && expectPrefixes[len(expectPrefixes)-1] == prefix {
 655                                         // same prefix as previous key
 656                                 } else if full {
 657                                         expectNextMarker = key
 658                                         expectTruncated = true
 659                                 } else {
 660                                         expectPrefixes = append(expectPrefixes, prefix)
 661                                 }
 662                         } else if full {
 663                                 if trial.delimiter != "" {
 664                                         expectNextMarker = key
 665                                 }
 666                                 expectTruncated = true
 667                                 break
 668                         } else {
 669                                 expectKeys = append(expectKeys, key)
 670                         }
 671                 }
 672
 673                 var gotKeys []string
 674                 for _, key := range resp.Contents {
 675                         gotKeys = append(gotKeys, key.Key)
 676                 }
 677                 var gotPrefixes []string
 678                 for _, prefix := range resp.CommonPrefixes {
 679                         gotPrefixes = append(gotPrefixes, prefix)
 680                 }
 681                 commentf := check.Commentf("trial %+v markers=%d", trial, markers)
 682                 c.Check(gotKeys, check.DeepEquals, expectKeys, commentf)
 683                 c.Check(gotPrefixes, check.DeepEquals, expectPrefixes, commentf)
 684                 c.Check(resp.NextMarker, check.Equals, expectNextMarker, commentf)
 685                 c.Check(resp.IsTruncated, check.Equals, expectTruncated, commentf)
 686                 c.Logf("=== trial %+v keys %q prefixes %q nextMarker %q", trial, gotKeys, gotPrefixes, resp.NextMarker)
 687         }
 688 }
 689
 690 // TestS3cmd checks compatibility with the s3cmd command line tool, if
 691 // it's installed. As of Debian buster, s3cmd is only in backports, so
 692 // `arvados-server install` don't install it, and this test skips if
 693 // it's not installed.
 694 func (s *IntegrationSuite) TestS3cmd(c *check.C) {
 695         if _, err := exec.LookPath("s3cmd"); err != nil {
 696                 c.Skip("s3cmd not found")
 697                 return
 698         }
 699
 700         stage := s.s3setup(c)
 701         defer stage.teardown(c)
 702
 703         cmd := exec.Command("s3cmd", "--no-ssl", "--host="+s.testServer.Addr, "--host-bucket="+s.testServer.Addr, "--access_key="+arvadostest.ActiveTokenUUID, "--secret_key="+arvadostest.ActiveToken, "ls", "s3://"+arvadostest.FooCollection)
 704         buf, err := cmd.CombinedOutput()
 705         c.Check(err, check.IsNil)
 706         c.Check(string(buf), check.Matches, `.* 3 +s3://`+arvadostest.FooCollection+`/foo\n`)
 707 }