Implement ListMultipartUploads (#171)

Implement ListMultipartUploads, also refactor ListObjects and ListObjectsV2.

It took me some times as I wanted to propose the following things:
  - Using an iterator instead of the loop+goto pattern. I find it easier to read and it should enable some optimizations. For example, when consuming keys of a common prefix, we do many [redundant checks](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/api/s3_list.rs#L125-L156) while the only thing to do is to [check if the following key is still part of the common prefix](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/feature/s3-multipart-compat/src/api/s3_list.rs#L476).
  - Try to name things (see ExtractionResult and RangeBegin enums) and to separate concerns (see ListQuery and Accumulator)
  - An IO closure to make unit tests possibles.
  - Unit tests, to track regressions and document how to interact with the code
  - Integration tests with `s3api`. In the future, I would like to move them in Rust with the aws rust SDK.

Merging of the logic of ListMultipartUploads and ListObjects was not a goal but a consequence of the previous modifications.

Some points that we might want to discuss:
  - ListObjectsV1, when using pagination and delimiters, has a weird behavior (it lists multiple times the same prefix) with `aws s3api` due to the fact that it can not use our optimization to skip the whole prefix. It is independant from my refactor and can be tested with the commented `s3api` tests in `test-smoke.sh`. It probably has the same weird behavior on the official AWS S3 implementation.
  - Considering ListMultipartUploads, I had to "abuse" upload id marker to support prefix skipping. I send an `upload-id-marker` with the hardcoded value `include` to emulate your "including" token.
  - Some ways to test ListMultipartUploads with existing software (my tests are limited to s3api for now).

Co-authored-by: Quentin Dufour <quentin@deuxfleurs.fr>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/171
Co-authored-by: Quentin <quentin@dufour.io>
Co-committed-by: Quentin <quentin@dufour.io>

1 files changed, 139 insertions, 1 deletions

diff --git a/script/test-smoke.sh b/script/test-smoke.sh
index 1f900ece..2505ae38 100755
--- a/script/test-smoke.sh
+++ b/script/test-smoke.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -ex
 
@@ -10,6 +10,7 @@ GARAGE_DEBUG="${REPO_FOLDER}/target/debug/"
 GARAGE_RELEASE="${REPO_FOLDER}/target/release/"
 NIX_RELEASE="${REPO_FOLDER}/result/bin/"
 PATH="${GARAGE_DEBUG}:${GARAGE_RELEASE}:${NIX_RELEASE}:$PATH"
+CMDOUT=/tmp/garage.cmd.tmp
 
 # @FIXME Duck is not ready for testing, we have a bug
 SKIP_DUCK=1
@@ -131,6 +132,142 @@ if [ -z "$SKIP_AWS" ]; then
 fi
 
 if [ -z "$SKIP_AWS" ]; then
+  echo "🔌 Test S3API"
+
+  echo "Test Objects"
+  aws s3api put-object --bucket eprouvette --key a
+  aws s3api put-object --bucket eprouvette --key a/a
+  aws s3api put-object --bucket eprouvette --key a/b
+  aws s3api put-object --bucket eprouvette --key a/c
+  aws s3api put-object --bucket eprouvette --key a/d/a
+  aws s3api put-object --bucket eprouvette --key a/é
+  aws s3api put-object --bucket eprouvette --key b
+  aws s3api put-object --bucket eprouvette --key c
+
+
+  aws s3api list-objects-v2 --bucket eprouvette >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects-v2 --bucket eprouvette --page-size 0 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects-v2 --bucket eprouvette --page-size 999999999999999 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects-v2 --bucket eprouvette --page-size 1 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects-v2 --bucket eprouvette --delimiter '/' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 3 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-objects-v2 --bucket eprouvette --delimiter '/' --page-size 1 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 3 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-objects-v2 --bucket eprouvette --prefix 'a/' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 5 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects-v2 --bucket eprouvette --prefix 'a/' --delimiter '/' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 4 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-objects-v2 --bucket eprouvette --prefix 'a/' --page-size 1 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 5 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects-v2 --bucket eprouvette --prefix 'a/' --delimiter '/' --page-size 1 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 4 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-objects-v2 --bucket eprouvette --start-after 'Z' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects-v2 --bucket eprouvette --start-after 'c' >$CMDOUT
+  ! [ -s $CMDOUT ]
+
+
+  aws s3api list-objects --bucket eprouvette >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects --bucket eprouvette --page-size 1 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects --bucket eprouvette --delimiter '/' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 3 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  # @FIXME it does not work as expected but might be a limitation of aws s3api
+  # The problem is the conjunction of a delimiter + pagination + v1 of listobjects
+  #aws s3api list-objects --bucket eprouvette --delimiter '/' --page-size 1 >$CMDOUT
+  #[ $(jq '.Contents | length' $CMDOUT) == 3 ]
+  #[ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-objects --bucket eprouvette --prefix 'a/' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 5 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects --bucket eprouvette --prefix 'a/' --delimiter '/' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 4 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-objects --bucket eprouvette --prefix 'a/' --page-size 1 >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 5 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  # @FIXME idem
+  #aws s3api list-objects --bucket eprouvette --prefix 'a/' --delimiter '/' --page-size 1 >$CMDOUT
+  #[ $(jq '.Contents | length' $CMDOUT) == 4 ]
+  #[ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-objects --bucket eprouvette --starting-token 'Z' >$CMDOUT
+  [ $(jq '.Contents | length' $CMDOUT) == 8 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-objects --bucket eprouvette --starting-token 'c' >$CMDOUT
+  ! [ -s $CMDOUT ]
+
+  aws s3api list-objects-v2 --bucket eprouvette | \
+    jq -c '. | {Objects: [.Contents[] | {Key: .Key}], Quiet: true}' | \
+    aws s3api delete-objects --bucket eprouvette --delete file:///dev/stdin
+
+
+  echo "Test Multipart Upload"
+  aws s3api create-multipart-upload --bucket eprouvette --key a
+  aws s3api create-multipart-upload --bucket eprouvette --key a
+  aws s3api create-multipart-upload --bucket eprouvette --key c
+  aws s3api create-multipart-upload --bucket eprouvette --key c/a
+  aws s3api create-multipart-upload --bucket eprouvette --key c/b
+
+  aws s3api list-multipart-uploads --bucket eprouvette >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 5 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --page-size 1 >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 5 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --delimiter '/' >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 3 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --delimiter '/' --page-size 1 >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 3 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --prefix 'c' >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 3 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --prefix 'c' --page-size 1 >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 3 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --prefix 'c' --delimiter '/' >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 1 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --prefix 'c' --delimiter '/' --page-size 1 >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 1 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 1 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --starting-token 'ZZZZZ' >$CMDOUT
+  [ $(jq '.Uploads | length' $CMDOUT) == 5 ]
+  [ $(jq '.CommonPrefixes | length' $CMDOUT) == 0 ]
+  aws s3api list-multipart-uploads --bucket eprouvette --starting-token 'd' >$CMDOUT
+  ! [ -s $CMDOUT ]
+
+  aws s3api list-multipart-uploads --bucket eprouvette | \
+    jq -r '.Uploads[] | "\(.Key) \(.UploadId)"' | \
+    while read r; do 
+      key=$(echo $r|cut -d' ' -f 1); 
+      uid=$(echo $r|cut -d' ' -f 2); 
+      aws s3api abort-multipart-upload --bucket eprouvette --key $key --upload-id $uid;
+      echo "Deleted ${key}:${uid}"
+    done
+fi
+
+if [ -z "$SKIP_AWS" ]; then
   echo "🪣 Test bucket logic "
   AWS_ACCESS_KEY_ID=`cat /tmp/garage.s3 |cut -d' ' -f1`
   [ $(aws s3 ls | wc -l) == 1 ]
@@ -151,5 +288,6 @@ AWS_SECRET_ACCESS_KEY=`cat /tmp/garage.s3 |cut -d' ' -f2`
 garage -c /tmp/config.1.toml bucket deny --read --write eprouvette --key $AWS_ACCESS_KEY_ID
 garage -c /tmp/config.1.toml bucket delete --yes eprouvette
 garage -c /tmp/config.1.toml key delete --yes $AWS_ACCESS_KEY_ID
+exec 3>&-
 
 echo "✅ Success"