RabbitMQ¶

Since testcontainers-go v0.25.0

Introduction¶

The Testcontainers module for RabbitMQ.

Adding this module to your project dependencies¶

Please run the following command to add the RabbitMQ module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/rabbitmq

Usage example¶

Creating a RabbitMQ container

ctx := context.Background()

rabbitmqContainer, err := rabbitmq.RunContainer(ctx,
    testcontainers.WithImage("rabbitmq:3.12.11-management-alpine"),
    rabbitmq.WithAdminUsername("admin"),
    rabbitmq.WithAdminPassword("password"),
)
if err != nil {
    log.Fatalf("failed to start container: %s", err)
}

// Clean up the container
defer func() {
    if err := rabbitmqContainer.Terminate(ctx); err != nil {
        log.Fatalf("failed to terminate container: %s", err)
    }
}()

Module reference¶

The RabbitMQ module exposes one entrypoint function to create the RabbitMQ container, and this function receives two parameters:

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*RabbitMQContainer, error)

context.Context, the Go context.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Container Options¶

When starting the RabbitMQ container, you can pass options in a variadic way to configure it. All these options will be automatically rendered into the RabbitMQ's custom configuration file, located at /etc/rabbitmq/rabbitmq-custom.conf.

Image¶

If you need to set a different RabbitMQ Docker image, you can use testcontainers.WithImage with a valid Docker image for RabbitMQ. E.g. testcontainers.WithImage("rabbitmq:3.7.25-management-alpine").

Warning

From https://hub.docker.com/_/rabbitmq: "As of RabbitMQ 3.9, all of the docker-specific variables listed below are deprecated and no longer used. Please use a configuration file instead; visit rabbitmq.com/configure to learn more about the configuration file. For a starting point, the 3.8 images will print out the config file it generated from supplied environment variables."

RABBITMQ_DEFAULT_PASS_FILE
RABBITMQ_DEFAULT_USER_FILE
RABBITMQ_MANAGEMENT_SSL_CACERTFILE
RABBITMQ_MANAGEMENT_SSL_CERTFILE
RABBITMQ_MANAGEMENT_SSL_DEPTH
RABBITMQ_MANAGEMENT_SSL_FAIL_IF_NO_PEER_CERT
RABBITMQ_MANAGEMENT_SSL_KEYFILE
RABBITMQ_MANAGEMENT_SSL_VERIFY
RABBITMQ_SSL_CACERTFILE
RABBITMQ_SSL_CERTFILE
RABBITMQ_SSL_DEPTH
RABBITMQ_SSL_FAIL_IF_NO_PEER_CERT
RABBITMQ_SSL_KEYFILE
RABBITMQ_SSL_VERIFY
RABBITMQ_VM_MEMORY_HIGH_WATERMARK

Image Substitutions¶

Since testcontainers-go v0.26.0

In more locked down / secured environments, it can be problematic to pull images from Docker Hub and run them without additional precautions.

An image name substitutor converts a Docker image name, as may be specified in code, to an alternative name. This is intended to provide a way to override image names, for example to enforce pulling of images from a private registry.

Testcontainers for Go exposes an interface to perform this operations: ImageSubstitutor, and a No-operation implementation to be used as reference for custom implementations:

Image Substitutor InterfaceNoop Image Substitutor

// ImageSubstitutor represents a way to substitute container image names
type ImageSubstitutor interface {
    // Description returns the name of the type and a short description of how it modifies the image.
    // Useful to be printed in logs
    Description() string
    Substitute(image string) (string, error)
}

type NoopImageSubstitutor struct{}

// Description returns a description of what is expected from this Substitutor,
// which is used in logs.
func (s NoopImageSubstitutor) Description() string {
    return "NoopImageSubstitutor (noop)"
}

// Substitute returns the original image, without any change
func (s NoopImageSubstitutor) Substitute(image string) (string, error) {
    return image, nil
}

Using the WithImageSubstitutors options, you could define your own substitutions to the container images. E.g. adding a prefix to the images so that they can be pulled from a Docker registry other than Docker Hub. This is the usual mechanism for using Docker image proxies, caches, etc.

WithLogConsumers¶

Not available until the next release of testcontainers-go main

If you need to consume the logs of the container, you can use testcontainers.WithLogConsumers with a valid log consumer. An example of a log consumer is the following:

type TestLogConsumer struct {
    Msgs []string
}

func (g *TestLogConsumer) Accept(l Log) {
    g.Msgs = append(g.Msgs, string(l.Content))
}

Please read the Following Container Logs documentation for more information about creating log consumers.

Wait Strategies¶

