ebean-test

Plugin that simplifies testing configuration for Ebean. This includes automatically starting docker containers (like Postgres, MySql, SqlServer, Oracle, ElasticSearch, HANA etc). These containers are started and typically setup for testing by creating a database and user ready to run tests against.

Prerequisite

You need docker installed locally.

To use

1) Add ebean-test as a test scope dependency

    <dependency>
      <groupId>io.ebean</groupId>
      <artifactId>ebean-test</artifactId>
      <version>12.1.1</version>
      <scope>test</scope>
    </dependency>

2) Add a application-test.yml file to src/test/resources

Example: Just using H2

ebean:
  test:
    platform: h2

Example: Using Postgres via docker with defaults

ebean:
  test:
    platform: postgres
    dbName: test_myapp
    ddlMode: dropCreate # none | dropCreate | migration

Note that when we use Postgres, MySql, Sql Server, Oracle, HANA or DB2 we need to specify dbName. This should be a name that does not clash with other projects that might also test against the same docker container.

Example: Using SqlServer with databasePlatformName set to sqlserver17.

ebean:
  databasePlatformName: sqlserver17  ## put here when only using sql server
  test:
    platform: sqlserver # h2, postgres, mysql, oracle, sqlserver
    ddlMode: dropCreate # none | dropCreate | create | migration | createOnly | migrationDropCreate
    dbName: test

    sqlserver:
      databasePlatformName: sqlserver17         ## put here when testing multiple platforms
      #collation: SQL_Latin1_General_CP1_CS_AS  ## use an explicit collation
      #collation: default                       ## use the sql server default

db system property

The db system property can be set which:

• Sets the default datasource Ebean will use
• If it matches a known container name like postgres, mysql, oracle, hana or sqlserver then it will start an appropriate docker container to run the tests against.

In this way we can run tests against a specific database platform. e.g.

mvn clean test -Ddb=postgres

mvn clean test -Ddb=sqlserver