Skip to content

README.md

Latest commit

 

History

History
127 lines (96 loc) · 5.06 KB

README.md

File metadata and controls

127 lines (96 loc) · 5.06 KB

AzureFunctions.TestFramework.ServiceBus

NuGet

ServiceBusTrigger invocation support for the Azure Functions Test Framework. Provides InvokeServiceBusAsync(...), InvokeServiceBusBatchAsync(...), and ConfigureFakeServiceBusMessageActions() — extensions on IFunctionsTestHost that let you trigger Service Bus-triggered functions directly from integration tests without a real Azure Service Bus namespace.

Usage

using Azure.Messaging.ServiceBus;
using AzureFunctions.TestFramework.Core;
using AzureFunctions.TestFramework.ServiceBus;

public class ServiceBusFunctionTests : IAsyncLifetime
{
    private IFunctionsTestHost _testHost;

    public async Task InitializeAsync()
    {
        _testHost = await new FunctionsTestHostBuilder()
            .WithFunctionsAssembly(typeof(MyServiceBusFunction).Assembly)
            .ConfigureFakeServiceBusMessageActions()   // required when functions accept ServiceBusMessageActions
            .BuildAndStartAsync();
    }

    // ── Single message (string / byte[] / BinaryData function parameter) ──────────────

    [Fact]
    public async Task ProcessMessage_WithStringBody_Succeeds()
    {
        var message = new ServiceBusMessage("Hello from test!");
        var result = await _testHost.InvokeServiceBusAsync("ProcessOrderMessage", message);
        Assert.True(result.Success);
    }

    // ── Single message (ServiceBusReceivedMessage function parameter) ─────────────────

    [Fact]
    public async Task ProcessMessage_WithReceivedMessage_Succeeds()
    {
        var message = ServiceBusModelFactory.ServiceBusReceivedMessage(
            body: BinaryData.FromString("Hello from test!"),
            messageId: Guid.NewGuid().ToString());

        var result = await _testHost.InvokeServiceBusAsync("ProcessOrderMessage", message);
        Assert.True(result.Success);
    }

    // ── Batch mode (IsBatched = true, ServiceBusReceivedMessage[] parameter) ──────────

    [Fact]
    public async Task ProcessBatch_WithMultipleMessages_Succeeds()
    {
        var messages = Enumerable.Range(1, 3)
            .Select(i => ServiceBusModelFactory.ServiceBusReceivedMessage(
                body: BinaryData.FromString($"order {i}"),
                messageId: Guid.NewGuid().ToString()))
            .ToList()
            .AsReadOnly();

        var result = await _testHost.InvokeServiceBusBatchAsync("ProcessOrderBatch", messages);
        Assert.True(result.Success);
    }

    // ── ServiceBusMessageActions injection ────────────────────────────────────────────

    [Fact]
    public async Task ProcessMessage_CompletesMessageViaActions()
    {
        var message = ServiceBusModelFactory.ServiceBusReceivedMessage(
            body: BinaryData.FromString("Hello!"),
            messageId: Guid.NewGuid().ToString());

        var result = await _testHost.InvokeServiceBusAsync("ProcessOrderMessage", message);
        Assert.True(result.Success);

        // Verify that the function called CompleteMessageAsync
        var actions = _testHost.Services.GetRequiredService<FakeServiceBusMessageActions>();
        Assert.Single(actions.RecordedActions);
        Assert.Equal("Complete", actions.RecordedActions[0].Action);
    }

    public async Task DisposeAsync()
    {
        await _testHost.StopAsync();
        _testHost.Dispose();
    }
}

ServiceBusMessageActions and ServiceBusSessionMessageActions

Functions that accept ServiceBusMessageActions or ServiceBusSessionMessageActions as parameters need fake implementations because the real SDK converters require a live gRPC settlement channel. Call ConfigureFakeServiceBusMessageActions() on the builder to register the fakes:

_testHost = await new FunctionsTestHostBuilder()
    .WithFunctionsAssembly(typeof(MyFunction).Assembly)
    .ConfigureFakeServiceBusMessageActions()  // registers fakes + intercepts SDK converters
    .BuildAndStartAsync();

After the invocation, resolve the fake from host.Services to assert settlement calls:

var actions = host.Services.GetRequiredService<FakeServiceBusMessageActions>();
// RecordedActions contains every Complete/Abandon/DeadLetter/Defer/RenewLock call made during the invocation
Assert.Equal("Complete", actions.RecordedActions[0].Action);

// Reset between tests if the host is shared (IClassFixture / OneTimeSetUp)
actions.Reset();

For session-enabled topics/queues:

var sessionActions = host.Services.GetRequiredService<FakeServiceBusSessionMessageActions>();
Assert.Contains(sessionActions.RecordedActions, a => a.Action == "RenewSessionLock");

References

License

MIT