ActiveMQ

Since v0.44.0

Introduction

The Testcontainers module for Apache ActiveMQ Classic. This module is distinct from the Artemis module, which targets Apache ActiveMQ Artemis (the next-generation broker).

Adding this module to your project dependencies

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

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

Usage example

Creating a ActiveMQ container

ctx := context.Background()

activemqContainer, err := activemq.Run(ctx,
    "apache/activemq-classic:5.18.7",
    activemq.WithAdminCredentials("test", "test"),
)
defer func() {
    if err := testcontainers.TerminateContainer(activemqContainer); 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.44.0

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, 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(), "apache/activemq-classic:5.18").

Container Options

When starting the ActiveMQ container, you can pass options in a variadic way to configure it.

WithAdminCredentials

• Since v0.44.0

Sets the username and password for the ActiveMQ web console administrator. The credentials are propagated via the ACTIVEMQ_WEB_ADMIN_NAME and ACTIVEMQ_WEB_ADMIN_PASSWORD environment variables. The wait strategy is also updated to authenticate with the provided credentials.

The default credentials are admin/admin.

With admin credentials

activemq.WithAdminCredentials("testuser", "testpass"),

The following options are exposed by the testcontainers package.

Basic Options

• WithExposedPorts Since v0.37.0
• WithEnv Since v0.29.0
• WithWaitStrategy Since v0.20.0
• WithAdditionalWaitStrategy Since v0.38.0
• WithWaitStrategyAndDeadline Since v0.20.0
• WithAdditionalWaitStrategyAndDeadline Since v0.38.0
• WithEntrypoint Since v0.37.0
• WithEntrypointArgs Since v0.37.0
• WithCmd Since v0.37.0
• WithCmdArgs Since v0.37.0
• WithLabels Since v0.37.0

Lifecycle Options

• WithLifecycleHooks Since v0.38.0
• WithAdditionalLifecycleHooks Since v0.38.0
• WithStartupCommand Since v0.25.0
• WithAfterReadyCommand Since v0.28.0

Files & Mounts Options

• WithFiles Since v0.37.0
• WithMounts Since v0.37.0
• WithTmpfs Since v0.37.0
• WithImageMount Since v0.37.0

Build Options

• WithDockerfile Since v0.37.0

Logging Options

• WithLogConsumers Since v0.28.0
• WithLogConsumerConfig Since v0.38.0
• WithLogger Since v0.29.0

Image Options

• WithAlwaysPull Since v0.38.0
• WithImageSubstitutors Since v0.26.0
• WithImagePlatform Since v0.38.0

Networking Options

• WithNetwork Since v0.27.0
• WithNetworkByName Since v0.38.0
• WithBridgeNetwork Since v0.38.0
• WithNewNetwork Since v0.27.0

Advanced Options

• WithHostPortAccess Since v0.31.0
• WithConfigModifier Since v0.20.0 · Chainable since main
• WithHostConfigModifier Since v0.20.0 · Chainable since main
• WithEndpointSettingsModifier Since v0.20.0 · Chainable since main
• CustomizeRequest Since v0.20.0
• WithName Since v0.38.0
• WithNoStart Since v0.38.0
• WithProvider Since v0.39.0

Experimental Options

• WithReuseByName Since v0.37.0

Container Methods

The ActiveMQ container exposes the following methods:

AdminUser

• Since v0.44.0

The AdminUser() method returns the administrator username used to access the web console.

Get admin user

user := activemqContainer.AdminUser()

AdminPassword

• Since v0.44.0

The AdminPassword() method returns the administrator password used to access the web console.

Get admin password

pass := activemqContainer.AdminPassword()

BrokerURL

• Since v0.44.0

The BrokerURL(ctx) method returns the OpenWire broker URL as a string with the format tcp://<host>:<port>, using the mapped 61616/tcp port.

Get broker URL

brokerURL, err := ctr.BrokerURL(ctx)

WebConsoleURL

• Since v0.44.0

The WebConsoleURL(ctx) method returns the HTTP URL of the ActiveMQ web console as a string with the format http://<host>:<port>, using the mapped 8161/tcp port.

Get web console URL

consoleURL, err := ctr.WebConsoleURL(ctx)