PostgreSQL の利用

前章で見たとおり、従来の WildFly と同様にすぐに使えるデータベースとして H2 が利用できます。

ただ、せっかくなので今回は PostgreSQL での場合もやってみたいと思います。開発は H2、プロダクションは PostgreSQL みたいなイメージで、起動時にシステムプロパティで切り替えられるようにしましょう。

PostgreSQL はお好みの方法で用意してもらえればと思いますが以下を想定しています。

• データベース名、データベースのユーザ、パスワード： lifelog
• ホスト: localhost
• ポート: 5432

PostgreSQL が初めてという方でかつ、Docker が利用できる環境であれば以下のようにしてコンテナを用意するのが楽だと思います。

このドキュメントではいろいろと Docker を使うので、そういう意味でも Docker での利用をおすすめします。

$ docker run -it -d \
  --name lifelog-db \
  -e POSTGRES_USER=lifelog -e POSTGRES_PASSWORD=lifelog \
  -p 5432:5432 \
  postgres:9.6.1

本来こういった永続化されるデータに対しては Data Volume Container を用意したほうがよいですが、簡単のため割愛します。

ちゃんとデータベースができたか、psql クライアントで確認してみます。

$ docker run --rm -it \
  --link lifelog-db:db \
  postgres:9.6.1 \
  sh -c 'exec psql -h "$DB_PORT_5432_TCP_ADDR" -p "$DB_PORT_5432_TCP_PORT" -U lifelog'

上記コマンドを実行すると以下のようなプロンプトが表示されるので、適宜入力していきます。

Password for user lifelog: # lifelog と入力
psql (9.6.1)
Type "help" for help.

lifelog=# \l # \l と入力
                                 List of databases
   Name    |  Owner   | Encoding |  Collate   |   Ctype    |   Access privileges
-----------+----------+----------+------------+---------- --+-----------------------
 lifelog   | postgres | UTF8     | en_US.utf8 | en_US.utf8 |
 postgres  | postgres | UTF8     | en_US.utf8 | en_US.utf8 |
 template0 | postgres | UTF8     | en_US.utf8 | en_US.utf8 | =c/postgres          +
           |          |          |            |            | postgres=CTc/postgres
 template1 | postgres | UTF8     | en_US.utf8 | en_US.utf8 | =c/postgres          +
           |          |          |            |            | postgres=CTc/postgres
(4 rows)

だいじょぶそうですね。

もうちょっと凝った設定がしたいぜ、という方は以下の Docker Hub のページを参照ください。

https://hub.docker.com/_/postgres/

PostgreSQL がセットアップできたらアプリケーションから使えるようにしてみましょう。

完成版は以下リポジトリにありますので、適宜参照ください。

https://github.com/emag/wildfly-swarm-tour/tree/2017.1.1/code/postgresql

まず、利用する PostgreSQL JDBC ドライバの依存性を追加します。

<properties>
  [...]
  <!-- 追記 ここから -->
  <version.postgresql-jdbc>9.4.1212</version.postgresql-jdbc>
  <!-- 追記 ここまで -->
  [...]
</properties>

[...]

<dependencies>
  [...]
  <!-- 追記 ここから -->
  <dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>${version.postgresql-jdbc}</version>
  </dependency>
  <!-- 追記 ここまで -->
  [...]
</dependencies>

次に、システムプロパティの値によって H2 と PostgreSQL を切り替えられるようにする部分です。 project-stages.yml というファイルを以下の内容で適当なパス(ここではプロジェクト直下)に配置します。

swarm:
  datasources:
    data-sources:
      lifelogDS:
        driver-name: h2
        connection-url: jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=TRUE
        user-name: sa
        password: sa
---
project:
  stage: production
swarm:
  datasources:
    data-sources:
      lifelogDS:
        driver-name: postgresql
        connection-url: jdbc:postgresql://localhost:5432/lifelog
        user-name: lifelog
        password: lifelog

project: stage: の部分でステージを指定し、各ステージは --- で区切ります。一番上のように何も指定しない場合は default ステージとみなされます。

その他の情報については以下ドキュメントを参考ください。

https://wildfly-swarm.gitbooks.io/wildfly-swarm-users-guide/content/v/2017.1.1/configuration/project_stages.html

