minio-rs/tests/s3/get_object.rs

// MinIO Rust Library for Amazon S3 Compatible Cloud Storage
// Copyright 2025 MinIO, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use bytes::Bytes;
use futures_util::TryStreamExt;
use minio::s3::response::{GetObjectResponse, PutObjectContentResponse};
use minio::s3::response_traits::{HasBucket, HasObject};
use minio::s3::types::{BucketName, ObjectKey, S3Api};
use minio_common::test_context::TestContext;
use minio_common::utils::rand_object_name_utf8;

async fn test_get_object(ctx: &TestContext, bucket: BucketName, object: ObjectKey) {
    let data: Bytes = Bytes::from("hello, world".to_string().into_bytes());
    let resp: PutObjectContentResponse = ctx
        .client
        .put_object_content(&bucket, &object, data.clone())
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();
    assert_eq!(resp.bucket(), Some(&bucket));
    assert_eq!(resp.object(), Some(&object));
    assert_eq!(resp.object_size(), data.len() as u64);

    let resp: GetObjectResponse = ctx
        .client
        .get_object(&bucket, &object)
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();
    assert_eq!(resp.bucket(), Some(&bucket));
    assert_eq!(resp.object(), Some(&object));
    assert_eq!(resp.object_size().unwrap(), data.len() as u64);

    let got = resp
        .content()
        .unwrap()
        .to_segmented_bytes()
        .await
        .unwrap()
        .to_bytes();
    assert_eq!(got, data);
}

/// Test getting an object with a name that contains utf-8 characters.
#[minio_macros::test]
async fn get_object_1(ctx: TestContext, bucket: BucketName) {
    let object: ObjectKey = rand_object_name_utf8(20);
    test_get_object(&ctx, bucket, object).await;
}

/// Test getting an object with a name that contains white space characters.
#[minio_macros::test]
async fn get_object_2(ctx: TestContext, bucket: BucketName) {
    test_get_object(&ctx, bucket, ObjectKey::try_from("a b+c").unwrap()).await;
}

/// Test into_bytes method for direct byte retrieval.
#[minio_macros::test]
async fn get_object_into_bytes(ctx: TestContext, bucket: BucketName) {
    let object = rand_object_name_utf8(20);
    let data: Bytes = Bytes::from("test data for into_bytes method");

    // Upload test object
    ctx.client
        .put_object_content(&bucket, &object, data.clone())
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    // Retrieve using into_bytes
    let resp: GetObjectResponse = ctx
        .client
        .get_object(&bucket, &object)
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    // Verify content-length before consuming
    assert_eq!(resp.object_size().unwrap(), data.len() as u64);

    // Get bytes directly
    let got = resp.into_bytes().await.unwrap();
    assert_eq!(got, data);
}

/// Test into_boxed_stream method for streaming access.
#[minio_macros::test]
async fn get_object_into_boxed_stream(ctx: TestContext, bucket: BucketName) {
    let object = rand_object_name_utf8(20);
    let data: Bytes = Bytes::from("test data for into_boxed_stream method");

    // Upload test object
    ctx.client
        .put_object_content(&bucket, &object, data.clone())
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    // Retrieve using into_boxed_stream
    let resp: GetObjectResponse = ctx
        .client
        .get_object(&bucket, &object)
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    // Get stream and content length
    let (stream, content_length) = resp.into_boxed_stream().unwrap();
    assert_eq!(content_length, data.len() as u64);

    // Collect all bytes from the stream
    let chunks: Vec<Bytes> = stream.try_collect().await.unwrap();
    let got: Bytes = chunks.into_iter().flatten().collect();
    assert_eq!(got, data);
}

/// Test into_boxed_stream with larger content to verify chunked streaming.
#[minio_macros::test]
async fn get_object_into_boxed_stream_large(ctx: TestContext, bucket: BucketName) {
    let object = rand_object_name_utf8(20);
    // Create larger test data (1MB) to ensure multiple chunks
    let data: Bytes = Bytes::from(vec![0xABu8; 1024 * 1024]);

    // Upload test object
    ctx.client
        .put_object_content(&bucket, &object, data.clone())
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    // Retrieve using into_boxed_stream
    let resp: GetObjectResponse = ctx
        .client
        .get_object(&bucket, &object)
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    let (stream, content_length) = resp.into_boxed_stream().unwrap();
    assert_eq!(content_length, data.len() as u64);

    // Collect and verify
    let chunks: Vec<Bytes> = stream.try_collect().await.unwrap();
    let got: Bytes = chunks.into_iter().flatten().collect();
    assert_eq!(got.len(), data.len());
    assert_eq!(got, data);
}

/// Test into_bytes with empty content.
#[minio_macros::test]
async fn get_object_into_bytes_empty(ctx: TestContext, bucket: BucketName) {
    let object = rand_object_name_utf8(20);
    let data: Bytes = Bytes::new();

    // Upload empty object
    ctx.client
        .put_object_content(&bucket, &object, data.clone())
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    // Retrieve using into_bytes
    let resp: GetObjectResponse = ctx
        .client
        .get_object(&bucket, &object)
        .unwrap()
        .build()
        .send()
        .await
        .unwrap();

    assert_eq!(resp.object_size().unwrap(), 0);
    let got = resp.into_bytes().await.unwrap();
    assert!(got.is_empty());
}