org.testcontainers.utility

Class TestcontainersConfiguration

java.lang.Object

org.testcontainers.utility.TestcontainersConfiguration

public class TestcontainersConfiguration
extends java.lang.Object

Provides a mechanism for fetching configuration/default settings.

Configuration may be provided in:

• A file in the user's home directory named .testcontainers.properties
• A file in the classpath named testcontainers.properties
• Environment variables

Note that, if using environment variables, property names are in upper case separated by underscores, preceded by TESTCONTAINERS_.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	environmentSupportsReuse()
boolean	equals(java.lang.Object o)
java.lang.String	getAmbassadorContainerImage() Deprecated.
java.util.Properties	getClasspathProperties()
java.lang.Integer	getClientPingTimeout()
java.lang.String	getDockerClientStrategyClassName()
java.lang.String	getDockerComposeContainerImage() Deprecated.
java.util.Map<java.lang.String,java.lang.String>	getEnvironment()
java.lang.String	getEnvVarOrProperty(@NotNull java.lang.String propertyName, @Nullable java.lang.String defaultValue) Gets a configured setting from an environment variable (if present) or a configuration file property otherwise.
java.lang.String	getEnvVarOrUserProperty(@NotNull java.lang.String propertyName, @Nullable java.lang.String defaultValue) Gets a configured setting from an environment variable (if present) or a configuration file property otherwise.
java.lang.Integer	getImagePullPauseTimeout()
java.lang.String	getImageSubstitutorClassName()
static TestcontainersConfiguration	getInstance()
java.lang.String	getKafkaImage() Deprecated.
java.lang.String	getLocalStackImage() Deprecated.
java.lang.String	getOracleImage() Deprecated.
java.util.Properties	getProperties() Deprecated. usages should be removed ASAP. See getEnvVarOrProperty(String, String), getEnvVarOrUserProperty(String, String) or getUserProperty(String, String) for suitable replacements.
java.lang.String	getPulsarImage() Deprecated.
java.lang.String	getRyukImage() Deprecated.
java.lang.Integer	getRyukTimeout()
java.lang.String	getSocatContainerImage() Deprecated.
java.lang.String	getSSHdImage() Deprecated.
java.lang.String	getTinyImage() Deprecated.
java.lang.String	getTransportType()
java.util.Properties	getUserProperties()
java.lang.String	getUserProperty(@NotNull java.lang.String propertyName, @Nullable java.lang.String defaultValue) Gets a configured setting from an environment variable.
java.lang.String	getVncRecordedContainerImage() Deprecated.
int	hashCode()
boolean	isDisableChecks()
boolean	isRyukPrivileged()
java.lang.String	toString()
boolean	updateGlobalConfig(@NonNull java.lang.String prop, @NonNull java.lang.String value) Deprecated.
boolean	updateUserConfig(@NonNull java.lang.String prop, @NonNull java.lang.String value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAmbassadorContainerImage

@Deprecated
public java.lang.String getAmbassadorContainerImage()

Deprecated.

getSocatContainerImage

@Deprecated
public java.lang.String getSocatContainerImage()

Deprecated.

getVncRecordedContainerImage

@Deprecated
public java.lang.String getVncRecordedContainerImage()

Deprecated.

getDockerComposeContainerImage

@Deprecated
public java.lang.String getDockerComposeContainerImage()

Deprecated.

getTinyImage

@Deprecated
public java.lang.String getTinyImage()

Deprecated.

isRyukPrivileged

public boolean isRyukPrivileged()

getRyukImage

@Deprecated
public java.lang.String getRyukImage()

Deprecated.

getSSHdImage

@Deprecated
public java.lang.String getSSHdImage()

Deprecated.

getRyukTimeout

public java.lang.Integer getRyukTimeout()

getKafkaImage

@Deprecated
public java.lang.String getKafkaImage()

Deprecated.

getOracleImage

@Deprecated
public java.lang.String getOracleImage()

Deprecated.

getPulsarImage

@Deprecated
public java.lang.String getPulsarImage()

Deprecated.

getLocalStackImage

@Deprecated
public java.lang.String getLocalStackImage()

Deprecated.

isDisableChecks

public boolean isDisableChecks()

environmentSupportsReuse

@UnstableAPI
public boolean environmentSupportsReuse()

getDockerClientStrategyClassName

public java.lang.String getDockerClientStrategyClassName()

getTransportType

public java.lang.String getTransportType()

getImagePullPauseTimeout

public java.lang.Integer getImagePullPauseTimeout()

getImageSubstitutorClassName

public java.lang.String getImageSubstitutorClassName()

getClientPingTimeout

public java.lang.Integer getClientPingTimeout()

getEnvVarOrProperty

@Contract(value="_, !null -> !null")
public java.lang.String getEnvVarOrProperty(@NotNull
                                                                                 @NotNull java.lang.String propertyName,
                                                                                 @Nullable
                                                                                 @Nullable java.lang.String defaultValue)

Gets a configured setting from an environment variable (if present) or a configuration file property otherwise. The configuration file will be the .testcontainers.properties file in the user's home directory or a testcontainers.properties found on the classpath.

Note that when searching environment variables, the prefix `TESTCONTAINERS_` will usually be applied to the property name, which will be converted to upper-case with underscore separators. This prefix will not be added if the property name begins `docker.`.

Parameters:

propertyName - name of configuration file property (dot-separated lower case)

Returns:

the found value, or null if not set

getEnvVarOrUserProperty

@Contract(value="_, !null -> !null")
public java.lang.String getEnvVarOrUserProperty(@NotNull
                                                                                     @NotNull java.lang.String propertyName,
                                                                                     @Nullable
                                                                                     @Nullable java.lang.String defaultValue)

Gets a configured setting from an environment variable (if present) or a configuration file property otherwise. The configuration file will be the .testcontainers.properties file in the user's home directory.

Note that when searching environment variables, the prefix `TESTCONTAINERS_` will usually be applied to the property name, which will be converted to upper-case with underscore separators. This prefix will not be added if the property name begins `docker.`.

Parameters:

propertyName - name of configuration file property (dot-separated lower case)

Returns:

the found value, or null if not set

getUserProperty

@Contract(value="_, !null -> !null")
public java.lang.String getUserProperty(@NotNull
                                                                             @NotNull java.lang.String propertyName,
                                                                             @Nullable
                                                                             @Nullable java.lang.String defaultValue)

Gets a configured setting from an environment variable.

Note that when searching environment variables, the prefix `TESTCONTAINERS_` will usually be applied to the property name, which will be converted to upper-case with underscore separators. This prefix will not be added if the property name begins `docker.`.

Parameters:

propertyName - name of configuration file property (dot-separated lower case)

Returns:

the found value, or null if not set

getProperties

@Deprecated
public java.util.Properties getProperties()

Deprecated. usages should be removed ASAP. See getEnvVarOrProperty(String, String), getEnvVarOrUserProperty(String, String) or getUserProperty(String, String) for suitable replacements.

Returns:

properties values available from user properties and classpath properties. Values set by environment variable are NOT included.

updateGlobalConfig

@Deprecated
public boolean updateGlobalConfig(@NonNull
                                              @NonNull java.lang.String prop,
                                              @NonNull
                                              @NonNull java.lang.String value)

Deprecated.

updateUserConfig

public boolean updateUserConfig(@NonNull
                                @NonNull java.lang.String prop,
                                @NonNull
                                @NonNull java.lang.String value)

getUserProperties

public java.util.Properties getUserProperties()

getClasspathProperties

public java.util.Properties getClasspathProperties()

getEnvironment

public java.util.Map<java.lang.String,java.lang.String> getEnvironment()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getInstance

public static TestcontainersConfiguration getInstance()