versitygw/tests/util/util_bucket.sh

#!/usr/bin/env bash

source ./tests/util/util_acl.sh
source ./tests/util/util_multipart_abort.sh
source ./tests/util/util_policy.sh
source ./tests/util/util_retention.sh

# recursively delete an AWS bucket
# param:  client, bucket name
# fail if error
delete_bucket_recursive() {
  log 6 "delete_bucket_recursive"
  if [ $# -ne 2 ]; then
    log 2 "'delete_bucket_recursive' requires client, bucket name"
    return 1
  fi

  local exit_code=0
  local error
  if [[ $1 == 's3' ]]; then
    error=$(aws --no-verify-ssl s3 rb s3://"$2" --force 2>&1) || exit_code="$?"
  elif [[ $1 == 's3api' ]]; then
    if ! delete_bucket_recursive_s3api "$2"; then
      log 2 "error deleting bucket recursively (s3api)"
      return 1
    fi
    return 0
  elif [[ $1 == "s3cmd" ]]; then
    error=$(s3cmd "${S3CMD_OPTS[@]}" --no-check-certificate rb s3://"$2" --recursive 2>&1) || exit_code="$?"
  elif [[ $1 == "mc" ]]; then
    error=$(delete_bucket_recursive_mc "$2" 2>&1) || exit_code="$?"
  else
    log 2 "invalid client '$1'"
    return 1
  fi

  if [ $exit_code -ne 0 ]; then
    if [[ "$error" == *"The specified bucket does not exist"* ]]; then
      return 0
    else
      log 2 "error deleting bucket recursively: $error"
      return 1
    fi
  fi
  return 0
}

# restore bucket to pre-test state (or prep for deletion)
# param: bucket name
# return 0 on success, 1 on error
clear_bucket_s3api() {
  log 6 "clear_bucket_s3api"
  if [ $# -ne 1 ]; then
    log 2 "'clear_bucket_s3api' requires bucket name"
    return 1
  fi

  if [[ $LOG_LEVEL_INT -ge 5 ]]; then
    if ! log_bucket_policy "$1"; then
      log 2 "error logging bucket policy"
      return 1
    fi
  fi

  if ! check_object_lock_config "$1"; then
    log 2 "error checking object lock config"
    return 1
  fi

  if [[ "$DIRECT" != "true" ]] && ! add_governance_bypass_policy "$1"; then
    log 2 "error adding governance bypass policy"
    return 1
  fi

  if ! list_and_delete_objects "$1"; then
    log 2 "error listing and deleting objects"
    return 1
  fi

  if ! check_ownership_rule_and_reset_acl "$1"; then
    log 2 "error checking ownership rule and resetting acl"
    return 1
  fi

  # shellcheck disable=SC2154
  if [[ $lock_config_exists == true ]] && ! put_object_lock_configuration_disabled "$1"; then
    log 2 "error disabling object lock config"
    return 1
  fi

  if [ "$RUN_USERS" == "true" ] && ! change_bucket_owner "$AWS_ACCESS_KEY_ID" "$AWS_SECRET_ACCESS_KEY" "$1" "$AWS_ACCESS_KEY_ID"; then
    log 2 "error changing bucket owner back to root"
    return 1
  fi
}

# params:  bucket name
# return 0 if able to delete recursively, 1 if not
delete_bucket_recursive_s3api() {
  log 6 "delete_bucket_recursive_s3api"
  if [ $# -ne 1 ]; then
    log 2 "'delete_bucket_recursive_s3api' requires bucket name"
    return 1
  fi

  if ! clear_bucket_s3api "$1"; then
    log 2 "error clearing bucket (s3api)"
    return 1
  fi

  if ! delete_bucket 's3api' "$1"; then
    log 2 "error deleting bucket"
    return 1
  fi
  return 0
}

# params: client, bucket name
# return 0 on success, 1 on error
delete_bucket_contents() {
  log 6 "delete_bucket_contents"
  if [ $# -ne 2 ]; then
    log 2 "'delete_bucket_contents' requires client, bucket name"
    return 1
  fi

  local exit_code=0
  local error
  if [[ $1 == 's3api' ]]; then
    if ! clear_bucket_s3api "$2"; then
      log 2 "error clearing bucket (s3api)"
      return 1
    fi
  elif [[ $1 == "s3cmd" ]]; then
    delete_bucket_recursive "s3cmd" "$1"
  elif [[ $1 == "mc" ]]; then
    delete_bucket_recursive "mc" "$1"
  elif [[ $1 == "s3" ]]; then
    delete_bucket_recursive "s3" "$1"
  else
    log 2 "unrecognized client: '$1'"
    return 1
  fi
  return 0
}

# check if bucket exists
# param:  bucket name
# return 0 for true, 1 for false, 2 for error
bucket_exists() {
  if [ $# -ne 2 ]; then
    log 2 "bucket_exists command requires client, bucket name"
    return 2
  fi
  local exists=0
  head_bucket "$1" "$2" || exists=$?
  # shellcheck disable=SC2181
  if [ $exists -ne 0 ] && [ $exists -ne 1 ]; then
    log 2 "unexpected error checking if bucket exists"
    return 2
  fi
  if [ $exists -eq 0 ]; then
    return 0
  fi
  return 1
}

# params:  client, bucket name
# return 0 for success, 1 for error
bucket_cleanup() {
  log 6 "bucket_cleanup"
  if [ $# -ne 2 ]; then
    log 2 "'bucket_cleanup' requires client, bucket name"
    return 1
  fi
  if [[ $RECREATE_BUCKETS == "false" ]]; then
    if ! delete_bucket_contents "$1" "$2"; then
      log 2 "error deleting bucket contents"
      return 1
    fi

    if ! delete_bucket_policy "$1" "$2"; then
      log 2 "error deleting bucket policy"
      return 1
    fi

    if ! get_object_ownership_rule_and_update_acl "$2"; then
      log 2 "error getting object ownership rule and updating ACL"
      return 1
    fi

    if ! abort_all_multipart_uploads "$2"; then
      log 2 "error aborting all multipart uploads"
      return 1
    fi

    if [ "$RUN_USERS" == "true" ] && ! reset_bucket_owner "$2"; then
      log 2 "error resetting bucket owner"
      return 1
    fi

    log 5 "bucket contents, policy, ACL deletion success"
    return 0
  fi
  if ! delete_bucket_recursive "$1" "$2"; then
    log 2 "error with recursive bucket delete"
    return 1
  fi
  log 5 "bucket deletion success"
  return 0
}

# params: client, bucket name
# return 0 for success, 1 for error
bucket_cleanup_if_bucket_exists() {
  log 6 "bucket_cleanup_if_bucket_exists"
  if [ $# -lt 2 ]; then
    log 2 "'bucket_cleanup_if_bucket_exists' requires client, bucket name, bucket known to exist (optional)"
    return 1
  fi

  if [ "$3" == "true" ] || bucket_exists "$1" "$2"; then
    if ! bucket_cleanup "$1" "$2"; then
      log 2 "error deleting bucket and/or contents"
      return 1
    fi
    log 5 "bucket and/or bucket data deletion success"
    return 0
  fi
  return 0
}

# params:  client, bucket name(s)
# return 0 for success, 1 for failure
setup_buckets() {
  if [ $# -lt 2 ]; then
    log 2 "'setup_buckets' command requires client, bucket names"
    return 1
  fi
  for name in "${@:2}"; do
    if ! setup_bucket "$1" "$name"; then
      log 2 "error setting up bucket $name"
      return 1
    fi
  done
  return 0
}

# params:  client, bucket name
# return 0 on successful setup, 1 on error
setup_bucket() {
  log 6 "setup_bucket"
  if [ $# -ne 2 ]; then
    log 2 "'setup_bucket' requires client, bucket name"
    return 1
  fi

  bucket_exists="true"
  if ! bucket_exists "$1" "$2"; then
    if [[ $RECREATE_BUCKETS == "false" ]]; then
      log 2 "When RECREATE_BUCKETS isn't set to \"true\", buckets should be pre-created by user"
      return 1
    fi
    bucket_exists="false"
  fi

  if ! bucket_cleanup_if_bucket_exists "$1" "$2" "$bucket_exists"; then
    log 2 "error deleting bucket or contents if they exist"
    return 1
  fi

  log 5 "util.setup_bucket: command type: $1, bucket name: $2"
  if [[ $RECREATE_BUCKETS == "true" ]]; then
    if ! create_bucket "$1" "$2"; then
      log 2 "error creating bucket"
      return 1
    fi
  else
    log 5 "skipping bucket re-creation"
  fi

  if [[ $1 == "s3cmd" ]]; then
    log 5 "putting bucket ownership controls"
    if bucket_exists "s3cmd" "$2" && ! put_bucket_ownership_controls "$2" "BucketOwnerPreferred"; then
      log 2 "error putting bucket ownership controls"
      return 1
    fi
  fi
  return 0
}

# check if bucket info can be retrieved
# param:  path of bucket or folder
# return 0 for yes, 1 for no, 2 for error
bucket_is_accessible() {
  if [ $# -ne 1 ]; then
    log 2 "bucket accessibility check missing bucket name"
    return 2
  fi
  local exit_code=0
  local error
  error=$(aws --no-verify-ssl s3api head-bucket --bucket "$1" 2>&1) || exit_code="$?"
  if [ $exit_code -eq 0 ]; then
    return 0
  fi
  if [[ "$error" == *"500"* ]]; then
    return 1
  fi
  log 2 "Error checking bucket accessibility: $error"
  return 2
}

check_for_empty_region() {
  if [ $# -ne 1 ]; then
    log 2 "'check_for_empty_region' requires bucket name"
    return 1
  fi
  if ! head_bucket "s3api" "$BUCKET_ONE_NAME"; then
    log 2 "error getting bucket info"
    return 1
  fi
  # shellcheck disable=SC2154
  log 5 "INFO:  $bucket_info"
  if ! region=$(echo "$bucket_info" | grep -v "InsecureRequestWarning" | jq -r ".BucketRegion" 2>&1); then
    log 2 "error getting region: $region"
    return 1
  fi
  if [[ $region == "" ]]; then
    log 2 "empty bucket region"
    return 1
  fi
  return 0
}