OpenTable Embedded PostgreSQL Component
Allows embedding PostgreSQL into Java application code with no external dependencies. Excellent for allowing you to unit test with a "real" PostgreSQL without requiring end users to install and set up a database cluster.
Basic Usage
In your JUnit test just add:
@Rule
public SingleInstancePostgresRule pg = EmbeddedPostgresRules.singleInstance();
This simply has JUnit manage an instance of EmbeddedPostgres (start, stop). You can then use this to get a DataSource with: pg.getEmbeddedPostgres().getPostgresDatabase();
Additionally you may use the EmbeddedPostgres
class directly by manually starting and stopping the instance; see EmbeddedPostgresTest
for an example.
Default username/password is: postgres/postgres and the default database is 'postgres'
Migrators (Flyway or Liquibase)
You can easily integrate Flyway or Liquibase database schema migration:
Flyway
@Rule
public PreparedDbRule db =
EmbeddedPostgresRules.preparedDatabase(
FlywayPreparer.forClasspathLocation("db/my-db-schema"));
Liquibase
@Rule
public PreparedDbRule db =
EmbeddedPostgresRules.preparedDatabase(
LiquibasePreparer.forClasspathLocation("liqui/master.xml"));
This will create an independent database for every test with the given schema loaded from the classpath. Database templates are used so the time cost is relatively small, given the superior isolation truly independent databases gives you.
PostgreSQL version
The JAR file contains bundled version of PostgreSQL. You can pass different PostgreSQL version by implementing PgBinaryResolver
.
Example:
class ClasspathBinaryResolver implements PgBinaryResolver {
public InputStream getPgBinary(String system, String machineHardware) throws IOException {
ClassPathResource resource = new ClassPathResource(format("postgresql-%s-%s.txz", system, machineHardware));
return resource.getInputStream();
}
}
EmbeddedPostgreSQL
.builder()
.setPgBinaryResolver(new ClasspathBinaryResolver())
.start();
Windows
If you experience difficulty running otj-pg-embedded
tests on Windows, make sure you've installed the appropriate MFC redistributables.
Copyright (C) 2017 OpenTable, Inc