如何Mock AWS S3的getObjectAsBytes方法编写单元测试？

要Mock s3Client.getObjectAsBytes 并生成ResponseBytes<GetObjectResponse>模拟响应，可借助Mockito框架实现，以下是具体步骤和代码示例：

核心思路 #

1. 利用AWS SDK提供的ResponseBytes.fromInputStream静态方法，直接构造包含测试输入流的ResponseBytes实例，无需额外Mock该类的方法
2. 通过Mockito配置S3Client的Mock行为，使其调用getObjectAsBytes时返回预设的ResponseBytes对象

实现步骤及代码示例 #

1. 确保测试依赖（以Maven为例） #

在pom.xml中引入Mockito依赖：

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>4.11.0</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-junit-jupiter</artifactId>
    <version>4.11.0</version>
    <scope>test</scope>
</dependency>

2. 编写单元测试代码 #

假设你的业务逻辑封装在S3ObjectFetcher类中，测试类示例如下：

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.stream.Collectors;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import static org.junit.jupiter.api.Assertions.assertEquals;

@ExtendWith(MockitoExtension.class)
public class S3ObjectFetcherTest {

    @Mock
    private S3Client s3Client;

    // 模拟你要测试的业务方法逻辑
    private String fetchObject(String bucketName, String keyName) {
        GetObjectRequest objectRequest = GetObjectRequest
                .builder()
                .key(keyName)
                .bucket(bucketName)
                .build();

        ResponseBytes<GetObjectResponse> objectBytes = s3Client.getObjectAsBytes(objectRequest);
        InputStream inputStream = objectBytes.asInputStream();
        return new BufferedReader(new InputStreamReader(inputStream))
                .lines().collect(Collectors.joining("\n"));
    }

    @Test
    public void testFetchObject_Success() {
        // 准备测试数据
        String expectedContent = "第一行测试内容\n第二行测试内容";
        InputStream testStream = new ByteArrayInputStream(expectedContent.getBytes(StandardCharsets.UTF_8));

        // 构造模拟的ResponseBytes对象
        ResponseBytes<GetObjectResponse> mockResponseBytes = ResponseBytes.fromInputStream(
                GetObjectResponse.builder().build(), testStream);

        // 配置Mock行为
        when(s3Client.getObjectAsBytes(any(GetObjectRequest.class))).thenReturn(mockResponseBytes);

        // 执行测试并验证结果
        String actualContent = fetchObject("test-bucket", "test-key");
        assertEquals(expectedContent, actualContent);
    }
}

关键说明 #

• 无需Mock ResponseBytes的内部方法：AWS SDK提供的ResponseBytes.fromInputStream可以直接生成可用的实例，避免复杂的Mock操作
• 灵活匹配请求参数：如果需要精确匹配GetObjectRequest的bucket和key，可将any(GetObjectRequest.class)替换为eq(GetObjectRequest.builder().bucket("test-bucket").key("test-key").build())
• 依赖注入：确保业务类通过构造函数或Setter注入S3Client，这样测试时能轻松传入Mock实例

内容的提问来源于stack exchange，提问作者Chetan Krishna