Skip to content

Apache ActiveMQ Artemis

Apache ActiveMQ Artemis is an open source project to build a multi-protocol, embeddable, very high performance, clustered, asynchronous messaging system.

Add the following dependency to your project file:

NuGet
1
dotnet add package Testcontainers.ActiveMq

You can start an Apache ActiveMQ Artemis container instance from any .NET application. This example uses xUnit.net's IAsyncLifetime interface to manage the lifecycle of the container. The container is started in the InitializeAsync method before the test method runs, ensuring that the environment is ready for testing. After the test completes, the container is removed in the DisposeAsync method.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
public abstract class ArtemisContainerTest : IAsyncLifetime
{
    private readonly ArtemisContainer _artemisContainer;

    private readonly string _username;

    private readonly string _password;

    private ArtemisContainerTest(ArtemisContainer artemisContainer, string username, string password)
    {
        _artemisContainer = artemisContainer;
        _username = username;
        _password = password;
    }

    public Task InitializeAsync()
    {
        return _artemisContainer.StartAsync();
    }

    public Task DisposeAsync()
    {
        return _artemisContainer.DisposeAsync().AsTask();
    }
}

1
2
3
4
5
6
7
8
[UsedImplicitly]
public sealed class NoAuthCredentialsConfiguration : ArtemisContainerTest
{
    public NoAuthCredentialsConfiguration()
        : base(new ArtemisBuilder().WithEnvironment("ANONYMOUS_LOGIN", bool.TrueString).Build(), string.Empty, string.Empty)
    {
    }
}

1
2
3
4
5
6
7
8
[UsedImplicitly]
public sealed class DefaultCredentialsConfiguration : ArtemisContainerTest
{
    public DefaultCredentialsConfiguration()
        : base(new ArtemisBuilder().Build(), ArtemisBuilder.DefaultUsername, ArtemisBuilder.DefaultPassword)
    {
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
[UsedImplicitly]
public sealed class CustomCredentialsConfiguration : ArtemisContainerTest
{
    private static readonly string Username = Guid.NewGuid().ToString("D");

    private static readonly string Password = Guid.NewGuid().ToString("D");

    public CustomCredentialsConfiguration()
        : base(new ArtemisBuilder().WithUsername(Username).WithPassword(Password).Build(), Username, Password)
    {
    }
}

Connect to the container and produce a message:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
[Fact]
[Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
public async Task EstablishesConnection()
{
    // Given
    var connectionFactory = new ConnectionFactory(_artemisContainer.GetBrokerAddress());
    connectionFactory.UserName = _username;
    connectionFactory.Password = _password;

    // When
    using var connection = await connectionFactory.CreateConnectionAsync()
        .ConfigureAwait(true);

    await connection.StartAsync()
        .ConfigureAwait(true);

    Assert.True(connection.IsStarted);

    // Then
    using var session = await connection.CreateSessionAsync()
        .ConfigureAwait(true);

    using var queue = await session.CreateTemporaryQueueAsync()
        .ConfigureAwait(true);

    using var producer = await session.CreateProducerAsync(queue)
        .ConfigureAwait(true);

    using var consumer = await session.CreateConsumerAsync(queue)
        .ConfigureAwait(true);

    var producedMessage = await producer.CreateTextMessageAsync(Guid.NewGuid().ToString("D"))
        .ConfigureAwait(true);

    await producer.SendAsync(producedMessage)
        .ConfigureAwait(true);

    var receivedMessage = await consumer.ReceiveAsync()
        .ConfigureAwait(true);

    Assert.Equal(producedMessage.Text, receivedMessage.Body<string>());
}

The test example uses the following NuGet dependencies:

1
2
3
4
5
<PackageReference Include="Microsoft.NET.Test.Sdk"/>
<PackageReference Include="coverlet.collector"/>
<PackageReference Include="xunit.runner.visualstudio"/>
<PackageReference Include="xunit"/>
<PackageReference Include="Apache.NMS.ActiveMQ"/>

To execute the tests, use the command dotnet test from a terminal.

Tip

For the complete source code of this example and additional information, please refer to our test projects.