この設定によって、データソースにおける H2 ないし PostgreSQL の設定が起動時にどのステージを選んだかで切り替わります。 また、上記のような swarm: datasources: と渡した場合、WildFly Swarm がこの値を DatasourcesFraction の設定を行ってくれるため、 前章までで設定していた wildflyswarm.LifelogContainer クラスは不要になります。

wildflyswarm.LifelogContainer クラスを削除し、wildflyswarm.Bootstrap クラスを以下のように修正します。

package wildflyswarm;

import org.wildfly.swarm.Swarm;

public class Bootstrap {

  public static void main(String[] args) throws Exception {
    new Swarm(args)
      .start()
      .deploy(LifeLogDeployment.deployment());
  }

}

また、EntryControllerIT も修正しておきます。

@Deployment(testable = false)
public static JAXRSArchive createDeployment() {
  // addClass() は不要
  return LifeLogDeployment.deployment();
}

// 特別に設定することはないため、newContainer メソッドは削除
// @CreateSwarm
// public static Swarm newContainer() throws Exception {
//   return LifeLogContainer.newContainer(new String[0]);
// }

ここまででプロジェクト構成はおおよそ以下のようになります。

.
├── project-stages.yml
├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   ├── lifelog
    │   │   │   ├── api
    │   │   │   │   ├── EntryController.java
    │   │   │   │   └── EntryResponse.java
    │   │   │   └── domain
    │   │   │       ├── model
    │   │   │       │   ├── converter
    │   │   │       │   │   └── LocalDateTimeConverter.java
    │   │   │       │   └── Entry.java
    │   │   │       ├── repository
    │   │   │       │   └── EntryRepository.java
    │   │   │       └── service
    │   │   │           └── EntryService.java
    │   │   └── wildflyswarm
    │   │       ├── Bootstrap.java
    │   │       └── LifeLogDeployment.java
    │   └── resources
    │       └── META-INF
    │           └── persistence.xml
    └── test
        └── java
            └── lifelog
                └── api
                    └── EntryControllerIT.java

ここまで出来て、PostgreSQL も起動していることも確認したうえで lifelog をビルド、実行します。 ステージ用ファイルとステージの指定はそれぞれシステムプロパティ swarm.project.stage を渡します。

$ ./mvnw clean package && \
  java -jar target/lifelog-swarm.jar -Dswarm.project.stage=production

なお、java の実行パス(user.dir)直下に project-stages.yml という名前のファイルがあると自動で認識されます

POST したり psql でデータベースの中を見たりして、実際に PostgreSQL が使われていることを確認してみてください。

なおこのステージ切替用の設定ファイルですが、project-stages.yml という名前にした場合、このファイルがモジュール内やアプリケーションのクラスパスに存在すると自動的に読み込まれます。 ここでは値を変更するたびにビルドし直すのも面倒ですので外出ししています。 また、java コマンド実行時のカレントパスにあった場合も読まれますが、Arquillian 実行時はカレントパスが変わるため、自分でパス指定する方が無難です。

IT 用のステージを用意

ついでに Arquillian でのテストも PostgreSQL を使ってやってみましょう。

$ ./mvnw clean verify \
  -Dswarm.project.stage.file=file://`pwd`/project-stages.yml \
  -Dswarm.project.stage=production

Arquillian 実行時には user.dir が /tmp/arquillian5574290908184081425 といったパスになってしまうため、 swarm.project.stage.file で project-stages.yml のパスを指定します。 なお、ファイルの指定にはプロトコルを渡す必要があります。

ただしこのままだと Integration Test なのにプロダクション環境のデータベースを使ってしまっていますね。--- で区切って 1 つステージを増やしておきましょう。

[...]
---
project:
  stage: it
swarm:
  datasources:
    data-sources:
      lifelogDS:
        driver-name: postgresql
        connection-url: jdbc:postgresql://localhost:15432/lifelog
        user-name: lifelog
        password: lifelog
---
project:
  stage: production
[...]

ここでは PostgreSQL をもう 1 インスタンス、15432 ポートでリスンされていることを想定しています。

では Docker なりなんなりで上げておいて、としてもいいですが、Integration Test しか使わないサーバをずっと上げておくのも微妙ですね。できればテストの時だけ上がっているとうれしいところです。

