Skip to content

Apache ActiveMQ Artemis

Since v0.23.0

Introduction

The Testcontainers module for Artemis.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

artemisContainer, err := artemis.Run(ctx,
    "apache/activemq-artemis:2.30.0",
    artemis.WithCredentials("test", "test"),
)
defer func() {
    if err := testcontainers.TerminateContainer(artemisContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

// Get broker endpoint.
host, err := artemisContainer.BrokerEndpoint(ctx)
if err != nil {
    log.Printf("failed to get broker endpoint: %s", err)
    return
}

// containerUser {
user := artemisContainer.User()
// }
// containerPassword {
pass := artemisContainer.Password()
// }

// Connect to Artemis via STOMP.
conn, err := stomp.Dial("tcp", host, stomp.ConnOpt.Login(user, pass))
if err != nil {
    log.Printf("failed to connect to Artemis: %s", err)
    return
}
defer func() {
    if err := conn.Disconnect(); err != nil {
        log.Printf("failed to disconnect from Artemis: %s", err)
    }
}()

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 Artemis module exposes one entrypoint function to create the Artemis 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-artemis:2.30.0").

Container Options

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

WithCredentials

If you need to change the default admin credentials (i.e. artemis:artemis) use WithCredentials.

artemis.WithCredentials("test", "test"),

WithAnonymousLogin

If you need to enable anonymous logins (which are disabled by default) use WithAnonymousLogin.

artemis.WithAnonymousLogin(),

WithExtraArgs

If you need to pass custom arguments to the artemis create command, use WithExtraArgs. The default is --http-host 0.0.0.0 --relax-jolokia. Setting this value will override the default.

Info

Please see the documentation on artemis create for the available options here: https://activemq.apache.org/components/artemis/documentation/latest/using-server.html#options

artemis.WithExtraArgs("--http-host 0.0.0.0 --relax-jolokia --queues ArgsTestQueue"),

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

The Artemis container exposes the following methods:

User

User returns the administrator username.

user := artemisContainer.User()

Password

Password returns the administrator password.

pass := artemisContainer.Password()

BrokerEndpoint

BrokerEndpoint returns the host:port for the combined protocols endpoint.

host, err := ctr.BrokerEndpoint(ctx)

ConsoleURL

ConsoleURL returns the URL for the management console.

u, err := ctr.ConsoleURL(ctx)