Module de.softwareforge.testing.postgres

Package de.softwareforge.testing.postgres.junit5

Class EmbeddedPgExtension

java.lang.Object

de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension

All Implemented Interfaces:

AfterAllCallback, AfterEachCallback, BeforeAllCallback, BeforeEachCallback, Extension, ParameterResolver

public final class EmbeddedPgExtension
extends Object
implements BeforeAllCallback, AfterAllCallback, BeforeEachCallback, AfterEachCallback, ParameterResolver

A JUnit 5 extension that manages an embedded PostgreSQL database server.

This extension can provide the EmbeddedPostgres instance, a DatabaseInfo or a DataSource object as test parameters.

• Using a DatabaseInfo parameter is equivalent to calling createDatabaseInfo().
• Using a DataSource parameter is equivalent to calling createDataSource().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EmbeddedPgExtension.EmbeddedPgExtensionBuilder	Builder for EmbeddedPgExtension customization.

Constructor Summary

Constructors

Constructor	Description
EmbeddedPgExtension()	Default constructor which allows using this extension with the ExtendWith annotation.

Method Summary

Modifier and Type	Method	Description
void	afterAll(ExtensionContext extensionContext)
void	afterEach(ExtensionContext extensionContext)
void	beforeAll(ExtensionContext extensionContext)
void	beforeEach(ExtensionContext extensionContext)
DatabaseInfo	createDatabaseInfo()	Returns a new DatabaseInfo describing a database connection.
DataSource	createDataSource()	Returns a data source.
Object	resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
boolean	supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)

Methods inherited from class java.lang.Object

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

Constructor Details

EmbeddedPgExtension

public EmbeddedPgExtension()

Default constructor which allows using this extension with the ExtendWith annotation.

This is equivalent to using

     @RegisterExtension
     public static EmbeddedPgExtension pg = MultiDatabaseBuilder.instanceWithDefaults().build();
     

Method Details

createDataSource

@NonNull
public DataSource createDataSource()
                            throws SQLException

Returns a data source. Depending on the mode it returns a datasource connected to the same database (single mode) or a new database (multi mode) on every call.

Returns:

A DataSource instance. This is never null.

Throws:

SQLException - If a problem connecting to the database occurs.

createDatabaseInfo

@NonNull
public DatabaseInfo createDatabaseInfo()
                                throws SQLException

Returns a new DatabaseInfo describing a database connection.

Depending on the mode, this either describes the same database (single mode) or a new database (multi mode).

Returns:

A DatabaseInfo instance. This is never null.

Throws:

SQLException - If a problem connecting to the database occurs.

beforeAll

public void beforeAll(@NonNull
 ExtensionContext extensionContext)
               throws Exception

Specified by:

beforeAll in interface BeforeAllCallback

Throws:

Exception

afterAll

public void afterAll(@NonNull
 ExtensionContext extensionContext)
              throws Exception

Specified by:

afterAll in interface AfterAllCallback

Throws:

Exception

beforeEach

public void beforeEach(@NonNull
 ExtensionContext extensionContext)
                throws Exception

Specified by:

beforeEach in interface BeforeEachCallback

Throws:

Exception

afterEach

public void afterEach(@NonNull
 ExtensionContext extensionContext)
               throws Exception

Specified by:

afterEach in interface AfterEachCallback

Throws:

Exception

supportsParameter

public boolean supportsParameter(@NonNull
 ParameterContext parameterContext,
 ExtensionContext extensionContext)

Specified by:

supportsParameter in interface ParameterResolver

resolveParameter

public Object resolveParameter(@NonNull
 ParameterContext parameterContext,
 ExtensionContext extensionContext)

Specified by:

resolveParameter in interface ParameterResolver