シェルスクリプトを書いたりいろいろやり方はあると思いますが、Docker を前提として今回は以下の Maven プラグインを使ってみたいと思います。

https://github.com/fabric8io/docker-maven-plugin

先に設定を記載しておきます。

H2 データベースでテストするときなど常に Docker コンテナを起動したいとも限らないので、it という id のプロファイルに設定をわけています。

<properties>
  [...]
  <version.docker-maven-plugin>0.17.2</version.docker-maven-plugin>
  <version.postgresql-server>9.6.1</version.postgresql-server>
</properties>

[...]

<profiles>
  <profile>
    <id>it</id>
    <build>
      <plugins>
        <plugin>
          <groupId>io.fabric8</groupId>
          <artifactId>docker-maven-plugin</artifactId>
          <version>${version.docker-maven-plugin}</version>
          <configuration>
            <logDate>default</logDate>
            <autoPull>true</autoPull>
            <images>
              <image>
                <alias>lifelog-db</alias>
                <name>postgres:${version.postgresql-server}</name>
                <run>
                  <env>
                    <POSTGRES_USER>lifelog</POSTGRES_USER>
                    <POSTGRES_PASSWORD>lifelog</POSTGRES_PASSWORD>
                  </env>
                  <ports>
                    <port>15432:5432</port>
                  </ports>
                  <wait>
                    <log>database system is ready to accept connections</log>
                    <time>20000</time>
                  </wait>
                  <log>
                    <prefix>LIFELOG_DB</prefix>
                    <color>yellow</color>
                  </log>
                </run>
              </image>
            </images>
          </configuration>

          <executions>
            <execution>
              <id>start</id>
              <phase>pre-integration-test</phase>
              <goals>
                <goal>build</goal>
                <goal>start</goal>
              </goals>
            </execution>
            <execution>
              <id>stop</id>
              <phase>post-integration-test</phase>
              <goals>
                <goal>stop</goal>
              </goals>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </build>
  </profile>
</profiles>

まず大事なのは以下の設定です。

<image>
  <alias>lifelog-db</alias>
  <!-- PostgreSQL のイメージ -->
  <name>postgres:${version.postgresql-server}</name>
  <run>
    <!-- 環境変数 -->
    <env>
      <POSTGRES_USER>lifelog</POSTGRES_USER>
      <POSTGRES_PASSWORD>lifelog</POSTGRES_PASSWORD>
    </env>
    <!-- ポート設定 -->
    <ports>
      <port>15432:5432</port>
    </ports>
    [...]
  </run>
</image>

PostgreSQL の Docker コンテナを実行するときの引数と対応しています。

$ docker run -it -d \
  --name lifelog-db \
  -e POSTGRES_USER=lifelog -e POSTGRES_PASSWORD=lifelog \
  -p 5432:5432 \
  postgres:9.6.1

また、以下の設定により、Integration Test の開始前にコンテナが起動し、終了すると削除されるようにしています。

<executions>
  <execution>
    <id>start</id>
    <phase>pre-integration-test</phase>
    <goals>
      <goal>build</goal>
      <goal>start</goal>
    </goals>
  </execution>
  <execution>
    <id>stop</id>
    <phase>post-integration-test</phase>
    <goals>
      <goal>stop</goal>
    </goals>
  </execution>
</executions>

その他の設定については以下ドキュメントを参考ください。

https://dmp.fabric8.io/

ここまできたらステージおよびプロファイルに it を指定したうえで実行してみます。

$ ./mvnw clean verify \
  -Dswarm.project.stage.file=file://`pwd`/project-stages.yml \
  -Dswarm.project.stage=it \
  -Pit

以下のように PostgreSQL のコンテナが起動するログから始まります。

[INFO] DOCKER> [postgres:9.6.1] "lifelog-db": Start container 4b644b479795
23:21:10.537 LIFELOG_DB> The files belonging to this database system will be owned by user "postgres".
[...]

無事テストが終わると以下のようにコンテナが削除されるログが表示されます。

[INFO] DOCKER> [postgres:9.6.1] "lifelog-db": Stop and remove container 4b644b479795

コンテナ起動･削除のオーバーヘッドが数秒程度ありますが、これだけの設定でその場限りのデータベースを用意できるのはいいですね。