org.testcontainers.containers

Class InfluxDBContainer<SELF extends InfluxDBContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.testcontainers.containers.InfluxDBContainer<SELF>

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<SELF>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class InfluxDBContainer<SELF extends InfluxDBContainer<SELF>>
extends org.testcontainers.containers.GenericContainer<SELF>

See https://store.docker.com/images/influxdb

Nested Class Summary

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	INFLUXDB_PORT
static java.lang.String	VERSION Deprecated.

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
InfluxDBContainer() Deprecated. use InfluxDBContainer(DockerImageName) instead
InfluxDBContainer(org.testcontainers.utility.DockerImageName dockerImageName)
InfluxDBContainer(java.lang.String version) Deprecated. use InfluxDBContainer(DockerImageName) instead

Method Summary

Modifier and Type	Method and Description
protected void	configure()
java.util.Set<java.lang.Integer>	getLivenessCheckPortNumbers()
org.influxdb.InfluxDB	getNewInfluxDB()
java.lang.String	getUrl()
SELF	withAdmin(java.lang.String admin) Set env variable `INFLUXDB_ADMIN_USER`.
SELF	withAdminPassword(java.lang.String adminPassword) Set env variable `INFLUXDB_ADMIN_PASSWORD`.
SELF	withAuthEnabled(boolean authEnabled) Set env variable `INFLUXDB_HTTP_AUTH_ENABLED`.
SELF	withDatabase(java.lang.String database) Set env variable `INFLUXDB_DB`.
SELF	withPassword(java.lang.String password) Set env variable `INFLUXDB_USER_PASSWORD`.
SELF	withUsername(java.lang.String username) Set env variable `INFLUXDB_USER`.

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, containerIsCreated, containerIsStarted, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

INFLUXDB_PORT

public static final java.lang.Integer INFLUXDB_PORT

VERSION

@Deprecated
public static final java.lang.String VERSION

Deprecated.

See Also:

Constant Field Values

Constructor Detail

InfluxDBContainer

@Deprecated
public InfluxDBContainer()

Deprecated. use InfluxDBContainer(DockerImageName) instead

InfluxDBContainer

@Deprecated
public InfluxDBContainer(java.lang.String version)

Deprecated. use InfluxDBContainer(DockerImageName) instead

InfluxDBContainer

public InfluxDBContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Method Detail

configure

protected void configure()

Overrides:

configure in class org.testcontainers.containers.GenericContainer<SELF extends InfluxDBContainer<SELF>>

getLivenessCheckPortNumbers

public java.util.Set<java.lang.Integer> getLivenessCheckPortNumbers()

Specified by:

getLivenessCheckPortNumbers in interface org.testcontainers.containers.wait.strategy.WaitStrategyTarget

Overrides:

getLivenessCheckPortNumbers in class org.testcontainers.containers.GenericContainer<SELF extends InfluxDBContainer<SELF>>

withAuthEnabled

public SELF withAuthEnabled(boolean authEnabled)

Set env variable `INFLUXDB_HTTP_AUTH_ENABLED`.

Parameters:

authEnabled - Enables authentication.

Returns:

a reference to this container instance

withAdmin

public SELF withAdmin(java.lang.String admin)

Set env variable `INFLUXDB_ADMIN_USER`.

Parameters:

admin - The name of the admin user to be created. If this is unset, no admin user is created.

Returns:

a reference to this container instance

withAdminPassword

public SELF withAdminPassword(java.lang.String adminPassword)

Set env variable `INFLUXDB_ADMIN_PASSWORD`.

Parameters:

adminPassword - TThe password for the admin user configured with `INFLUXDB_ADMIN_USER`. If this is unset, a random password is generated and printed to standard out.

Returns:

a reference to this container instance

withDatabase

public SELF withDatabase(java.lang.String database)

Set env variable `INFLUXDB_DB`.

Parameters:

database - Automatically initializes a database with the name of this environment variable.

Returns:

a reference to this container instance

withUsername

public SELF withUsername(java.lang.String username)

Set env variable `INFLUXDB_USER`.

Parameters:

username - The name of a user to be created with no privileges. If `INFLUXDB_DB` is set, this user will be granted read and write permissions for that database.

Returns:

a reference to this container instance

withPassword

public SELF withPassword(java.lang.String password)

Set env variable `INFLUXDB_USER_PASSWORD`.

Parameters:

password - The password for the user configured with `INFLUXDB_USER`. If this is unset, a random password is generated and printed to standard out.

Returns:

a reference to this container instance

getUrl

public java.lang.String getUrl()

Returns:

a url to influxDb

getNewInfluxDB

public org.influxdb.InfluxDB getNewInfluxDB()

Returns:

a influxDb client