KnowForge/Testcontainers for Go
Quickstart

Neo4j

qianmoQqianmoQ· 更新于 2026-10-14· 阅读 32 分钟· 0 次阅读
登录后可跨设备保存划线和私人笔记登录

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:

Creating a Neo4j container

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

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:

Container Ports

defaultBoltPort  = "7687/tcp"
defaultHTTPPort  = "7474/tcp"
defaultHTTPSPort = "7473/tcp"

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

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.

Including a custom logger

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

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

By default, the Neo4j container will start without any Labs plugins enabled, but you can enable them using the WithLabsPlugin optional function.

Adding Labs Plugins

neo4j.WithLabsPlugin(neo4j.Apoc),

The list of available plugins is:

Labs plugins

Apoc             LabsPlugin = "apoc"
ApocCore         LabsPlugin = "apoc-core"
Bloom            LabsPlugin = "bloom"
GraphDataScience LabsPlugin = "graph-data-science"
NeoSemantics     LabsPlugin = "n10s"
Streams          LabsPlugin = "streams"

WithNeo4jSettings

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.

Adding settings

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

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

Bolt URL

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>.

Connect to Neo4j

boltURL, err := container.BoltUrl(ctx)

评论

登录后参与评论

正在加载评论…