Java の基本

JVM 向けの pgmem は 3 つのアーティファクトでできています。クライアントの io.github.shibukawa.pgmem:pgmem、JUnit 5 拡張の io.github.shibukawa.pgmem:pgmem-junit5、プラットフォームごとの classifier でバイナリを配る io.github.shibukawa.pgmem:pgmem-native です。クライアントはサードパーティの実行時依存を持たないので、JDBC ドライバは自分で追加してください。

依存関係

dependencies {
    testImplementation("io.github.shibukawa.pgmem:pgmem-junit5:0.1.0")          // io.github.shibukawa.pgmem:pgmem も入る
    testRuntimeOnly("io.github.shibukawa.pgmem:pgmem-native:0.1.0:darwin-arm64") // 自分のプラットフォーム用のバイナリ
    testRuntimeOnly("org.postgresql:postgresql:42.7.7")
    testImplementation("org.junit.jupiter:junit-jupiter:5.13.4")
}

tasks.test {
    useJUnitPlatform()
}

dependencies {
    testImplementation 'io.github.shibukawa.pgmem:pgmem-junit5:0.1.0'           // io.github.shibukawa.pgmem:pgmem も入る
    testRuntimeOnly 'io.github.shibukawa.pgmem:pgmem-native:0.1.0:darwin-arm64' // 自分のプラットフォーム用のバイナリ
    testRuntimeOnly 'org.postgresql:postgresql:42.7.7'
    testImplementation 'org.junit.jupiter:junit-jupiter:5.13.4'
}

test {
    useJUnitPlatform()
}

<dependencies>
  <dependency>
    <groupId>io.github.shibukawa.pgmem</groupId>
    <artifactId>pgmem-junit5</artifactId>
    <version>0.1.0</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>io.github.shibukawa.pgmem</groupId>
    <artifactId>pgmem-native</artifactId>
    <version>0.1.0</version>
    <classifier>darwin-arm64</classifier>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>42.7.7</version>
    <scope>test</scope>
  </dependency>
</dependencies>

classifier は linux-x86_64、linux-arm64、darwin-arm64、windows-x86_64、windows-arm64 です。複数のプラットフォームでビルドするなら、5 つ全部に依存するのではなく、Maven のプロファイルや Gradle の OS 判定プラグインでプラットフォームごとに 1 つを選んでください。バイナリは初回に ~/.cache/pgmem/<version>/ へ展開されます。Java 17 以降が必要です。

基本の流れ

プロセスを起動します。 Pgmem は AutoCloseable で、閉じるとすべてのサーバーが止まります。

Java
Kotlin

try (Pgmem pg = Pgmem.builder().database("app").start()) {
    Server template = pg.template();
    System.out.println(template.jdbcUrl()); // jdbc:postgresql://127.0.0.1:54321/app?user=postgres&sslmode=disable
}

Pgmem.builder().database("app").start().use { pg ->
    val template = pg.template()
    println(template.jdbcUrl())
}

ビルダーにはほかに user(...)、param("shared_buffers", "128MB")、log(true)、binary(path) があります。

スキーマを登録します。 マイグレーションツールを使います。マイグレーションツールを参照してください。
シードデータを入れます。 シードデータを参照してください。

JDBC で使います。 jdbcUrl() にはユーザーと sslmode が含まれ、dataSource() は javax.sql.DataSource を返します。

Java
Kotlin

try (Connection conn = DriverManager.getConnection(template.jdbcUrl());
     PreparedStatement ps = conn.prepareStatement("SELECT name FROM users WHERE id = ?")) {
    ps.setLong(1, 1);
    try (ResultSet rs = ps.executeQuery()) {
        rs.next();
        String name = rs.getString(1);
    }
}

DriverManager.getConnection(template.jdbcUrl()).use { conn ->
    conn.prepareStatement("SELECT name FROM users WHERE id = ?").use { ps ->
        ps.setLong(1, 1)
        ps.executeQuery().use { rs -> rs.next(); println(rs.getString(1)) }
    }
}

この URL で HikariCP のプールを作ることもできます。接続はトランザクション境界で直列になります。

マイグレーションツール

String schema = Files.readString(Path.of("src/test/resources/schema.sql"));
try (Connection conn = DriverManager.getConnection(template.jdbcUrl());
     Statement st = conn.createStatement()) {
    st.execute(schema);
}

Flyway.configure()
      .dataSource(template.jdbcUrl(), template.user(), null)
      .locations("classpath:db/migration")
      .load()
      .migrate();

Flyway 10 以降では、テストのクラスパスに org.flywaydb:flyway-database-postgresql も必要です。

try (Connection conn = DriverManager.getConnection(template.jdbcUrl())) {
    Database db = DatabaseFactory.getInstance()
            .findCorrectDatabaseImplementation(new JdbcConnection(conn));
    new CommandScope("update")
            .addArgumentValue("database", db)
            .addArgumentValue("changelogFile", "db/changelog/db.changelog-master.yaml")
            .execute();
}

シードデータ

<dataset>
  <users id="1" name="Frank" email="frank@example.com"/>
  <users id="2" name="Grace" email="grace@example.com"/>
  <orders id="1" user_id="1" amount="1200"/>
</dataset>

IDatabaseTester tester = new JdbcDatabaseTester(
        "org.postgresql.Driver", template.jdbcUrl(), template.user(), "");
tester.setDataSet(new FlatXmlDataSetBuilder()
        .build(getClass().getResourceAsStream("/seed.xml")));
tester.setSetUpOperation(DatabaseOperation.CLEAN_INSERT);
tester.onSetup();

try (Connection conn = DriverManager.getConnection(template.jdbcUrl());
     Statement st = conn.createStatement()) {
    st.execute(Files.readString(Path.of("src/test/resources/seed.sql")));
}

try (Connection conn = DriverManager.getConnection(template.jdbcUrl())) {
    CopyManager copy = conn.unwrap(PGConnection.class).getCopyAPI();
    copy.copyIn("COPY users (id, name, email) FROM STDIN (FORMAT csv)",
            new StringReader("1,Frank,frank@example.com\n2,Grace,grace@example.com\n"));
}

スナップショットとフォークを直接使う

try (Pgmem pg = Pgmem.builder().database("app").start()) {
    migrate(pg.template().jdbcUrl());
    Snapshot snap = pg.template().snapshot();          // 開いているトランザクションを待つ。30 秒
    try (Fork fork = snap.fork()) {                     // 専用の複製
        DataSource ds = fork.dataSource();
        // ...
    }
}

snapshot() の前に、テンプレートへの接続はすべてコミットするか閉じてください。次のページの JUnit 5 拡張は、これをテストのライフサイクルに組み込みます。