testdb:start

Full name:

io.metaloom.maven:testdb-maven-plugin:0.1.4:start

Description:

The start operation will provide the needed testdatabase provider daemon and optionally also a database which will automatically be configured to work in conjunction with the started daemon.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: initialize.

Optional Parameters

Name Type Since Description
<postgresqlMavenConfig> PostgresqlMavenConfiguration - Parameters for the database settings. The settings can be used to configure the started postgresql container or for the use of an external database connection. The settings will be used when choosing to create a default test database pool during the execution of this goal.
User property is: maven.testdb.postgresql.
Alias is: postgresql.
<providerMavenConfig> ProviderMavenConfiguration - Parameters for the testdatabase provider daemon.
User property is: maven.testdb.provider.
Alias is: provider.
<reuseContainers> boolean - Whether to re-use the started docker containers. If not enabled the container will be shut down when the maven command terminates. The settings `testcontainers.reuse.enable=true` must be added to the .testcontainers.properties file in order to enable re-use of containers. A provider state file in the build directory will keep track of containerIds and reuse them when goals are run again (if possible).
Default value is: true.
User property is: maven.testdb.reuse_containers.
<skip> boolean - Whether the plugin execution should be skipped
Default value is: false.
User property is: maven.testdb.skip.

Parameter Details

<postgresqlMavenConfig>

Parameters for the database settings. The settings can be used to configure the started postgresql container or for the use of an external database connection. The settings will be used when choosing to create a default test database pool during the execution of this goal.
  • Type: io.metaloom.maven.provider.PostgresqlMavenConfiguration
  • Required: No
  • User Property: maven.testdb.postgresql
  • Alias: postgresql

<providerMavenConfig>

Parameters for the testdatabase provider daemon.
  • Type: io.metaloom.maven.provider.ProviderMavenConfiguration
  • Required: No
  • User Property: maven.testdb.provider
  • Alias: provider

<reuseContainers>

Whether to re-use the started docker containers. If not enabled the container will be shut down when the maven command terminates. The settings `testcontainers.reuse.enable=true` must be added to the .testcontainers.properties file in order to enable re-use of containers. A provider state file in the build directory will keep track of containerIds and reuse them when goals are run again (if possible).
  • Type: boolean
  • Required: No
  • User Property: maven.testdb.reuse_containers
  • Default: true

<skip>

Whether the plugin execution should be skipped
  • Type: boolean
  • Required: No
  • User Property: maven.testdb.skip
  • Default: false