Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addConnectionProperty(String, String) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Adds a connection property.
- addCustomizer(Consumer<FluentConfiguration>) - Method in class de.softwareforge.testing.postgres.embedded.FlywayPreparer
-
Add a customizer instance.
- addCustomizers(Set<Consumer<FluentConfiguration>>) - Method in class de.softwareforge.testing.postgres.embedded.FlywayPreparer
-
Add customizer instances.
- addInitDbConfiguration(String, String) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Adds a configuration parameters for the
initdb
command. - addServerConfiguration(String, String) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Adds a server configuration parameter.
- afterAll(ExtensionContext) - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
- afterEach(ExtensionContext) - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
- asDataSource() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseInfo
-
Returns a
DataSource
instance connected to the described database. - asJdbcUrl() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseInfo
-
Returns a JDBC url to connect to the described database.
- atLeast() - Element in annotation type de.softwareforge.testing.postgres.junit5.RequirePostgresVersion
-
Sets the minimum required version.
B
- beforeAll(ExtensionContext) - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
- beforeEach(ExtensionContext) - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
- build() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
-
Creates a new instance.
- build() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager.DatabaseManagerBuilder
-
Creates a new
DatabaseManager
instance from the builder. - build() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Creates and boots a new
EmbeddedPostgres
instance. - build() - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension.EmbeddedPgExtensionBuilder
-
Create a
EmbeddedPgExtension
instance. - builder() - Static method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Returns a new
EmbeddedPostgres.Builder
. - Builder(boolean) - Constructor for class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
-
Creates a new builder.
- builderWithDefaults() - Static method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Returns a builder with default
EmbeddedPostgres.Builder.withDefaults()
configuration already applied.
C
- close() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager
- close() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Closing an
EmbeddedPostgres
instance shuts down the connected database instance. - connectionProperties() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseInfo
-
Returns all properties that are be applied to a new data source connection to this database.
- createDatabaseInfo() - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
-
Returns a new
DatabaseInfo
describing a database connection. - createDataSource() - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
-
Returns a data source.
- createDataSource(String, String) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Creates a
DataSource
with a specific user and database name. - createDefaultDataSource() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Creates a
DataSource
object that connects to the default database. - createTemplateDataSource() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Creates a
DataSource
object that connects to the standard system database.
D
- DatabaseInfo - Class in de.softwareforge.testing.postgres.embedded
-
Information about a database located on a PostgreSQL server connected to an
EmbeddedPostgres
instance. - DatabaseManager - Class in de.softwareforge.testing.postgres.embedded
-
Controls database instances on a PostgreSQL server instances.
- DatabaseManager.Builder<T> - Class in de.softwareforge.testing.postgres.embedded
-
Builder template.
- DatabaseManager.DatabaseManagerBuilder - Class in de.softwareforge.testing.postgres.embedded
-
Create new
DatabaseManager
instances. - DatabaseManagerBuilder(boolean) - Constructor for class de.softwareforge.testing.postgres.embedded.DatabaseManager.DatabaseManagerBuilder
-
Creates a new builder for
DatabaseManager
instances. - databasePreparers - Variable in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
- dbName() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseInfo
-
Returns the name of the database.
- de.softwareforge.testing.postgres.embedded - package de.softwareforge.testing.postgres.embedded
-
PostgreSQL management code.
- de.softwareforge.testing.postgres.junit5 - package de.softwareforge.testing.postgres.junit5
-
JUnit 5 integration code.
- DEFAULT_POSTGRES_VERSION - Static variable in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
The version of postgres used if no specific version has been given.
- defaultInstance() - Static method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Returns an instance that has been started and configured.
E
- EmbeddedPgExtension - Class in de.softwareforge.testing.postgres.junit5
-
A JUnit 5 extension that manages an embedded PostgreSQL database server.
- EmbeddedPgExtension() - Constructor for class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
-
Default constructor which allows using this extension with the
ExtendWith
annotation. - EmbeddedPgExtension.EmbeddedPgExtensionBuilder - Class in de.softwareforge.testing.postgres.junit5
-
Builder for
EmbeddedPgExtension
customization. - EmbeddedPostgres - Class in de.softwareforge.testing.postgres.embedded
-
Manages an embedded PostgreSQL server instance.
- EmbeddedPostgres.Builder - Class in de.softwareforge.testing.postgres.embedded
-
Creates a new
EmbeddedPostgres
instance and starts it. - EmbeddedPostgresPreparer<T> - Interface in de.softwareforge.testing.postgres.embedded
-
Prepare a specific object instance.
- equals(Object) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
- equals(Object) - Method in class de.softwareforge.testing.postgres.embedded.ZonkyIOPostgresLocator
- evaluateExecutionCondition(ExtensionContext) - Method in class de.softwareforge.testing.postgres.junit5.PostgresVersionCondition
F
- FlywayPreparer - Class in de.softwareforge.testing.postgres.embedded
-
An
EmbeddedPostgresPreparer<DataSource>
that uses the Flyway version control for your database framework to migrate a data source to a known state. - FlywayPreparer() - Constructor for class de.softwareforge.testing.postgres.embedded.FlywayPreparer
-
Create a new, uninitialized preparer instance.
- forClasspathLocation(String...) - Static method in class de.softwareforge.testing.postgres.embedded.FlywayPreparer
-
Creates a new instance using one or more classpath locations.
- forVersionCheck() - Static method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
This returns an
EmbeddedPostgres
instance that can be solely used for version checking.
G
- getDatabaseInfo() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager
-
Returns a
DatabaseInfo
instance that describes a database. - getEmbeddedPostgres() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager
-
Return the
EmbeddedPostgres
instance that manages the database server which holds all of the databases managed by this database manager. - getIdentifier() - Method in interface de.softwareforge.testing.postgres.embedded.NativeBinaryLocator
-
Returns a string identifier that represents the archive returned.
- getIdentifier() - Method in class de.softwareforge.testing.postgres.embedded.ZonkyIOPostgresLocator
- getInputStream() - Method in interface de.softwareforge.testing.postgres.embedded.NativeBinaryLocator
-
Returns an input stream from which the contents of the binary archive can be read.
- getInputStream() - Method in class de.softwareforge.testing.postgres.embedded.ZonkyIOPostgresLocator
- getLocation() - Method in interface de.softwareforge.testing.postgres.embedded.NativeBinaryManager
-
Returns the location (installation directory) for the installed binary.
- getLocation() - Method in class de.softwareforge.testing.postgres.embedded.TarXzCompressedBinaryManager
- getPort() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Returns the network (TCP) port for the PostgreSQL server instance.
- getPostgresVersion() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Return the version of the PostgreSQL installation that is used by this instance.
H
- hashCode() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
- hashCode() - Method in class de.softwareforge.testing.postgres.embedded.ZonkyIOPostgresLocator
I
- INSTALL_DIRECTORY_PREFIX - Static variable in interface de.softwareforge.testing.postgres.embedded.NativeBinaryLocator
- instance() - Static method in class de.softwareforge.testing.postgres.junit5.MultiDatabaseBuilder
-
Create a builder without any customizations applied.
- instance() - Static method in class de.softwareforge.testing.postgres.junit5.SingleDatabaseBuilder
-
Create a builder without any customizations applied.
- instanceId() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
-
Returns the instance id for the PostgreSQL server instance.
- instancePreparers - Variable in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
- instanceWithDefaults() - Static method in class de.softwareforge.testing.postgres.junit5.MultiDatabaseBuilder
-
Create a builder with standard initializations (
EmbeddedPostgres.Builder.withDefaults()
) applied. - instanceWithDefaults() - Static method in class de.softwareforge.testing.postgres.junit5.SingleDatabaseBuilder
-
Create a builder with standard initializations (
EmbeddedPostgres.Builder.withDefaults()
) applied.
L
- lessThan() - Element in annotation type de.softwareforge.testing.postgres.junit5.RequirePostgresVersion
-
Sets the upper boundary version.
M
- MultiDatabaseBuilder - Class in de.softwareforge.testing.postgres.junit5
-
Create a new PostgreSQL server that supports multiple databases.
- multiDatabases() - Static method in class de.softwareforge.testing.postgres.embedded.DatabaseManager
-
Creates a new
DatabaseManager.Builder<DatabaseManager>
instance that will create a new database on each call toDatabaseManager.getDatabaseInfo()
. - multiMode - Variable in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
N
- NativeBinaryLocator - Interface in de.softwareforge.testing.postgres.embedded
-
Locates a native binary on the Filesystem.
- NativeBinaryManager - Interface in de.softwareforge.testing.postgres.embedded
-
Returns an installation location for a native binary.
- noOp() - Static method in interface de.softwareforge.testing.postgres.embedded.EmbeddedPostgresPreparer
-
Returns a typed instance of a no-op (do nothing) preparer.
P
- port() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseInfo
-
Returns the TCP port for the database server.
- PostgresVersionCondition - Class in de.softwareforge.testing.postgres.junit5
- PostgresVersionCondition() - Constructor for class de.softwareforge.testing.postgres.junit5.PostgresVersionCondition
- prepare(DataSource) - Method in class de.softwareforge.testing.postgres.embedded.FlywayPreparer
- prepare(T) - Method in interface de.softwareforge.testing.postgres.embedded.EmbeddedPostgresPreparer
-
Callback to customize a given object instance.
- preparedInstance(EmbeddedPostgresPreparer<DataSource>) - Static method in class de.softwareforge.testing.postgres.junit5.MultiDatabaseBuilder
-
Create a builder and register a
EmbeddedPostgresPreparer<DataSource>
to set up the template database. - preparedInstance(EmbeddedPostgresPreparer<DataSource>) - Static method in class de.softwareforge.testing.postgres.junit5.SingleDatabaseBuilder
-
Create a builder and register a
EmbeddedPostgresPreparer<DataSource>
to set up the database. - preparedInstanceWithDefaults(EmbeddedPostgresPreparer<DataSource>) - Static method in class de.softwareforge.testing.postgres.junit5.MultiDatabaseBuilder
-
Create a builder with standard initializations (
EmbeddedPostgres.Builder.withDefaults()
) applied and register aEmbeddedPostgresPreparer<DataSource>
to set up the template database. - preparedInstanceWithDefaults(EmbeddedPostgresPreparer<DataSource>) - Static method in class de.softwareforge.testing.postgres.junit5.SingleDatabaseBuilder
-
Create a builder with standard initializations (
EmbeddedPostgres.Builder.withDefaults()
) applied and register aEmbeddedPostgresPreparer<DataSource>
to set up the database.
R
- RequirePostgresVersion - Annotation Type in de.softwareforge.testing.postgres.junit5
-
RequirePostgresVersion
signals the annotated test class or method that it only should execute if the PostgreSQL server is within a specific range. - resolveParameter(ParameterContext, ExtensionContext) - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
S
- setDataDirectory(File) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Explicitly set the location of the data directory.
- setDataDirectory(String) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Explicitly set the location of the data directory.
- setDataDirectory(Path) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Explicitly set the location of the data directory.
- setErrorRedirector(ProcessBuilder.Redirect) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Set a
ProcessBuilder.Redirect
instance to receive stderr output from the spawned processes. - setInstallationBaseDirectory(File) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Sets the directory where the PostgreSQL distribution is unpacked.
- setInstallationBaseDirectory(File) - Method in interface de.softwareforge.testing.postgres.embedded.NativeBinaryManager
-
Sets the installation directory.
- setInstallationBaseDirectory(File) - Method in class de.softwareforge.testing.postgres.embedded.TarXzCompressedBinaryManager
- setLockFileName(String) - Method in class de.softwareforge.testing.postgres.embedded.TarXzCompressedBinaryManager
-
Sets the lock file name.
- setNativeBinaryManager(NativeBinaryManager) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Sets the
NativeBinaryManager
that provides the location of the postgres installation. - setOutputRedirector(ProcessBuilder.Redirect) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Set a
ProcessBuilder.Redirect
instance to receive stdout output from the spawned processes. - setPort(int) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Explicitly set the TCP port for the PostgreSQL server.
- setRemoveDataOnShutdown(boolean) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Whether to remove the data directory on server shutdown.
- setServerStartupWait(Duration) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Sets the time that the builder will wait for the PostgreSQL server instance to start.
- setServerVersion(String) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Set the version of the PostgreSQL server.
- singleDatabase() - Static method in class de.softwareforge.testing.postgres.embedded.DatabaseManager
-
Creates a new
DatabaseManager.Builder<DatabaseManager>
instance that will return a connection to the same database on each call toDatabaseManager.getDatabaseInfo()
. - SingleDatabaseBuilder - Class in de.softwareforge.testing.postgres.junit5
-
Create a new PostgreSQL server that supports a single database.
- start() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager
-
Start the database server and the machinery that will provide new database instances.
- supportsParameter(ParameterContext, ExtensionContext) - Method in class de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension
T
- TarXzCompressedBinaryManager - Class in de.softwareforge.testing.postgres.embedded
-
Loads a native binary installation and returns the location of it.
- TarXzCompressedBinaryManager(NativeBinaryLocator) - Constructor for class de.softwareforge.testing.postgres.embedded.TarXzCompressedBinaryManager
-
Creates a new binary manager for tar-xz compressed archives.
- toString() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres
- toString() - Method in class de.softwareforge.testing.postgres.embedded.ZonkyIOPostgresLocator
U
- useLocalPostgresInstallation(File) - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Use a locally installed PostgreSQL server for tests.
- user() - Method in class de.softwareforge.testing.postgres.embedded.DatabaseInfo
-
Returns the user that can connect to this database.
W
- withDatabasePreparer(EmbeddedPostgresPreparer<DataSource>) - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
-
Add a preparer for the template database.
- withDatabasePreparers(Set<EmbeddedPostgresPreparer<DataSource>>) - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
-
Add preparers for the template database.
- withDefaults() - Method in class de.softwareforge.testing.postgres.embedded.EmbeddedPostgres.Builder
-
Apply a set of defaults to the database server: timezone: UTC synchronous_commit: off max_connections: 300
- withInstancePreparer(EmbeddedPostgresPreparer<EmbeddedPostgres.Builder>) - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
-
Add a preparer for the
EmbeddedPostgres.Builder
object. - withInstancePreparers(Set<EmbeddedPostgresPreparer<EmbeddedPostgres.Builder>>) - Method in class de.softwareforge.testing.postgres.embedded.DatabaseManager.Builder
-
Add preparers for the
EmbeddedPostgres.Builder
object.
Z
- ZonkyIOPostgresLocator - Class in de.softwareforge.testing.postgres.embedded
-
Resolves PostgreSQL archives from the Maven repository.
All Classes and Interfaces|All Packages|Constant Field Values