org.testcontainers.containers

Class Neo4jContainer<S extends Neo4jContainer<S>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<S>

org.testcontainers.containers.Neo4jContainer<S>

All Implemented Interfaces:

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

public class Neo4jContainer<S extends Neo4jContainer<S>>
extends org.testcontainers.containers.GenericContainer<S>

Testcontainers implementation for Neo4j.

Supported image: neo4j

Exposed ports:

• Bolt: 7687
• HTTP: 7474
• HTTPS: 7473

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 org.testcontainers.containers.wait.strategy.WaitStrategy	WAIT_FOR_BOLT Default wait strategies

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
Neo4jContainer() Deprecated. use Neo4jContainer(DockerImageName) instead
Neo4jContainer(org.testcontainers.utility.DockerImageName dockerImageName) Creates a Neo4jContainer using a specific docker image.
Neo4jContainer(java.lang.String dockerImageName) Creates a Neo4jContainer using a specific docker image.

Method Summary

Modifier and Type	Method and Description
protected void	configure()
java.lang.String	getAdminPassword()
java.lang.String	getBoltUrl()
java.lang.String	getHttpsUrl()
java.lang.String	getHttpUrl()
java.util.Set<java.lang.Integer>	getLivenessCheckPortNumbers()
S	withAdminPassword(java.lang.String adminPassword) Sets the admin password for the default account (which is
S	withDatabase(org.testcontainers.utility.MountableFile graphDb) Copies an existing graph.db folder into the container.
S	withEnterpriseEdition() Configures the container to use the enterprise edition of the default docker image.
S	withLabsPlugins(Neo4jLabsPlugin... neo4jLabsPlugins) Deprecated. Neo4jLabsPlugin were deprecated due to naming changes that cannot be solved by this enumeration. Please use the withPlugins(String...) method.
S	withLabsPlugins(java.lang.String... neo4jLabsPlugins) Deprecated. Please use withPlugins(String...) for named plugins.
S	withNeo4jConfig(java.lang.String key, java.lang.String value) Adds Neo4j configuration properties to the container.
S	withoutAuthentication() Disables authentication.
S	withPlugins(org.testcontainers.utility.MountableFile plugins) Adds plugins to the given directory to the container.
S	withPlugins(java.lang.String... plugins) Registers one or more Neo4j plugins for server startup.
S	withRandomPassword()

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, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, 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, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

WAIT_FOR_BOLT

public static final org.testcontainers.containers.wait.strategy.WaitStrategy WAIT_FOR_BOLT

Default wait strategies

Constructor Detail

Neo4jContainer

@Deprecated
public Neo4jContainer()

Deprecated. use Neo4jContainer(DockerImageName) instead

Creates a Neo4jContainer using the official Neo4j docker image.

Neo4jContainer

public Neo4jContainer(java.lang.String dockerImageName)

Creates a Neo4jContainer using a specific docker image.

Parameters:

dockerImageName - The docker image to use.

Neo4jContainer

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

Creates a Neo4jContainer using a specific docker image.

Parameters:

dockerImageName - The docker image to use.

Method Detail

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<S extends Neo4jContainer<S>>

configure

protected void configure()

Overrides:

configure in class org.testcontainers.containers.GenericContainer<S extends Neo4jContainer<S>>

getBoltUrl

public java.lang.String getBoltUrl()

Returns:

Bolt URL for use with Neo4j's Java-Driver.

getHttpUrl

public java.lang.String getHttpUrl()

Returns:

URL of the transactional HTTP endpoint.

getHttpsUrl

public java.lang.String getHttpsUrl()

Returns:

URL of the transactional HTTPS endpoint.

withEnterpriseEdition

public S withEnterpriseEdition()

Configures the container to use the enterprise edition of the default docker image.

Please have a look at the Neo4j Licensing page. While the Neo4j Community Edition can be used for free in your projects under the GPL v3 license, Neo4j Enterprise edition needs either a commercial, education or evaluation license.

Returns:

This container.

withAdminPassword

public S withAdminPassword(java.lang.String adminPassword)

Sets the admin password for the default account (which is

neo4j

). A null value or an empty string disables authentication.

Parameters:

adminPassword - The admin password for the default database account.

Returns:

This container.

withoutAuthentication

public S withoutAuthentication()

Disables authentication.

Returns:

This container.

withDatabase

public S withDatabase(org.testcontainers.utility.MountableFile graphDb)

Copies an existing graph.db folder into the container. This can either be a classpath resource or a host resource. Please have a look at the factory methods in MountableFile.
If you want to map your database into the container instead of copying them, please use #withClasspathResourceMapping, but this will only work when your test does not run in a container itself.
Note: This method only works with Neo4j 3.5.
Mapping would work like this:

      @Container
      private static final Neo4jContainer databaseServer = new Neo4jContainer<>()
          .withClasspathResourceMapping("/test-graph.db", "/data/databases/graph.db", BindMode.READ_WRITE);
 

Parameters:

graphDb - The graph.db folder to copy into the container

Returns:

This container.

Throws:

java.lang.IllegalArgumentException - If the database version is not 3.5.

withPlugins

public S withPlugins(org.testcontainers.utility.MountableFile plugins)

Adds plugins to the given directory to the container. If plugins denotes a directory, than all of that directory is mapped to Neo4j's plugins. Otherwise, single resources are copied over.
If you want to map your plugins into the container instead of copying them, please use #withClasspathResourceMapping, but this will only work when your test does not run in a container itself.

Parameters:

plugins -

Returns:

This container.

withNeo4jConfig

public S withNeo4jConfig(java.lang.String key,
                         java.lang.String value)

Adds Neo4j configuration properties to the container. The properties can be added as in the official Neo4j configuration, the method automatically translate them into the format required by the Neo4j container.

Parameters:

key - The key to configure, i.e. dbms.security.procedures.unrestricted

value - The value to set

Returns:

This container.

getAdminPassword

public java.lang.String getAdminPassword()

Returns:

The admin password for the neo4j account or literal null if auth is disabled.

withLabsPlugins

public S withLabsPlugins(Neo4jLabsPlugin... neo4jLabsPlugins)

Deprecated. Neo4jLabsPlugin were deprecated due to naming changes that cannot be solved by this enumeration. Please use the withPlugins(String...) method.

Registers one or more Neo4jLabsPlugin for download and server startup.

Parameters:

neo4jLabsPlugins - The Neo4j plugins that should get started with the server.

Returns:

This container.

withLabsPlugins

public S withLabsPlugins(java.lang.String... neo4jLabsPlugins)

Deprecated. Please use withPlugins(String...) for named plugins.

withPlugins

public S withPlugins(java.lang.String... plugins)

Registers one or more Neo4j plugins for server startup. The plugins are listed here

• Neo4j 5
• Neo4j 4.4

Parameters:

plugins - The Neo4j plugins that should get started with the server.

Returns:

This container.

withRandomPassword

public S withRandomPassword()