Skip to content

Add Neo4J container implementation under org.testcontainers.neo4j #11097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eddumelendez merged 1 commit into from
Oct 10, 2025
Merged

Add Neo4J container implementation under org.testcontainers.neo4j #11097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/modules/databases/neo4j.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@ You are not limited to Unit tests, and you can use an instance of the Neo4j Test
A custom password can be provided:

<!--codeinclude-->
[Custom password](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:withAdminPassword
[Custom password](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:withAdminPassword
<!--/codeinclude-->

### Disable authentication

Authentication can be disabled:

<!--codeinclude-->
[Disable authentication](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:withoutAuthentication
[Disable authentication](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:withoutAuthentication
<!--/codeinclude-->

### Random password

A random (`UUID`-random based) password can be set:

<!--codeinclude-->
[Random password](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:withRandomPassword
[Random password](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:withRandomPassword
<!--/codeinclude-->

### Neo4j-Configuration
Expand All @@ -54,21 +54,21 @@ Neo4j's Docker image needs Neo4j configuration options in a dedicated format.
The container takes care of that, and you can configure the database with standard options like the following:

<!--codeinclude-->
[Neo4j configuration](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:neo4jConfiguration
[Neo4j configuration](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:neo4jConfiguration
<!--/codeinclude-->

### Add custom plugins

Custom plugins, like APOC, can be copied over to the container from any classpath or host resource like this:

<!--codeinclude-->
[Plugin jar](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:registerPluginsJar
[Plugin jar](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:registerPluginsJar
<!--/codeinclude-->

Whole directories work as well:

<!--codeinclude-->
[Plugin folder](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:registerPluginsPath
[Plugin folder](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:registerPluginsPath
<!--/codeinclude-->

### Add Neo4j Docker Labs plugins
Expand All @@ -81,7 +81,7 @@ or [Neo4j 5 plugin list](https://neo4j.com/docs/operations-manual/5/configuratio
Please the method `withPlugins(String... plugins)`.

<!--codeinclude-->
[Configure Neo4j Labs Plugins](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:configureLabsPlugins
[Configure Neo4j Labs Plugins](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:configureLabsPlugins
<!--/codeinclude-->


Expand All @@ -90,7 +90,7 @@ or [Neo4j 5 plugin list](https://neo4j.com/docs/operations-manual/5/configuratio
If you have an existing database (`graph.db`) you want to work with, copy it over to the container like this:

<!--codeinclude-->
[Copy database](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:copyDatabase
[Copy database](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:copyDatabase
<!--/codeinclude-->

!!! note
Expand All @@ -101,7 +101,7 @@ If you have an existing database (`graph.db`) you want to work with, copy it ove
If you need the Neo4j enterprise license, you can declare your Neo4j container like this:

<!--codeinclude-->
[Enterprise edition](../../../modules/neo4j/src/test/java/org/testcontainers/containers/Neo4jContainerTest.java) inside_block:enterpriseEdition
[Enterprise edition](../../../modules/neo4j/src/test/java/org/testcontainers/neo4j/Neo4jContainerTest.java) inside_block:enterpriseEdition
<!--/codeinclude-->

This creates a Testcontainers based on the Docker image build with the Enterprise version of Neo4j 4.4.
Expand Down
3 changes: 3 additions & 0 deletions modules/neo4j/src/main/java/org/testcontainers/containers/Neo4jContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@
* <li>HTTP: 7474</li>
* <li>HTTPS: 7473</li>
* </ul>
*
* @deprecated use {@link org.testcontainers.neo4j.Neo4jContainer} instead.
*/
@Deprecated
public class Neo4jContainer extends GenericContainer<Neo4jContainer> {

/**
Expand Down
Loading
Loading