# Java Testcontainersでデータベースの初期データを投入する方法

## 目次

1. 1-1 Testcontainersとは

2. 1-2 初期データの重要性

3. 1-3 必要な準備

4. 1-4 Testcontainersによるデータベース設定

5. 1-5 データの投入方法

6. 1-6 実践例

7. 1-7 よくある問題と対処法

8. 1-8 まとめ

## 1-1 Testcontainersとは

Testcontainersは、Javaでコンテナを使用した統合テストを行うためのライブラリです。これにより、一時的なデータベースやキューなどの依存関係をコンテナで起動し、テストケースのライフサイクルに合わせて利用することができます。Dockerを基盤にしており、環境の一貫性を保ちながら簡単に設定が行える点が特徴です。

## 1-2 初期データの重要性

テストデータはテストの信頼性を高め、再現性のある環境を提供するために不可欠です。特に、複雑なロジックを検証する際には、データの整合性や予測可能性が重要になります。初期データを正確に投入することで、開発者が意図した通りの動作を確認することができます。

## 1-3 必要な準備

### 1-3-1 環境

- Java (1.8以上)

- MavenまたはGradle

- Docker

### 1-3-2 依存関係の追加

Mavenを使用する場合、pom.xmlに以下の依存関係を追加します。

```xml

<dependency>

    <groupId>org.testcontainers</groupId>

    <artifactId>postgresql</artifactId>

    <version>1.17.6</version>

</dependency>

```

Gradleの場合は、build.gradleに以下の内容を追加します。

```groovy

testImplementation 'org.testcontainers:postgresql:1.17.6'

```

## 1-4 Testcontainersによるデータベース設定

### 1-4-1 データベースのコンテナセットアップ

Testcontainersを用いて、PostgreSQLのコンテナを起動します。

```java

import org.testcontainers.containers.PostgreSQLContainer;

import org.junit.jupiter.api.AfterEach;

import org.junit.jupiter.api.BeforeEach;

public class DatabaseTest {

    private PostgreSQLContainer<?> postgreSQLContainer = new PostgreSQLContainer<>("postgres:13-alpine");

    @BeforeEach

    void setUp() {

        postgreSQLContainer.start();

    }

    @AfterEach

    void tearDown() {

        postgreSQLContainer.stop();

    }

}

```

### 1-4-2 接続設定

テストコードでコンテナのデータベースに接続するための設定をします。

```java

String jdbcUrl = postgreSQLContainer.getJdbcUrl();

String username = postgreSQLContainer.getUsername();

String password = postgreSQLContainer.getPassword();

```

これで、起動するデータベースコンテナへの接続が可能になります。

## 1-5 データの投入方法

### 1-5-1 SQLスクリプトによる投入

データベースに初期データを投入する際、一般的にはSQLスクリプトを使用します。以下に簡単な例を示します。

```sql

-- src/test/resources/test-data.sql

CREATE TABLE users (

    id SERIAL PRIMARY KEY,

    name VARCHAR(255),

    email VARCHAR(255)

);

INSERT INTO users (name, email) VALUES

('Alice', 'alice@example.com'),

('Bob', 'bob@example.com');

```

### 1-5-2 Javaコードでの投入

プログラム内でJDBCを用いてデータを投入する例です。

```java

try (Connection connection = DriverManager.getConnection(jdbcUrl, username, password)) {

    ScriptRunner scriptRunner = new ScriptRunner(connection);

    scriptRunner.runScript(new FileReader("src/test/resources/test-data.sql"));

}

```

## 1-6 実践例

以下に、Testcontainersを用いてデータベースに初期データを投入し、テストを行う例を示します。

```java

import org.junit.jupiter.api.Test;

import java.sql.Connection;

import java.sql.ResultSet;

import java.sql.Statement;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class DatabaseTest {

    @Test

    void testUserCount() throws Exception {

        try (Connection connection = DriverManager.getConnection(jdbcUrl, username, password)) {

            Statement stmt = connection.createStatement();

            ResultSet rs = stmt.executeQuery("SELECT COUNT(*) FROM users");

            rs.next();

            int count = rs.getInt(1);

            assertEquals(2, count, "User count should be 2");

        }

    }

}

```

### 1-6-1 結果確認

上記の設定とスクリプトを用いて、ユーザーテーブルに2件のデータが登録されることを確認するテストを実行しました。

## 1-7 よくある問題と対処法

### 1-7-1 コンテナの起動エラー

Dockerが適切にセットアップされていることを確認してください。また、Testcontainersのライブラリバージョンが最新であることを確認します。

### 1-7-2 データの整合性エラー

SQLスクリプトが正確に動作しているか、データベースのスキーマに問題がないかを確認します。

## 1-8 まとめ

Testcontainersを用いることで、柔軟にデータベースのテスト利用環境を構築することができます。初期データを効果的に投入し、テストの再現性を保つことが、品質の高いソフトウェア開発に貢献します。今回の手法を用いて、さらに高度なテスト環境を構築してみてください。

Java Testcontainersでデータベースの初期データを投入する方法

目次

続きを読むには単価診断を受けてください（30秒）