RabbitMQ¶
Since 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¶
ctx := context.Background()
rabbitmqContainer, err := rabbitmq.Run(ctx,
"rabbitmq:3.12.11-management-alpine",
rabbitmq.WithAdminUsername("admin"),
rabbitmq.WithAdminPassword("password"),
)
defer func() {
if err := testcontainers.TerminateContainer(rabbitmqContainer); 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 RabbitMQ module exposes one entrypoint function to create the RabbitMQ container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*RabbitMQContainer, error)
context.Context
, the Go context.string
, the Docker image to use.testcontainers.ContainerCustomizer
, a variadic argument for passing options.
Image¶
Use the second argument in the Run
function to set a valid Docker image.
In example: Run(context.Background(), "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
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
.
Default Admin¶
- Since v0.25.0
If you need to set the username and/or password for the admin user, you can use the
WithAdminUsername(username string)
andWithAdminPassword(pwd string)
options.
Info
By default, the admin username is guest
and the password is guest
.
SSL settings¶
- Since v0.25.0
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:
ctx := context.Background()
tmpDir := os.TempDir()
certDirs := tmpDir + "/rabbitmq"
if err := os.MkdirAll(certDirs, 0o755); err != nil {
log.Printf("failed to create temporary directory: %s", err)
return
}
defer os.RemoveAll(certDirs)
// generates the CA certificate and the certificate
// exampleSelfSignedCert {
caCert := tlscert.SelfSignedFromRequest(tlscert.Request{
Name: "ca",
Host: "localhost,127.0.0.1",
IsCA: true,
ParentDir: certDirs,
})
if caCert == nil {
log.Print("failed to generate CA certificate")
return
}
// }
// exampleSignSelfSignedCert {
cert := tlscert.SelfSignedFromRequest(tlscert.Request{
Name: "client",
Host: "localhost,127.0.0.1",
IsCA: true,
Parent: caCert,
ParentDir: certDirs,
})
if cert == nil {
log.Print("failed to generate certificate")
return
}
// }
sslSettings := rabbitmq.SSLSettings{
CACertFile: caCert.CertPath,
CertFile: cert.CertPath,
KeyFile: cert.KeyPath,
VerificationMode: rabbitmq.SSLVerificationModePeer,
FailIfNoCert: true,
VerificationDepth: 1,
}
rabbitmqContainer, err := rabbitmq.Run(ctx,
"rabbitmq:3.7.25-management-alpine",
rabbitmq.WithSSL(sslSettings),
)
defer func() {
if err := testcontainers.TerminateContainer(rabbitmqContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}
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
Startup Commands¶
- Since v0.25.0
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.
testcontainers.WithAfterReadyCommand(VirtualHost{Name: "vhost1"}),
testcontainers.WithAfterReadyCommand(VirtualHostLimit{VHost: "vhost1", Name: "max-connections", Value: 1}),
testcontainers.WithAfterReadyCommand(VirtualHost{Name: "vhost2", Tracing: true}),
testcontainers.WithAfterReadyCommand(Exchange{Name: "direct-exchange", Type: "direct"}),
testcontainers.WithAfterReadyCommand(Exchange{
Name: "topic-exchange",
Type: "topic",
}),
testcontainers.WithAfterReadyCommand(Exchange{
VHost: "vhost1",
Name: "topic-exchange-2",
Type: "topic",
AutoDelete: false,
Internal: false,
Durable: true,
Args: map[string]any{},
}),
testcontainers.WithAfterReadyCommand(Exchange{
VHost: "vhost2",
Name: "topic-exchange-3",
Type: "topic",
}),
testcontainers.WithAfterReadyCommand(Exchange{
Name: "topic-exchange-4",
Type: "topic",
AutoDelete: false,
Internal: false,
Durable: true,
Args: map[string]any{},
}),
testcontainers.WithAfterReadyCommand(Queue{Name: "queue1"}),
testcontainers.WithAfterReadyCommand(Queue{
Name: "queue2",
AutoDelete: true,
Durable: false,
Args: map[string]any{"x-message-ttl": 1000},
}),
testcontainers.WithAfterReadyCommand(Queue{
VHost: "vhost1",
Name: "queue3",
AutoDelete: true,
Durable: false,
Args: map[string]any{"x-message-ttl": 1000},
}),
testcontainers.WithAfterReadyCommand(Queue{VHost: "vhost2", Name: "queue4"}),
testcontainers.WithAfterReadyCommand(NewBinding("direct-exchange", "queue1")),
testcontainers.WithAfterReadyCommand(NewBindingWithVHost("vhost1", "topic-exchange-2", "queue3")),
testcontainers.WithAfterReadyCommand(Binding{
VHost: "vhost2",
Source: "topic-exchange-3",
Destination: "queue4",
RoutingKey: "ss7",
DestinationType: "queue",
Args: map[string]any{},
}),
testcontainers.WithAfterReadyCommand(Policy{
Name: "max length policy",
Pattern: "^dog",
Definition: map[string]any{"max-length": 1},
Priority: 1,
ApplyTo: "queues",
}),
testcontainers.WithAfterReadyCommand(Policy{
Name: "alternate exchange policy",
Pattern: "^direct-exchange",
Definition: map[string]any{"alternate-exchange": "amq.direct"},
}),
testcontainers.WithAfterReadyCommand(Policy{
VHost: "vhost2",
Name: "ha-all",
Pattern: ".*",
Definition: map[string]any{
"ha-mode": "all",
"ha-sync-mode": "automatic",
},
}),
testcontainers.WithAfterReadyCommand(OperatorPolicy{
Name: "operator policy 1",
Pattern: "^queue1",
Definition: map[string]any{"message-ttl": 1000},
Priority: 1,
ApplyTo: "queues",
}),
testcontainers.WithAfterReadyCommand(NewPermission("vhost1", "user1", ".*", ".*", ".*")),
testcontainers.WithAfterReadyCommand(User{
Name: "user1",
Password: "password1",
}),
testcontainers.WithAfterReadyCommand(User{
Name: "user2",
Password: "password2",
Tags: []string{"administrator"},
}),
testcontainers.WithAfterReadyCommand(Plugin{Name: "rabbitmq_shovel"}, Plugin{Name: "rabbitmq_random_exchange"}),
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¶
The RabbitMQ container exposes the following methods:
AMQP URLs¶
- Since v0.25.0
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¶
- Since v0.25.0
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.