DynamoDB local使ったローカル開発・テスト環境を構築してみた

dynamodb-local-sample/
├── build.gradle.kts
├── docker-compose.yml                  ← ローカル開発用
├── src/main/java/com/example/dynamodbsample/
│   ├── Application.java
│   ├── config/DynamoDbConfig.java      ← DynamoDB接続設定
│   ├── model/Book.java                 ← モデル
│   ├── dao/BookMapper.java             ← CRUD操作
│   ├── controller/BookController.java  ← REST API
│   └── init/DynamoDbTableInitializer.java  ← テーブル自動作成
├── src/main/resources/
│   ├── application.yaml                ← デフォルト設定
│   └── application-local.yaml          ← ローカル開発用設定
└── src/test/java/com/example/dynamodbsample/
    ├── DynamoDbTestConfig.java         ← Testcontainers設定
    ├── DynamoDbTableHelper.java        ← テスト用ヘルパー
    └── dao/BookMapperTest.java         ← テストクラス

services:
  dynamodb-local:
    image: amazon/dynamodb-local:latest
    command: "-jar DynamoDBLocal.jar -sharedDb -inMemory"
    ports:
      - "8000:8000"

aws:
  credentials:
    access-key: "※実際のAWS環境のaccess-keyを設定"
    secret-key: "※実際のAWS環境のsecret-keyを設定"
  region: "※実際のAWS環境のregionを設定"

aws:
  dynamodb-local:
    endpoint: http://localhost:8000
  credentials:
    access-key: dummy
    secret-key: dummy

@Configuration
public class DynamoDbConfig {

    @Value("${aws.dynamodb-local.endpoint:}")
    private String endpoint;

    @Value("${aws.credentials.access-key:}")
    private String accessKey;

    @Value("${aws.credentials.secret-key:}")
    private String secretKey;

    @Value("${aws.region:ap-northeast-1}")
    private String region;

    @Bean
    public DynamoDbClient dynamoDbClient() {
        var builder = DynamoDbClient.builder()
                .region(Region.of(region))
                .credentialsProvider(StaticCredentialsProvider.create(
                        AwsBasicCredentials.create(accessKey, secretKey)));

        // DynamoDB localのエンドポイントが指定されている場合はローカル環境へ接続
        if (endpoint != null && !endpoint.isEmpty()) {
            builder.endpointOverride(URI.create(endpoint));
        }

        return builder.build();
    }
}

# 1. DynamoDB local 起動
docker-compose up -d

# 2. API起動
gradlew bootRun --args="--spring.profiles.active=local"

dependencies {
    // Testcontainers
    testImplementation("org.testcontainers:testcontainers:2.0.4")
    testImplementation("org.testcontainers:junit-jupiter:1.21.4")
}

/**
 * Testcontainers + DynamoDB Local のテスト用設定。
 * テスト時に自動でDockerコンテナを起動し、テスト用のDynamoDBクライアントを提供する。
 */
@TestConfiguration
public class DynamoDbTestConfig {

    // DynamoDB Local のDockerコンテナ定義
    private static final GenericContainer DYNAMO_DB_CONTAINER =
            new GenericContainer<>(DockerImageName.parse("amazon/dynamodb-local:latest"))
                    .withExposedPorts(8000)
                    .withCommand("-jar DynamoDBLocal.jar -inMemory -sharedDb");

    // クラスロード時にコンテナを起動（テストクラス間で使い回す）
    static {
        DYNAMO_DB_CONTAINER.start();
    }

    @Bean(destroyMethod = "close")
    @Primary
    public DynamoDbClient dynamoDbClient() {
        // Testcontainersが割り当てたランダムポートでエンドポイントを構築
        String endpoint = "http://" + DYNAMO_DB_CONTAINER.getHost()
                + ":" + DYNAMO_DB_CONTAINER.getFirstMappedPort();

        // DynamoDB Localへの接続のため、認証情報はダミー値でOK
        return DynamoDbClient.builder()
                .endpointOverride(URI.create(endpoint))
                .region(Region.AP_NORTHEAST_1)
                .credentialsProvider(StaticCredentialsProvider.create(
                        AwsBasicCredentials.create("dummy", "dummy")))
                .build();
    }

    @Bean
    @Primary
    public DynamoDbEnhancedClient dynamoDbEnhancedClient(DynamoDbClient dynamoDbClient) {
        return DynamoDbEnhancedClient.builder()
                .dynamoDbClient(dynamoDbClient)
                .build();
    }
}

public class DynamoDbTableHelper {

    // テーブルが存在しなければ作成する
    public static void createTableIfNotExist(DynamoDbClient client) {
        var existingTables = client.listTables().tableNames();
        if (existingTables.contains(Book.TABLE_NAME)) {
            return;
        }
        client.createTable(/* テーブル定義 */);
    }

    // 全データを削除する（テーブルは残す）
    public static void truncateTable(DynamoDbClient client) {
        var scanResult = client.scan(ScanRequest.builder()
                .tableName(Book.TABLE_NAME).build());
        for (var item : scanResult.items()) {
            client.deleteItem(DeleteItemRequest.builder()
                    .tableName(Book.TABLE_NAME)
                    .key(Map.of(Book.BOOK_ID, item.get(Book.BOOK_ID)))
                    .build());
        }
    }
}

@SpringBootTest(classes = {DynamoDbTestConfig.class, BookMapper.class})
class BookMapperTest {

    @Autowired
    BookMapper bookMapper;

    @Autowired
    DynamoDbClient dynamoDbClient;

    @BeforeEach
    void setUp() {
        DynamoDbTableHelper.createTableIfNotExist(dynamoDbClient);
        DynamoDbTableHelper.truncateTable(dynamoDbClient);
    }

    @Test
    void create_書籍を登録して取得できる() {
        var book = new Book("book-001", "Spring入門", "山田太郎", "技術書", 3000);

        bookMapper.create(book);

        var result = bookMapper.findById("book-001");
        assertNotNull(result);
        assertEquals("Spring入門", result.getTitle());
    }
}

gradlew test