If you need to set a different wait strategy for the container, you can use testcontainers.WithWaitStrategy with a valid wait strategy.

Info

The default deadline for the wait strategy is 60 seconds.

At the same time, it's possible to set a wait strategy and a custom deadline with testcontainers.WithWaitStrategyAndDeadline.

Startup Commands¶

Since testcontainers-go v0.25.0

Testcontainers exposes the WithStartupCommand(e ...Executable) option to run arbitrary commands in the container right after it's started.

Info

To better understand how this feature works, please read the Create containers: Lifecycle Hooks documentation.

It also exports an Executable interface, defining the following methods:

AsCommand(), which returns a slice of strings to represent the command and positional arguments to be executed in the container;
Options(), which returns the slice of functional options with the Docker's ExecConfigs used to create the command in the container (the working directory, environment variables, user executing the command, etc) and the possible output format (Multiplexed).

You could use this feature to run a custom script, or to run a command that is not supported by the module right after the container is started.

WithNetwork¶

Since testcontainers-go v0.27.0

By default, the container is started in the default Docker network. If you want to use an already existing Docker network you created in your code, you can use the network.WithNetwork(aliases []string, nw *testcontainers.DockerNetwork) option, which receives an alias as parameter and your network, attaching the container to it, and setting the network alias for that network.

In the case you need to retrieve the network name, you can simply read it from the struct's Name field. E.g. nw.Name.

Warning

This option is not checking whether the network exists or not. If you use a network that doesn't exist, the container will start in the default Docker network, as in the default behavior.

WithNewNetwork¶

Since testcontainers-go v0.27.0

If you want to attach your containers to a throw-away network, you can use the network.WithNewNetwork(ctx context.Context, aliases []string, opts ...network.NetworkCustomizer) option, which receives an alias as parameter, creating the new network with a random name, attaching the container to it, and setting the network alias for that network.

In the case you need to retrieve the network name, you can use the Networks(ctx) method of the Container interface, right after it's running, which returns a slice of strings with the names of the networks where the container is attached.

Docker type modifiers¶

If you need an advanced configuration for the container, you can leverage the following Docker type modifiers:

testcontainers.WithConfigModifier
testcontainers.WithHostConfigModifier
testcontainers.WithEndpointSettingsModifier

Please read the Create containers: Advanced Settings documentation for more information.

Customising the ContainerRequest¶

This option will merge the customized request into the module's own ContainerRequest.

container, err := RunContainer(ctx,
    /* Other module options */
    testcontainers.CustomizeRequest(testcontainers.GenericContainerRequest{
        ContainerRequest: testcontainers.ContainerRequest{
            Cmd: []string{"-c", "log_statement=all"},
        },
    }),
)

The above example is updating the predefined command of the image, appending them to the module's command.

Info

This can't be used to replace the command, only to append options.

Startup Commands for RabbitMQ¶

The RabbitMQ module includes several test implementations of the testcontainers.Executable interface: Binding, Exchange, OperatorPolicy, Parameter, Permission, Plugin, Policy, Queue, User, VirtualHost and VirtualHostLimit. You could use them as reference to understand how the startup commands are generated, but please consider this test implementation could not be complete for your use case.

You could use this feature to run a custom script, or to run a command that is not supported by the module. RabbitMQ examples of this could be:

Enable plugins
Add virtual hosts and virtual hosts limits
Add exchanges
Add queues
Add bindings
Add policies
Add operator policies
Add parameters
Add permissions
Add users

Please refer to the RabbitMQ documentation to build your own commands.

Add Virtual HostsAdd ExchangesAdd QueuesAdd BindingsAdd PoliciesAdd PermissionsAdd UsersEnabling Plugins

testcontainers.WithStartupCommand(VirtualHost{Name: "vhost1"}),
testcontainers.WithStartupCommand(VirtualHostLimit{VHost: "vhost1", Name: "max-connections", Value: 1}),
testcontainers.WithStartupCommand(VirtualHost{Name: "vhost2", Tracing: true}),

testcontainers.WithStartupCommand(Exchange{Name: "direct-exchange", Type: "direct"}),
testcontainers.WithStartupCommand(Exchange{
    Name: "topic-exchange",
    Type: "topic",
}),
testcontainers.WithStartupCommand(Exchange{
    VHost:      "vhost1",
    Name:       "topic-exchange-2",
    Type:       "topic",
    AutoDelete: false,
    Internal:   false,
    Durable:    true,
    Args:       map[string]interface{}{},
}),
testcontainers.WithStartupCommand(Exchange{
    VHost: "vhost2",
    Name:  "topic-exchange-3",
    Type:  "topic",
}),
testcontainers.WithStartupCommand(Exchange{
    Name:       "topic-exchange-4",
    Type:       "topic",
    AutoDelete: false,
    Internal:   false,
    Durable:    true,
    Args:       map[string]interface{}{},
}),

