JUnitでAmazon S3 Clientの返却値を指定したい

Question

ご覧頂き、ありがとうございます！

実現したいこと

Amazon S3Clientを利用したソースコードのテストを作成しています。
S3Client.listObjects()の返却値によって、後続処理で分岐している箇所のテストを行いたいですが、どのように返却値を指定すればいいのかわからないためご教授いただければ幸いです。

該当のソースコード

テスト対象クラス

public class TargetClass {
  @Autowired
  private S3Client s3Client;

  public String mainMethod(String bucketName, String prefix) {
    ListObjectsResponse objectList = listObjects(bucketName, prefix);
    List<S3Object> s3Object = objectList.contents();

    if (s3Object.isEmpty()) {
      return "object is empty";
    } else {
      return "object is NOT empty";
    }
  }

  private ListObjectsResponse listObjects(String bucketName, String prefix) {
    ListObjectsRequest listObjectsRequest = ListObjectsRequest
        .builder()
        .bucket(bucketName)
        .prefix(prefix)
        .build();

    LOGGER.info("List file from S3 for prefix: {}/{}", bucketName, prefix);
    try {
      return s3Client.listObjects(listObjectsRequest);
    } catch (SdkServiceException ase) {
      LOGGER
          .error(
              "List file  request for prefix: {}, was rejected with an error",
              prefix);
      throw new CustomException(ase);
    } catch (SdkClientException ace) {
      LOGGER
          .error(
              "Client encountered an internal error while trying to communicate with STaaS for list file request with prefix {}",
              prefix);
      throw new CustomException(ase);
    }
  }
}

テストクラス

@RunWith(PowerMockRunner.class)
public class TestTargetClass {

  @Mock
  S3Client s3ClientMock;

  @InjectMocks
  TargetClass _target;

  @Test
  public void test1() throws Exception {
    // S3Object がEmptyの場合
    String bucketName = "bucketName";
    String prefix = "prefix";

    when(s3ClientMock.listObjects(any())).thenReturn(); // contentsがnullのListObjectsResponseを生成して返却したい
    String actual = _target.mainMethod(bucketName, prefix);

    assertThat(actual, is("object is empty");
  }

  @Test
  public void test2() throws Exception {
    // S3Object がEmptyではない場合
    String bucketName = "bucketName";
    String prefix = "prefix";

    when(s3ClientMock.listObjects(any())).thenReturn(); // contentsがnullではないListObjectsResponseを生成して返却したい
    String actual = _target.mainMethod(bucketName, prefix);

    assertThat(actual, is("object is Not empty");
  }
}

試したこと

/**
* ListObjectsResponseをinstance化
*/
ListObjectsResponse response = new ListObjectsResponse();
// 'ListObjectsResponse(software.amazon.awssdk.services.s3.model.ListObjectsResponse.BuilderImpl)' has private access in 'software.amazon.awssdk.services.s3.model.ListObjectsResponse'

Answer 1

S3Clientを利用しているTargetClassをテストする際、S3Client.listObjects()の返却値を制御する必要があります。

次のようにS3Clientをモック化して、S3Client.listObjects()の返却値を指定することができます。

@Mock
S3Client s3ClientMock;

@InjectMocks
TargetClass _target;

...

when(s3ClientMock.listObjects).thenReturn(指定したいListObjectsResponse);

ここで、指定したいListObjectsResponseは、contentsがemptyかどうかによって異なります。

test1()では、emptyのListObjectsResponseを生成して返却させます。

@Test
public void test1() throws Exception {
  // S3Object がemptyの場合
  ...

  when(s3ClientMock.listObjects).thenReturn(emptyのListObjectsResponse);
  String actual = _target.mainMethod(bucketName, prefix);

  assertThat(actual, is("object is empty");
}

test2()では、emptyではないListObjectsResponseを生成して返却させます。

@Test
public void test2() throws Exception {
  // S3Object がemptyではない場合
  ...

  when(s3ClientMock.listObjects).thenReturn(emptyではないListObjectsResponse);
  String actual = _target.mainMethod(bucketName, prefix);

  assertThat(actual, is("object is Not empty");
}

Comments

[yamame01]

コメントありがとうございます！！
＞emptyのListObjectsResponse
＞emptyではないListObjectsResponse
はそれぞれどのように生成すればいいのでしょうか？

[somak]

JavaでemptyのListObjectsResponseを生成するには、以下のようにします。
```
ListObjectsResponse emptyResponse = ListObjectsResponse
.builder()
.contents(Collections.emptyList())
.build();
```
ここで、Collections.emptyList()は空のリストを生成するためのメソッドです。

emptyではないListObjectsResponseを生成するには、S3Objectを含むListObjectsResponseインスタンスを生成する必要があります。

例:

```
List<S3Object> s3Objects = new ArrayList<>();
s3Objects.add(new S3Object("key1", "value1"));
s3Objects.add(new S3Object("key2", "value2"));

ListObjectsResponse response = ListObjectsResponse.builder().contents(s3Objects).build();
```

このように、必要な数のS3Objectを含むListを作成して、それをcontentsとして持つListObjectsResponseインスタンスを生成することができます。

[yamame01]

Collections.emptyList()
は初めて知りました！
教えていただいた方法で、正しくテストすることができました。
ありがとうございました！