ActiveMQ¶
Not available until the next release main
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¶
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¶
- Not available until the next release main
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¶
- Not available until the next release main
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.
activemq.WithAdminCredentials("testuser", "testpass"),
The following options are exposed by the testcontainers package.
Basic Options¶
WithExposedPortsSince v0.37.0WithEnvSince v0.29.0WithWaitStrategySince v0.20.0WithAdditionalWaitStrategySince v0.38.0WithWaitStrategyAndDeadlineSince v0.20.0WithAdditionalWaitStrategyAndDeadlineSince v0.38.0WithEntrypointSince v0.37.0WithEntrypointArgsSince v0.37.0WithCmdSince v0.37.0WithCmdArgsSince v0.37.0WithLabelsSince v0.37.0
Lifecycle Options¶
WithLifecycleHooksSince v0.38.0WithAdditionalLifecycleHooksSince v0.38.0WithStartupCommandSince v0.25.0WithAfterReadyCommandSince v0.28.0
Files & Mounts Options¶
WithFilesSince v0.37.0WithMountsSince v0.37.0WithTmpfsSince v0.37.0WithImageMountSince v0.37.0
Build Options¶
WithDockerfileSince v0.37.0
Logging Options¶
WithLogConsumersSince v0.28.0WithLogConsumerConfigSince v0.38.0WithLoggerSince v0.29.0
Image Options¶
WithAlwaysPullSince v0.38.0WithImageSubstitutorsSince v0.26.0WithImagePlatformSince v0.38.0
Networking Options¶
WithNetworkSince v0.27.0WithNetworkByNameSince v0.38.0WithBridgeNetworkSince v0.38.0WithNewNetworkSince v0.27.0
Advanced Options¶
WithHostPortAccessSince v0.31.0WithConfigModifierSince v0.20.0 · Chainable since mainWithHostConfigModifierSince v0.20.0 · Chainable since mainWithEndpointSettingsModifierSince v0.20.0 · Chainable since mainCustomizeRequestSince v0.20.0WithNameSince v0.38.0WithNoStartSince v0.38.0WithProviderSince v0.39.0
Experimental Options¶
WithReuseByNameSince v0.37.0
Container Methods¶
The ActiveMQ container exposes the following methods:
AdminUser¶
- Not available until the next release main
The AdminUser() method returns the administrator username used to access the web console.
user := activemqContainer.AdminUser()
AdminPassword¶
- Not available until the next release main
The AdminPassword() method returns the administrator password used to access the web console.
pass := activemqContainer.AdminPassword()
BrokerURL¶
- Not available until the next release main
The BrokerURL(ctx) method returns the OpenWire broker URL as a string with the
format tcp://<host>:<port>, using the mapped 61616/tcp port.
brokerURL, err := ctr.BrokerURL(ctx)
WebConsoleURL¶
- Not available until the next release main
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.
consoleURL, err := ctr.WebConsoleURL(ctx)