testcontainers.WithStartupCommand(Queue{Name: "queue1"}),
testcontainers.WithStartupCommand(Queue{
    Name:       "queue2",
    AutoDelete: true,
    Durable:    false,
    Args:       map[string]interface{}{"x-message-ttl": 1000},
}),
testcontainers.WithStartupCommand(Queue{
    VHost:      "vhost1",
    Name:       "queue3",
    AutoDelete: true,
    Durable:    false,
    Args:       map[string]interface{}{"x-message-ttl": 1000},
}),
testcontainers.WithStartupCommand(Queue{VHost: "vhost2", Name: "queue4"}),

testcontainers.WithStartupCommand(NewBinding("direct-exchange", "queue1")),
testcontainers.WithStartupCommand(NewBindingWithVHost("vhost1", "topic-exchange-2", "queue3")),
testcontainers.WithStartupCommand(Binding{
    VHost:           "vhost2",
    Source:          "topic-exchange-3",
    Destination:     "queue4",
    RoutingKey:      "ss7",
    DestinationType: "queue",
    Args:            map[string]interface{}{},
}),

testcontainers.WithStartupCommand(Policy{
    Name:       "max length policy",
    Pattern:    "^dog",
    Definition: map[string]interface{}{"max-length": 1},
    Priority:   1,
    ApplyTo:    "queues",
}),
testcontainers.WithStartupCommand(Policy{
    Name:       "alternate exchange policy",
    Pattern:    "^direct-exchange",
    Definition: map[string]interface{}{"alternate-exchange": "amq.direct"},
}),
testcontainers.WithStartupCommand(Policy{
    VHost:   "vhost2",
    Name:    "ha-all",
    Pattern: ".*",
    Definition: map[string]interface{}{
        "ha-mode":      "all",
        "ha-sync-mode": "automatic",
    },
}),
testcontainers.WithStartupCommand(OperatorPolicy{
    Name:       "operator policy 1",
    Pattern:    "^queue1",
    Definition: map[string]interface{}{"message-ttl": 1000},
    Priority:   1,
    ApplyTo:    "queues",
}),

testcontainers.WithStartupCommand(NewPermission("vhost1", "user1", ".*", ".*", ".*")),

testcontainers.WithStartupCommand(User{
    Name:     "user1",
    Password: "password1",
}),
testcontainers.WithStartupCommand(User{
    Name:     "user2",
    Password: "password2",
    Tags:     []string{"administrator"},
}),

testcontainers.WithStartupCommand(Plugin{Name: "rabbitmq_shovel"}, Plugin{Name: "rabbitmq_random_exchange"}),

Default Admin¶

If you need to set the username and/or password for the admin user, you can use the WithAdminUsername(username string) and WithAdminPassword(pwd string) options.

Info

By default, the admin username is guest and the password is guest.

SSL settings¶

In the case you need to enable SSL, you can use the WithSSL(settings SSLSettings) option. This option will enable SSL with the passed settings:

Enabling SSL

ctx := context.Background()

sslSettings := rabbitmq.SSLSettings{
    CACertFile:        filepath.Join("testdata", "certs", "server_ca.pem"),
    CertFile:          filepath.Join("testdata", "certs", "server_cert.pem"),
    KeyFile:           filepath.Join("testdata", "certs", "server_key.pem"),
    VerificationMode:  rabbitmq.SSLVerificationModePeer,
    FailIfNoCert:      true,
    VerificationDepth: 1,
}

rabbitmqContainer, err := rabbitmq.RunContainer(ctx,
    testcontainers.WithImage("rabbitmq:3.7.25-management-alpine"),
    rabbitmq.WithSSL(sslSettings),
)
if err != nil {
    log.Fatalf("failed to start container: %s", err)
}

You'll find a log entry similar to this one in the container logs:

2023-09-13 13:05:10.213 [info] <0.548.0> started TLS (SSL) listener on [::]:5671

Container Methods¶

The RabbitMQ container exposes the following methods:

AMQP URLs¶

The RabbitMQ container exposes two methods to retrieve the AMQP URLs in order to connect to the RabbitMQ instance using AMQP clients:

AmqpURL(), returns the AMQP URL.
AmqpsURL(), returns the AMQPS URL.

HTTP management URLs¶

The RabbitMQ container exposes two methods to retrieve the HTTP URLs for management:

HttpURL(), returns the management URL over HTTP.
HttpsURL(), returns the management URL over HTTPS.