Class JdbiH2Extension

java.lang.Object

org.jdbi.v3.testing.junit5.JdbiExtension

org.jdbi.v3.testing.junit5.JdbiH2Extension

All Implemented Interfaces:

AfterAllCallback, AfterEachCallback, BeforeAllCallback, BeforeEachCallback, Extension, ParameterResolver, TestInstantiationAwareExtension

public class JdbiH2Extension
extends JdbiExtension

Jdbi H2 JUnit 5 rule. Override methods for special case construction:

    @RegisterExtension
    public JdbiExtension extension = new JdbiH2Extension() {
        @Override
        protected DataSource createDataSource() {
           ...
        }
    };

Use with ExtendWith:

@ExtendWith(JdbiH2Extension.class)
public class DatabaseTest {
    @Test
    public void testWithJdbi(Jdbi jdbi) {
        ...
    }

    @Test
    public void testWithHandle(Handle handle) {
        ...
    }
}

Nested Class Summary

Nested classes/interfaces inherited from interface TestInstantiationAwareExtension

TestInstantiationAwareExtension.ExtensionContextScope

Constructor Summary

Constructors

Constructor	Description
JdbiH2Extension()
JdbiH2Extension(String options)	Allows setting the options string for the H2 database.

Method Summary

Modifier and Type	Method	Description
String	getUrl()	Returns a JDBC url representing the data source used by this extension.
JdbiH2Extension	withCredentials(String user, String password)	Sets the H2 username and password.
JdbiH2Extension	withUser(String user)	Sets the H2 username.

Methods inherited from class JdbiExtension

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

Modifier and Type	Method	Description
void	afterAll(ExtensionContext context)
void	afterEach(ExtensionContext context)
final <T> T	attach(Class<T> extension)	Convenience method to attach an extension (such as a SqlObject) to the shared handle.
void	beforeAll(ExtensionContext context)
void	beforeEach(ExtensionContext context)
final JdbiExtension	enableLeakChecker(boolean enable)	Enable tracking of cleanable resources and handles when running tests.
static JdbiExtension	externalPostgres(String hostname, Integer port, String database, String username, String password)	Creates an extension that uses an external (outside the scope of an unit test class) postgres database.
final Jdbi	getJdbi()	Returns a Jdbi instance linked to the data source used by this extension.
final Handle	getSharedHandle()	Returns a shared Handle used by the extension.
static JdbiExtension	h2()	Creates a new extension using the H2 database.
final JdbiExtension	installPlugins()	Deprecated, for removal: This API element is subject to removal in a future version. Registering plugins implicitly is less reliable.
final Handle	openHandle()	Open a new Handle to the used data source.
static JdbiOtjPostgresExtension	otjEmbeddedPostgres()	Creates a new extension using a managed, embedded postgres database.
static JdbiExtension	postgres(de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension pg)	Creates a new extension using a managed, embedded postgres database.
Object	resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
static JdbiExtension	sqlite()	Creates a new extension using the SQLite database.
boolean	supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
final <C extends JdbiConfig<C>> JdbiExtension	withConfig(Class<C> configClass, Consumer<C> configurer)	Set a JdbiConfig parameter when creating the Jdbi instance.
final JdbiExtension	withInitializer(JdbiExtensionInitializer initializer)	Sets a JdbiExtensionInitializer to initialize the Jdbi instance or the attached data source before running a test.
final JdbiExtension	withPlugin(JdbiPlugin plugin)	Install a JdbiPlugin when creating the Jdbi instance.
final JdbiExtension	withPlugins(JdbiPlugin... pluginList)	Install multiple JdbiPlugins when creating the Jdbi instance.

Methods inherited from class Object

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

Methods inherited from interface TestInstantiationAwareExtension

getTestInstantiationExtensionContextScope

Constructor Details

JdbiH2Extension

public JdbiH2Extension()

JdbiH2Extension

public JdbiH2Extension(String options)

Allows setting the options string for the H2 database. The value here is appended to the database URL.

Parameters:

options - The options string. Must not be null. May start with a semicolon.

Method Details

withUser

public JdbiH2Extension withUser(String user)

Sets the H2 username.

Parameters:

user - The username. Can be null.

Returns:

This object.

withCredentials

public JdbiH2Extension withCredentials(String user,
 String password)

Sets the H2 username and password.

Parameters:

user - The username. Can be null.

password - The password. Can be null.

Returns:

This object.

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.