Class JdbiTestcontainersExtension

java.lang.Object

org.jdbi.v3.testing.junit5.JdbiExtension

org.jdbi.v3.testing.junit5.tc.JdbiTestcontainersExtension

All Implemented Interfaces:

AfterAllCallback, AfterEachCallback, BeforeAllCallback, BeforeEachCallback, Extension, ParameterResolver

@Beta
public final class JdbiTestcontainersExtension
extends JdbiExtension

Support Testcontainer JDBC containers as database for Jdbi tests.

Method Summary

Modifier and Type	Method	Description
String	getUrl()	Returns a JDBC url representing the data source used by this extension.
static JdbiTestcontainersExtension	instance(TestcontainersDatabaseInformation databaseInformation, JdbcDatabaseContainer<?> jdbcDatabaseContainer)	Create a new JdbiExtension that uses the supplied JdbcDatabaseContainer as database.
static JdbiTestcontainersExtension	instance(JdbcDatabaseContainer<?> jdbcDatabaseContainer)	Create a new JdbiExtension that uses the supplied JdbcDatabaseContainer as database.
JdbiTestcontainersExtension	setShutdownWaitTimeInSeconds(int seconds)	Sets the maximum wait time for shutting down the extension.

Methods inherited from class org.jdbi.v3.testing.junit5.JdbiExtension

afterAll, afterEach, attach, beforeAll, beforeEach, enableLeakChecker, externalPostgres, getJdbi, getSharedHandle, h2, installPlugins, openHandle, otjEmbeddedPostgres, postgres, resolveParameter, sqlite, supportsParameter, withConfig, withInitializer, withPlugin, withPlugins

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

instance

public static JdbiTestcontainersExtension instance(JdbcDatabaseContainer<?> jdbcDatabaseContainer)

Create a new JdbiExtension that uses the supplied JdbcDatabaseContainer as database. This must be a supported container instance.

Parameters:

jdbcDatabaseContainer - A supported JdbcDatabaseContainer instance.

Returns:

An initialized JdbiExtension instance that uses the database container.

Throws:

IllegalArgumentException - If the provided container class is not supported.

instance

public static JdbiTestcontainersExtension instance(TestcontainersDatabaseInformation databaseInformation,
 JdbcDatabaseContainer<?> jdbcDatabaseContainer)

Create a new JdbiExtension that uses the supplied JdbcDatabaseContainer as database.

Parameters:

databaseInformation - A TestcontainersDatabaseInformation instance that describes how to create new test-isolation databases or schemata.

jdbcDatabaseContainer - A JdbcDatabaseContainer instance.

Returns:

An initialized JdbiExtension instance that uses the database container.

setShutdownWaitTimeInSeconds

@Alpha
public JdbiTestcontainersExtension setShutdownWaitTimeInSeconds(int seconds)

Sets the maximum wait time for shutting down the extension.

Since:

3.45.0

See Also:

• TestcontainersDatabaseInformation.setShutdownWaitTimeInSeconds(int)

getUrl

public String getUrl()

Description copied from class: JdbiExtension

Returns a JDBC url representing the data source used by this extension. This url is database-specific and may or may not be used to connect to the data source outside testing code that uses this extension (e.g. the JdbiSqliteExtension returns a constant uri for all database instances).

Specified by:

getUrl in class JdbiExtension

Returns:

A string representing the JDBC URL.