如何编写Azure ServiceBus Topic消息发送的单元测试及模拟连接字符串？

核心思路：避免真实连接，用模拟类解耦 #

单元测试不需要真实的ServiceBus连接字符串，核心是通过依赖注入将ServiceBusClient从Function中解耦，测试时替换为模拟实现，验证消息发送逻辑即可。

方案1：用Moq手动模拟客户端（通用方案） #

假设你的Azure Function代码结构如下（已做依赖注入）：

public class QueueToTopicFunction
{
    private readonly ServiceBusClient _serviceBusClient;

    public QueueToTopicFunction(ServiceBusClient serviceBusClient)
    {
        _serviceBusClient = serviceBusClient;
    }

    [FunctionName("QueueToTopicFunction")]
    public async Task Run(
        [ServiceBusTrigger("input-queue", Connection = "ServiceBusConnection")] string queueMessage,
        ILogger log)
    {
        var topicSender = _serviceBusClient.CreateSender("target-topic");
        await topicSender.SendMessageAsync(new ServiceBusMessage(queueMessage));
        log.LogInformation($"Forwarded message to topic: {queueMessage}");
    }
}

对应的单元测试（xUnit + Moq）：

using Moq;
using Azure.Messaging.ServiceBus;
using Xunit;
using Microsoft.Extensions.Logging;

public class QueueToTopicFunctionTests
{
    [Fact]
    public async Task Run_ForwardsQueueMessageToTopic()
    {
        // 1. 模拟ServiceBusSender的发送行为
        var mockSender = new Mock<ServiceBusSender>();
        mockSender.Setup(s => s.SendMessageAsync(It.IsAny<ServiceBusMessage>(), It.IsAny<CancellationToken>()))
                  .Returns(Task.CompletedTask);

        // 2. 模拟ServiceBusClient，让它返回上面的模拟Sender
        var mockClient = new Mock<ServiceBusClient>();
        mockClient.Setup(c => c.CreateSender("target-topic", It.IsAny<ServiceBusSenderOptions>()))
                  .Returns(mockSender.Object);

        // 3. 模拟日志对象
        var mockLogger = new Mock<ILogger<QueueToTopicFunction>>();

        // 4. 执行Function逻辑
        var function = new QueueToTopicFunction(mockClient.Object);
        await function.Run("test-queue-message", mockLogger.Object);

        // 5. 验证消息是否按预期发送
        mockSender.Verify(
            s => s.SendMessageAsync(
                It.Is<ServiceBusMessage>(m => m.Body.ToString() == "test-queue-message"),
                It.IsAny<CancellationToken>()),
            Times.Once);
    }
}

方案2：用官方Testing包（更便捷） #

Azure提供了Azure.Messaging.ServiceBus.Testing NuGet包，内置了专门的模拟类，无需手动写Moq逻辑：

1. 先安装NuGet包：

Install-Package Azure.Messaging.ServiceBus.Testing

2. 单元测试代码：

using Azure.Messaging.ServiceBus.Testing;
using Xunit;
using Microsoft.Extensions.Logging;

public class QueueToTopicFunctionTests
{
    [Fact]
    public async Task Run_MessageIsSentToTopic()
    {
        // 创建模拟的ServiceBus客户端
        var mockClient = new ServiceBusClientMock();
        // 创建目标Topic的模拟Sender
        var mockTopicSender = mockClient.CreateSender("target-topic");

        // 模拟日志
        var mockLogger = new Mock<ILogger<QueueToTopicFunction>>();

        // 执行Function
        var function = new QueueToTopicFunction(mockClient);
        await function.Run("test-content", mockLogger.Object);

        // 验证模拟Sender收到了消息
        var sentMessages = mockTopicSender.SentMessages;
        Assert.Single(sentMessages);
        Assert.Equal("test-content", sentMessages[0].Body.ToString());
    }
}

关键说明 #

• 不要试图创建"虚拟连接字符串"，单元测试的核心是验证业务逻辑正确性，而非与真实Azure服务交互。如果需要验证与真实ServiceBus的集成，那是集成测试的范畴，此时才需要用测试环境的真实连接字符串。
• 必须保证你的Function通过依赖注入获取ServiceBusClient，而非在代码中硬编码连接字符串实例化客户端，否则无法替换为模拟实现。

内容的提问来源于stack exchange，提问作者myazure techie