Neo4j¶
Since v0.20.0
Introduction¶
The Testcontainers module for Neo4j, the leading graph platform.
Adding this module to your project dependencies¶
Please run the following command to add the Neo4j module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/neo4j
Usage example¶
Running Neo4j as a single-instance server, with the APOC plugin enabled:
ctx := context.Background()
testPassword := "letmein!"
neo4jContainer, err := neo4j.Run(ctx,
"neo4j:4.4",
neo4j.WithAdminPassword(testPassword),
neo4j.WithLabsPlugin(neo4j.Apoc),
neo4j.WithNeo4jSetting("dbms.tx_log.rotation.size", "42M"),
)
defer func() {
if err := testcontainers.TerminateContainer(neo4jContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}
Module Reference¶
Run function¶
- Since v0.32.0
Info
The RunContainer(ctx, opts...)
function is deprecated and will be removed in the next major release of Testcontainers for Go.
The Neo4j module exposes one entrypoint function to create the Neo4j container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Neo4jContainer, error)
context.Context
, the Go context.string
, the Docker image to use.testcontainers.ContainerCustomizer
, a variadic argument for passing options.
Container Ports¶
These are the ports used by the Neo4j container:
defaultBoltPort = "7687"
defaultHTTPPort = "7474"
defaultHTTPSPort = "7473"
Image¶
Use the second argument in the Run
function to set a valid Docker image.
In example: Run(context.Background(), "neo4j:4.4")
.
Container Options¶
When starting the Neo4j container, you can pass options in a variadic way to configure it.
Logger¶
- DEPRECATED: Use testcontainers.WithLogger instead.
- Since v0.20.0
This option sets a custom logger to be used by the container. Consider calling this before other With
functions as these may generate logs.
Info
The logger must implement the testcontainers-go log.Logger
interface.
logger := &inMemoryLogger{}
ctr, err := neo4j.Run(ctx,
"neo4j:4.4",
testcontainers.WithLogger(logger), // needs to go before WithNeo4jSetting and WithNeo4jSettings
neo4j.WithAdminPassword(testPassword),
neo4j.WithNeo4jSetting("some.key", "value1"),
neo4j.WithNeo4jSettings(map[string]string{"some.key": "value2"}),
neo4j.WithNeo4jSetting("some.key", "value3"),
)
Authentication¶
- Since v0.20.0
By default, the Neo4j container will be started with authentication disabled. If you need to enable authentication, you can
use the WithAdminPassword(pwd string)
option.
By default, the container will not use authentication, automatically prepending the WithoutAuthentication
option to the options list.
WithLabsPlugins¶
- Since v0.20.0
By default, the Neo4j container will start without any Labs plugins enabled, but you can enable them using the WithLabsPlugin
optional function.
neo4j.WithLabsPlugin(neo4j.Apoc),
The list of available plugins is:
Apoc LabsPlugin = "apoc"
ApocCore LabsPlugin = "apoc-core"
Bloom LabsPlugin = "bloom"
GraphDataScience LabsPlugin = "graph-data-science"
NeoSemantics LabsPlugin = "n10s"
Streams LabsPlugin = "streams"
WithNeo4jSettings¶
- Since v0.20.0
It's possible to add Neo4j a single configuration setting to the container.
The setting can be added as in the official Neo4j configuration, the function automatically translates the setting
name (e.g. `dbms.tx_log.rotation.size
) into the format required by the Neo4j container.
This function can be called multiple times. A warning is emitted if a key is overwritten.
To pass multiple settings at once, the WithNeo4jSettings
function is provided.
logger := &inMemoryLogger{}
ctr, err := neo4j.Run(ctx,
"neo4j:4.4",
testcontainers.WithLogger(logger), // needs to go before WithNeo4jSetting and WithNeo4jSettings
neo4j.WithAdminPassword(testPassword),
neo4j.WithNeo4jSetting("some.key", "value1"),
neo4j.WithNeo4jSettings(map[string]string{"some.key": "value2"}),
neo4j.WithNeo4jSetting("some.key", "value3"),
)
Warning
Credentials must be configured with the WithAdminPassword
optional function.
The following options are exposed by the testcontainers
package.
Basic Options¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Not available until the next release mainWithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Not available until the next release mainWithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Not available until the next release mainWithAdditionalLifecycleHooks
Not available until the next release mainWithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Not available until the next release mainWithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Not available until the next release mainWithImageSubstitutors
Since v0.26.0WithImagePlatform
Not available until the next release main
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Not available until the next release mainWithBridgeNetwork
Not available until the next release mainWithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Not available until the next release mainWithNoStart
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
Bolt URL¶
- Since v0.20.0
The BoltURL
method returns the connection string to connect to the Neo4j container instance using the Bolt port.
It returns a string with the format neo4j://<host>:<port>
.
boltURL, err := container.BoltUrl(ctx)