Azure Service Bus触发器单元测试：如何Mock密封类BrokeredMessage？

这个问题我之前做Azure函数单元测试时也踩过坑，密封的BrokeredMessage确实没法直接用Moq这类框架Mock，不过有两个实用的解决方案，你可以根据自己的业务复杂度来选：

方案一：抽象依赖解耦（推荐用于复杂业务逻辑） #

核心思路是把函数对BrokeredMessage的依赖抽象成接口，通过包装类隔离对密封类的直接依赖，这样就能轻松Mock接口了。

• 第一步：定义抽象接口
  把你业务中需要用到的BrokeredMessage的方法/属性，都抽象到一个接口里。比如你需要读取消息体、获取自定义属性，就定义：

public interface IServiceBusMessage
{
    T GetBody<T>();
    string GetCustomProperty(string key);
    // 按需添加其他你需要的操作，比如获取MessageId、SessionId等
}

• 第二步：实现包装类
  创建一个包装类，内部持有真实的BrokeredMessage实例，把接口方法映射到BrokeredMessage的实际操作：

public class BrokeredMessageWrapper : IServiceBusMessage
{
    private readonly BrokeredMessage _innerMessage;

    public BrokeredMessageWrapper(BrokeredMessage message)
    {
        _innerMessage = message ?? throw new ArgumentNullException(nameof(message));
    }

    public T GetBody<T>()
    {
        return _innerMessage.GetBody<T>();
    }

    public string GetCustomProperty(string key)
    {
        return _innerMessage.Properties.TryGetValue(key, out var value) 
            ? value.ToString() 
            : null;
    }
}

• 第三步：重构原函数
  把原来直接操作BrokeredMessage的业务逻辑抽成单独的方法，让这个方法依赖我们定义的IServiceBusMessage接口。触发器函数只负责接收BrokeredMessage并转换成包装类实例：

public static void Run(
    [ServiceBusTrigger("saas01.queue.dbmigration", AccessRights.Manage, Connection = "connection")]
    BrokeredMessage message)
{
    var wrappedMessage = new BrokeredMessageWrapper(message);
    // 调用抽离后的业务逻辑方法
    ProcessMigrationMessage(wrappedMessage);
}

// 这个方法现在可以轻松做单元测试了
private static void ProcessMigrationMessage(IServiceBusMessage message)
{
    // 原来的业务逻辑：读取消息体、处理属性等
    var migrationPayload = message.GetBody<DbMigrationPayload>();
    var tenantId = message.GetCustomProperty("TenantId");
    // ... 你的迁移逻辑
}

• 第四步：编写单元测试
  现在就可以用Moq等框架MockIServiceBusMessage，模拟各种场景：

[TestClass]
public class MigrationFunctionTests
{
    [TestMethod]
    public void ProcessMigrationMessage_ValidPayload_ExecutesMigration()
    {
        // Arrange
        var mockMessage = new Mock<IServiceBusMessage>();
        var testPayload = new DbMigrationPayload { DbName = "TestDb", MigrationScript = "ALTER TABLE..." };
        mockMessage.Setup(m => m.GetBody<DbMigrationPayload>()).Returns(testPayload);
        mockMessage.Setup(m => m.GetCustomProperty("TenantId")).Returns("tenant-123");

        // Act
        MigrationFunction.ProcessMigrationMessage(mockMessage.Object);

        // Assert
        // 验证你的迁移逻辑是否正确执行，比如检查数据库操作是否被调用等
    }
}

方案二：直接构造真实的BrokeredMessage实例（适合简单场景） #

如果你的业务逻辑比较简单，不需要Mock复杂的行为，可以直接用BrokeredMessage的构造函数创建真实实例来测试：

[TestMethod]
public void Run_ValidMessage_ProcessesMigration()
{
    // Arrange
    var testPayload = new DbMigrationPayload { DbName = "TestDb", MigrationScript = "ALTER TABLE..." };
    using var stream = new MemoryStream();
    var serializer = new DataContractSerializer(typeof(DbMigrationPayload));
    serializer.WriteObject(stream, testPayload);
    stream.Position = 0;

    var testMessage = new BrokeredMessage(stream);
    testMessage.Properties.Add("TenantId", "tenant-123");

    // Act
    MigrationFunction.Run(testMessage);

    // Assert
    // 验证处理结果是否符合预期
}

注意：BrokeredMessage实现了IDisposable，记得用using包裹或者手动释放资源，避免内存泄漏。

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