c# - 使用命令式绑定(bind)时进行 Azure Functions 测试

Question

到目前为止，我已经能够为 Azure Functions 设置单元测试并且效果很好。但是对于我当前的项目，我需要使用动态或命令式绑定(bind)。 https://learn.microsoft.com/en-us/azure/azure-functions/functions-reference-csharp#imperative-bindings

这导致了我似乎无法解决的单元测试问题。

我的函数如下所示:

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.ServiceBus.Messaging;
using Newtonsoft.Json;
using System;
using System.IO;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

namespace My.Functions
{
    public static class MyFunc
    {
        [FunctionName("my-func")]
        public static async Task<HttpResponseMessage> Run([HttpTrigger(AuthorizationLevel.Function, "post", Route = null)] HttpRequestMessage req,
            Binder binder)
        {
            dynamic data = await req.Content.ReadAsAsync<object>();
            byte[] bytes = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(data));
            MemoryStream stream = new MemoryStream(bytes, writable: false);

            var sbMsg = new BrokeredMessage(stream) { ContentType = "application/json" };
            var attributes = new Attribute[]
            {
                new ServiceBusAccountAttribute("some-sb-account"),
                new ServiceBusAttribute("some-queue-or-topic", AccessRights.Send)
            };
            var outputSbMessage = await binder.BindAsync<IAsyncCollector<BrokeredMessage>>(attributes);
            await outputSbMessage.AddAsync(sbMsg);

            return req.CreateResponse(HttpStatusCode.OK, "OK");
        }
    }
}

在接近函数代码末尾时，我将此 Binder 配置为保存 BrokeredMessages 列表。这是通过调用 Binder 上的 BindAsync 来完成的。

属性是动态设置的，包含服务总线连接和主题名称。当部署到 Azure 时，这一切都很好，因此在功能方面一切都很好。到目前为止一切顺利。

但是我正在努力让我的测试运行。为了能够调用函数，我需要提供参数。 HttpTrigger 这很常见，但是对于 Binder 我不知道要提供什么。

我使用这种方法进行测试:

[TestMethod]
public void SendHttpReq()
{
    // Setup
    var httpRequest = GetHttpRequestFromTestFile("HttpRequest");
    var sbOutput = new CustomBinder();

    // Act
    var response = SendToServicebus.Run(httpRequest, sbOutput);

    // Assert
    Assert.AreEqual(sbOutput.Count(), 1);

    // Clean up
}

我使用从 Binder 继承的 CustomBinder，因为在“BindAsync”上的函数中只有一个 Binder 实例失败，抛出“对象引用未设置为对象的实例”。看起来 binder 的构造函数实际上并不是要调用的。

在 CustomBinder 中，我覆盖了 BindAsync 以返回 BrokeredMessages 的通用列表。

public class CustomBinder : Binder
{
 public override async Task<TValue> BindAsync<TValue>(Attribute[] attributes, CancellationToken cancellationToken = new CancellationToken())
 {
  return (TValue)((object)(new List<BrokeredMessage>()));
  }
}

throw 也失败并不奇怪:

InvalidCastException: Unable to cast object of type 'System.Collections.Generic.List'1[Microsoft.ServiceBus.Messaging.BrokeredMessage]' to type 'Microsoft.Azure.WebJobs.IAsyncCollector`1[Microsoft.ServiceBus.Messaging.BrokeredMessage]'.

我找不到 IAsyncCollector 的实现，所以也许我需要以不同的方式处理这个问题？

我的实际目标是能够验证代理消息列表，因为该函数将输出到 Azure 服务总线。

Answer 1

如评论中所述，我同意 mock 它是有道理的。您明确希望对自己的代码逻辑进行单元测试。仅考虑您自己的业务逻辑，您可能会假设实际的实际远程操作 binder.BindAsync(...) - 您无法控制 - 按预期工作。

在单元测试中模拟它应该像这样工作:

using FluentAssertions;
using Microsoft.Azure.WebJobs;
using Microsoft.ServiceBus.Messaging;
using Xunit;

[Fact]
public async Task AzureBindAsyncShouldRetrunBrokeredMessage()
{
    // arrange           
    var attribute = new ServiceBusAccountAttribute("foo");
    var mockedResult = new BrokeredMessage()
    {
        Label = "whatever"
    };

    var mock = new Mock<IBinder>();
    mock.Setup(x => x.BindAsync<BrokeredMessage>(attribute, CancellationToken.None))
        .ReturnsAsync(mockedResult);

    // act
    var target = await mock.Object.BindAsync<BrokeredMessage>(attribute);

    // assert
    target.Should().NotBeNull();
    target.Label.Should().Be("whatever");
}

我知道您关心的可能是完整的集成测试。您似乎想要测试整个链条。在那种情况下，进行单元测试可能会很困难，因为您依赖于外部系统。如果是这种情况，您可能希望通过设置一个单独的实例在其之上创建一个单独的集成测试。

考虑到您的函数设置为 HttpTrigger，以下应该有效:

# using azure functions cli (2.x), browse to the output file
cd MyAzureFunction/bin/Debug/netstandard2.0

# run a new host/instance if your function
func host start 

接下来，只需对托管端点执行 http 请求:

$ [POST] http://localhost:7071/api/HttpTriggerCSharp?name=my-func

在这种情况下，您有一个干净且独立的集成设置。

无论哪种方式，我都想争论要么通过模拟进行单元测试，要么为它设置一个单独的集成测试设置。

希望这有助于...