AzureFunctions.TestFramework.Queue

QueueTrigger invocation support for the Azure Functions Test Framework. Provides InvokeQueueAsync(...) — an extension on IFunctionsTestHost that lets you trigger queue-triggered functions directly from integration tests without a real Azure Storage queue.

Usage

Functions with `string` parameter

Use the string overload when the function parameter is string, byte[], or BinaryData:

using AzureFunctions.TestFramework.Core;
using AzureFunctions.TestFramework.Queue;

[Fact]
public async Task ProcessQueueMessage_WithTextMessage_Succeeds()
{
    var result = await _testHost.InvokeQueueAsync("ProcessQueueMessage", "Hello from queue!");
    Assert.True(result.Success);
}

Functions with `QueueMessage` parameter

Use the QueueMessage overload when the function parameter is typed as QueueMessage:

using Azure.Storage.Queues.Models;
using AzureFunctions.TestFramework.Core;
using AzureFunctions.TestFramework.Queue;

[Fact]
public async Task ProcessQueueMessage_WithQueueMessage_Succeeds()
{
    var message = QueuesModelFactory.QueueMessage(
        messageId: Guid.NewGuid().ToString(),
        popReceipt: "pop-receipt",
        messageText: "Hello from queue!",
        dequeueCount: 1);

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

API

// For functions with string/byte[]/BinaryData parameters
Task<FunctionInvocationResult> InvokeQueueAsync(
    this IFunctionsTestHost host,
    string functionName,
    string message,
    CancellationToken cancellationToken = default)

// For functions with QueueMessage parameters
Task<FunctionInvocationResult> InvokeQueueAsync(
    this IFunctionsTestHost host,
    string functionName,
    QueueMessage message,
    CancellationToken cancellationToken = default)

functionName — the name of the queue function (case-insensitive).
message (string) — the message text to pass to the function.
message (QueueMessage) — the QueueMessage to pass to the function. Use QueuesModelFactory.QueueMessage(...) from Azure.Storage.Queues.Models to create test messages.

Output binding capture

Use FunctionInvocationResult to inspect output bindings produced by the function:

var result = await _testHost.InvokeQueueAsync("ProcessOrder", "order-123");
Assert.True(result.Success);

// Read a named output binding (e.g. [QueueOutput("results")])
var outputMessage = result.ReadOutputAs<string>("OutputMessage");
Assert.Equal("processed: order-123", outputMessage);

// Read the function return value
var returnValue = result.ReadReturnValueAs<string>();

References

License

MIT

FilesExpand file tree

README.md

Latest commit

History