LocalStack을 활용한 Integration Test 환경 만들기

@Slf4j
@ExtendWith(LocalstackDockerExtension.class)
@LocalstackDockerProperties(services = {"s3"}, randomizePorts = true)
class LocalStackDockerExtensionTest {

    @Test
    void test() throws Exception {
        AmazonS3 s3 = DockerTestUtils.getClientS3();

        String bucketName = "test-s3";
        s3.createBucket(bucketName);
        log.info("버킷을 생성했습니다. bucketName={}", bucketName);

        String content = "Hello World";
        String key = "s3-key";
        s3.putObject(bucketName, key, content);
        log.info("파일을 업로드하였습니다. bucketName={}, key={}, content={}", bucketName, key, content);

        List<String> results = IOUtils.readLines(s3.getObject(bucketName, key).getObjectContent(), "utf-8");
        log.info("파일을 가져왔습니다. bucketName={}, key={}, results={}", bucketName, key, results);

        assertThat(results).hasSize(1);
        assertThat(results.get(0)).isEqualTo(content);
    }
}

@Slf4j
@Testcontainers
class LocalStackTestcontainerTest {

    @Container
    LocalStackContainer container = new LocalStackContainer()
            .withServices(LocalStackContainer.Service.S3);

    @Test
    void test() throws Exception {
        AmazonS3 s3 = AmazonS3ClientBuilder.standard()
                .withEndpointConfiguration(container.getEndpointConfiguration(LocalStackContainer.Service.S3))
                .withCredentials(container.getDefaultCredentialsProvider())
                .build();

        String bucketName = "test-s3";
        s3.createBucket(bucketName);
        log.info("버킷을 생성했습니다. bucketName={}", bucketName);

        String content = "Hello World";
        String key = "s3-key";
        s3.putObject(bucketName, key, content);
        log.info("파일을 업로드하였습니다. bucketName={}, key={}, content={}", bucketName, key, content);

        List<String> results = IOUtils.readLines(s3.getObject(bucketName, key).getObjectContent(), "utf-8");
        log.info("파일을 가져왔습니다. bucketName={}, key={}, results={}", bucketName, key, results);

        assertThat(results).hasSize(1);
        assertThat(results.get(0)).isEqualTo(content);
    }
}

@TestConfiguration
public class LocalStackS3Config {
    @Bean(initMethod = "start", destroyMethod = "stop")
    public LocalStackContainer localStackContainer() {
        return new LocalStackContainer()
                .withServices(LocalStackContainer.Service.S3);
    }

    @Bean
    public AmazonS3 amazonS3(LocalStackContainer localStackContainer) {
        return AmazonS3ClientBuilder.standard()
                .withEndpointConfiguration(localStackContainer.getEndpointConfiguration(LocalStackContainer.Service.S3))
                .withCredentials(localStackContainer.getDefaultCredentialsProvider())
                .build();
    }
}

@Slf4j
@Tag("integration")
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = LocalStackS3Config.class)
class WallControllerIntegrationTest {

    @Autowired
    TestRestTemplate testRestTemplate;

    @Autowired
    AmazonS3 amazonS3;

    @BeforeEach
    void init() {
        amazonS3.createBucket(WallController.BUCKET_WALL_CONTENT); 
    }

    @Test
    void test() throws Exception {
        String id = "gaemi";
        String content = "Hello World";
        PostRequest postRequest = new PostRequest();
        postRequest.setContent(content);

        String createResponse = testRestTemplate.postForObject("/wall/{id}", postRequest, String.class, id);
        log.info("createResponse={}", createResponse);
        assertThat(createResponse).isNotBlank();

        String getResponse = testRestTemplate.getForObject("/wall/{id}", String.class, id);
        log.info("getResponse={}", getResponse);
        assertThat(getResponse).isEqualTo(content);
    }
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(AwsLocalStackConfig.class)
public @interface EnableAwsLocalStack {
    LocalStackContainer.Service[] value();
}

@Configuration
public class AwsLocalStackConfig implements ImportAware {
    private AnnotationAttributes annotationAttributes;

    @Override
    public void setImportMetadata(AnnotationMetadata importMetadata) {
        this.annotationAttributes = AnnotationAttributes.fromMap(importMetadata
                .getAnnotationAttributes(EnableAwsLocalStack.class.getName(), false));
        Assert.notNull(this.annotationAttributes,
                "@EnableAwsLocalStack is not present on importing class "
                        + importMetadata.getClassName());
    }

    @Bean(initMethod = "start", destroyMethod = "stop")
    public LocalStackContainer localStackContainer() {
        LocalStackContainer.Service[] values = (LocalStackContainer.Service[]) annotationAttributes.get("value");
        Assert.isTrue(values.length > 0, "LocalStack 을 사용할 서비스를 하나 이상 선택하여야 합니다.");

        return new LocalStackContainer().withServices(values);
    }
}

@EnableAwsLocalStack({S3})
@TestConfiguration
public class LocalStackS3Config {
    @Bean
    public AmazonS3 amazonS3(LocalStackContainer localStackContainer) {
        return AmazonS3ClientBuilder.standard()
                .withEndpointConfiguration(localStackContainer.getEndpointConfiguration(LocalStackContainer.Service.S3))
                .withCredentials(localStackContainer.getDefaultCredentialsProvider())
                .build();
    }
}

@Profile("!local")
@EnableDynamoDBRepositories(basePackages = {"io.github.woowabros.step2.domain"})
@Configuration
public class DynamoDBConfig {
    @Bean
    public AmazonDynamoDB amazonDynamoDB() {
        return AmazonDynamoDBClientBuilder.standard()
                .withRegion(Regions.AP_NORTHEAST_2)
                .build();
    }
}

@Profile("local")
@EnableAwsLocalStack({DYNAMODB})
@EnableDynamoDBRepositories(basePackages = {"io.github.woowabros.step2.domain"})
@Configuration
public class DynamoDBLocalConfig {
    @Bean
    public AmazonDynamoDB amazonDynamoDB(LocalStackContainer localStackContainer) {
        return AmazonDynamoDBClientBuilder.standard()
                .withEndpointConfiguration(localStackContainer.getEndpointConfiguration(DYNAMODB))
                .withCredentials(localStackContainer.getDefaultCredentialsProvider())
                .build();
    }
}

@Configuration
public class SqsConfig {
    @Bean
    public AmazonSQSAsync amazonSQS() {
        return AmazonSQSAsyncClientBuilder.standard()
                .withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration("http://localhost:4576", "us-east-1"))
                .withCredentials(new AWSStaticCredentialsProvider(new BasicAWSCredentials("accesskey", "secretkey")))
                .build();
    }
}

@Slf4j
@Service
public class MessageSubscriber {
    @SqsListener(value = "test-message", deletionPolicy = SqsMessageDeletionPolicy.ON_SUCCESS)
    public void receive(String message) {
        log.info("메시지를 받았습니다. message={}", message);
    }
}