Embedded Postgres
Introduction
This project is a fork of OpenTable Embedded PostgreSQL Component created due to inactivity of maintainers.
The library allows embedding PostgreSQL into Java application code with no external dependencies. Excellent for allowing you to unit test with a "real" Postgres without requiring end users to install and set up a database cluster.
If you are using Spring or Spring Boot framework you can also consider using the following more specialized embedded-database-spring-test project.
Features
- All features of
com.opentable:otj-pg-embedded:0.13.3 - Configurable version of PostgreSQL binaries
- PostgreSQL 11+ support even for Linux platform
- Support for running inside Docker, including Alpine Linux
Maven Configuration
Add the following Maven dependency:
<dependency>
<groupId>io.zonky.test</groupId>
<artifactId>embedded-postgres</artifactId>
<version>2.0.7</version>
<scope>test</scope>
</dependency>The default version of the embedded postgres is PostgreSQL 14.10, but you can change it by following the instructions described in Postgres version.
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.
Postgres version
The default version of the embedded postgres is PostgreSQL 14.10, but it can be changed by importing embedded-postgres-binaries-bom in a required version into your dependency management section.
<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.zonky.test.postgres</groupId>
<artifactId>embedded-postgres-binaries-bom</artifactId>
<version>16.2.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>Using Maven BOMs in Gradle
In Gradle, there are several ways how to import a Maven BOM. 1. You can define a resolution strategy to check and change the version of transitive dependencies manually: configurations.all { resolutionStrategy.eachDependency { DependencyResolveDetails details -> if (details.requested.group == 'io.zonky.test.postgres') { details.useVersion '16.2.0' } } } 2. If you use Gradle 5+, [Maven BOMs are supported out of the box](https://docs.gradle.org/5.0/userguide/managing_transitive_dependencies.html#sec:bom_import), so you can import the bom: dependencies { testImplementation enforcedPlatform('io.zonky.test.postgres:embedded-postgres-binaries-bom:16.2.0') } 3. Or, you can use [Spring's dependency management plugin](https://docs.spring.io/dependency-management-plugin/docs/current/reference/html/#dependency-management-configuration-bom-import) that provides Maven-like dependency management to Gradle: plugins { id "io.spring.dependency-management" version "1.1.0" } dependencyManagement { imports { mavenBom 'io.zonky.test.postgres:embedded-postgres-binaries-bom:16.2.0' } }A list of all available versions of postgres binaries is here: https://mvnrepository.com/artifact/io.zonky.test.postgres/embedded-postgres-binaries-bom Note that the release cycle of the postgres binaries is independent of the release cycle of this library, so you can upgrade to a new version of postgres binaries immediately after it is released. ## Additional architectures By default, only the support for `amd64` architecture is enabled. Support for other architectures can be enabled by adding the corresponding Maven dependencies as shown in the example below. ```xml