MassTransit

# Testing

MassTransit is a framework, and follows the Hollywood principle – don't call us, we'll call you. This inversion of control, combined with asynchronous execution, can complicate unit tests. To make it easy, MassTransit includes test harnesses to create unit tests that run entirely in-memory but behave close to an actual message broker. In fact, the included memory-based messaging fabric was inspired by RabbitMQ exchanges and queues.

# Test Setup

To create a unit test with the in-memory test harness, create and start the harness as shown.

Uses MassTransit (opens new window), NUnit (opens new window)

To create the harness in a unit test, start, and then stop it:

namespace UsingInMemoryTestHarness
{
    using System.Threading.Tasks;
    using MassTransit;
    using MassTransit.Testing;
    using NUnit.Framework;

    [TestFixture]
    public class Using_the_test_harness
    {
        [Test]
        public async Task Should_be_easy()
        {
            var harness = new InMemoryTestHarness();

            await harness.Start();
            try
            {

            }
            finally
            {
                await harness.Stop();
            }
        }
    }
}

The test harness encapsulates the bus configuration, providing various hooks to customize the bus and receive endpoint configuration. The in-memory harness is the easiest to use, is lightning fast, and runs entirely in-memory without any external dependencies. Each setup and teardown of the harness provides a completed, end-to-end test environment. Messages sent, published, and consumed go through an entire lifecycle, including serialization, dispatch, deserialization, consumer instantiation, and asynchronous execution.

Each supported transport has its own test harness, built from a common base.

# Consumer

To test a consumer, use the consumer test harness (available with any transport).

namespace UsingInMemoryTestHarnessConsumer
{
    using System;
    using System.Threading.Tasks;
    using MassTransit;
    using MassTransit.Testing;
    using NUnit.Framework;

    [TestFixture]
    public class Submitting_an_order
    {
        [Test]
        public async Task Should_publish_the_order_submitted_event()
        {
            var harness = new InMemoryTestHarness();
            var consumerHarness = harness.Consumer<SubmitOrderConsumer>();

            await harness.Start();
            try
            {
                await harness.InputQueueSendEndpoint.Send<SubmitOrder>(new 
                {
                    OrderId = InVar.Id 
                });

                // did the endpoint consume the message
                Assert.That(await harness.Consumed.Any<SubmitOrder>());

                // did the actual consumer consume the message
                Assert.That(await consumerHarness.Consumed.Any<SubmitOrder>());

                // the consumer publish the event
                Assert.That(await harness.Published.Any<OrderSubmitted>());

                // ensure that no faults were published by the consumer
                Assert.That(await harness.Published.Any<Fault<SubmitOrder>>(), Is.False);
            }
            finally
            {
                await harness.Stop();
            }
        }
    }

    public interface SubmitOrder
    {
        Guid OrderId { get; }
    }

    public interface OrderSubmitted
    {
        Guid OrderId { get; }
    }

    class SubmitOrderConsumer :
        IConsumer<SubmitOrder>
    {
        public async Task Consume(ConsumeContext<SubmitOrder> context)
        {
            await context.Publish<OrderSubmitted>(new
            {
                context.Message.OrderId
            });
        }
    }

}

The harness configures the consumer on its receive endpoint. The test sends the SubmitOrder event, and assertions are added using harness's observer collections.

# Saga

A standard class-based saga can be testing using the saga test harness.

public async Task Should_test_the_saga()
{
    var harness = new InMemoryTestHarness();
    var sagaHarness = harness.Saga<MySaga>();

    await harness.Start();
    try
    {
        Guid sagaId = NewId.NextGuid();

        await harness.Publish(new InitiatingMessage(sagaId));

        // did the endpoint consume the message
        Assert.IsTrue(harness.Consumed.Select<InitiatingMessage>().Any());

        // did the actual consumer consume the message
        Assert.IsTrue(sagaHarness.Consumed.Select<InitiatingMessage>().Any());

        Assert.IsTrue(saga.Created.Select(x => x.CorrelationId == sagaId).Any());
    }
    finally
    {
        await harness.Stop();
    }
}

# State Machine Saga

public async Task Should_test_the_state_machine_saga()
{
    var machine = new MyStateMachine();

    var harness = new InMemoryTestHarness();
    var sagaHarness = harness.StateMachineSaga<MyInstance, MyStateMachine>(machine);

    await harness.Start();
    try
    {
        Guid sagaId = NewId.NextGuid();

        await harness.Bus.Publish(new InitialEvent(sagaId));

        // did the endpoint consume the message
        Assert.IsTrue(harness.Consumed.Select<InitialEvent>().Any());

        // did the actual consumer consume the message
        Assert.IsTrue(sagaHarness.Consumed.Select<InitialEvent>().Any());

        MyInstance instance = sagaHarness.Created.ContainsInState(sagaId, machine, machine.Active);
        Assert.IsNotNull(instance, "Saga instance not found");
    }
    finally
    {
        await harness.Stop();
    }
}

# Testing using Dependency Injection

In cases where components being tested have dependency requirements, such a saga state machine activities, or sophisticated consumer dependencies, an in-memory test harness using Microsoft Dependency Injection is available.

# Consumer

To test a consumer using container-based configuration:

var provider = new ServiceCollection()
    .AddMassTransitInMemoryTestHarness(cfg =>
    {
        cfg.AddConsumer<PingRequestConsumer>();
        cfg.AddConsumerTestHarness<PingRequestConsumer>();
    })
    .BuildServiceProvider(true);

var harness = provider.GetRequiredService<InMemoryTestHarness>();

await harness.Start();
try
{
    var bus = provider.GetRequiredService<IBus>();

    IRequestClient<PingMessage> client = bus.CreateRequestClient<PingMessage>();

    await client.GetResponse<PongMessage>(new PingMessage());

    Assert.That(await harness.Consumed.Any<PingMessage>());

    var consumerHarness = provider.GetRequiredService<IConsumerTestHarness<PingRequestConsumer>>();

    Assert.That(await consumerHarness.Consumed.Any<PingMessage>());
}
finally
{
    await harness.Stop();

    await provider.DisposeAsync();
}

# State Machine Saga

To test a saga state machine using container-based configuration:

 var provider = new ServiceCollection()
    .AddMassTransitInMemoryTestHarness(cfg =>
    {
        cfg.AddSagaStateMachine<TStateMachine, TInstance>()
            .InMemoryRepository();
        cfg.AddSagaStateMachineTestHarness<TStateMachine, TInstance>();
    })
    .BuildServiceProvider(true);

var harness = provider.GetRequiredService<InMemoryTestHarness>();

await harness.Start();
try
{
    _sagaId = NewId.NextGuid();
    _testValueA = "TestValueA";

    await harness.Bus.Publish(new A
    {
        CorrelationId = _sagaId,
        Value = _testValueA
    });

    Assert.That(await harness.Published.Any<A>());

    Assert.That(await harness.Consumed.Any<A>());

    var sagaHarness = provider.GetRequiredService<IStateMachineSagaTestHarness<TInstance, TStateMachine>>();

    Assert.That(await sagaHarness.Consumed.Any<A>());

    Assert.That(await sagaHarness.Created.Any(x => x.CorrelationId == _sagaId));

    var saga = sagaHarness.Created.Contains(_sagaId);
    Assert.That(saga, Is.Not.Null);
    Assert.That(saga.ValueA, Is.EqualTo(_testValueA));

    Assert.That(await harness.Published.Any<Aa>());

    Assert.That(await harness.Published.Any<B>(), Is.False);
}
finally
{
    await harness.Stop();

    await provider.DisposeAsync();
}

← Logging →