Awesome

<img src="/src/icon.png" height="30px"> Verify.Wolverine

Adds Verify support for verifying Wolverine via a custom test context.

See Milestones for release notes.

Uses the same pattern as the Wolverine TestMessageContext with some additions:

• All messaging parameters, eg DeliveryOptions and timeout, can be asserted.
• Support for IMessageBus.InvokeAsync<T> via AddInvokeResult.

NuGet package

https://nuget.org/packages/Verify.Wolverine/

Usage

<a id='snippet-Enable'></a>

[ModuleInitializer]
public static void Init() =>
    VerifyWolverine.Initialize();

^{<a href='/src/Tests/ModuleInitializer.cs#L3-L9' title='Snippet source file'>snippet source</a> | <a href='#snippet-Enable' title='Start of snippet'>anchor</a>}

Handler

Given the handler:

<a id='snippet-Handler'></a>

public class Handler(IMessageBus context)
{
    public ValueTask Handle(Message message) =>
        context.SendAsync(new Response("Property Value"));
}

^{<a href='/src/Tests/Tests.cs#L30-L38' title='Snippet source file'>snippet source</a> | <a href='#snippet-Handler' title='Start of snippet'>anchor</a>}

Test

Pass in instance of RecordingMessageContext in to the Handle method and then Verify that instance.

<a id='snippet-HandlerTest'></a>

[Fact]
public async Task HandlerTest()
{
    var context = new RecordingMessageContext();
    var handler = new Handler(context);
    await handler.Handle(new Message("value"));
    await Verify(context);
}

^{<a href='/src/Tests/Tests.cs#L7-L18' title='Snippet source file'>snippet source</a> | <a href='#snippet-HandlerTest' title='Start of snippet'>anchor</a>}

Will result in:

<a id='snippet-Tests.HandlerTest.verified.txt'></a>

{
  Sent: [
    {
      Message: {
        Property: Property Value
      }
    }
  ]
}

^{<a href='/src/Tests/Tests.HandlerTest.verified.txt#L1-L9' title='Snippet source file'>snippet source</a> | <a href='#snippet-Tests.HandlerTest.verified.txt' title='Start of snippet'>anchor</a>}

AddInvokeResult

When using Request/Reply via IMessageBus.InvokeAsync<T> the message context is required to supply the "Reply" part. This can be one using RecordingMessageContext.AddInvokeResult<T>.

For example, given the handler:

<a id='snippet-InvokeAsyncHandler'></a>

public class Handler(IMessageBus context)
{
    public async Task Handle(Message message)
    {
        var request = new Request(message.Property);
        var response = await context.InvokeAsync<Response>(request);
        Trace.WriteLine(response.Property);
    }
}

^{<a href='/src/Tests/InvokeDelegateUsage.cs#L26-L38' title='Snippet source file'>snippet source</a> | <a href='#snippet-InvokeAsyncHandler' title='Start of snippet'>anchor</a>}

The result can be set:

<a id='snippet-InvokeDelegateTest'></a>

[Fact]
public async Task HandlerTest()
{
    var context = new RecordingMessageContext();
    context.AddInvokeResult<Response>(
        message =>
        {
            var request = (Request) message;
            return new Response(request.Property);
        });
    var handler = new Handler(context);
    await handler.Handle(new Message("value"));
    await Verify(context);
}

^{<a href='/src/Tests/InvokeDelegateUsage.cs#L7-L24' title='Snippet source file'>snippet source</a> | <a href='#snippet-InvokeDelegateTest' title='Start of snippet'>anchor</a>}

Icon

Wolverine designed by Phạm Thanh Lộc from The Noun Project.