如何为非静态Microsoft.Azure.Functions.Worker HttpTrigger编写Xunit测试

问题说明 #

你有一个依赖注入IBasicService的非静态Azure Functions Worker HttpTrigger方法，编写Xunit测试时遇到以下两个错误：

错误1：扩展方法无法Mock #

尝试1执行时报错：

System.NotSupportedException : Unsupported expression: r => r.CreateResponse(HttpStatusCode.OK) Extension methods (here: HttpRequestDataExtensions.CreateResponse) may not be used in setup / verification expressions.

原因是CreateResponse属于静态扩展方法，Moq无法对静态扩展方法进行Setup或验证操作。

错误2：无法实例化HttpRequestData代理 #

尝试2执行时报错：

System.ArgumentException : Can not instantiate proxy of class: Microsoft.Azure.Functions.Worker.Http.HttpRequestData. Could not find a parameterless constructor. (Parameter 'constructorArguments') ---- System.MissingMethodException : Constructor on type 'Castle.Proxies.HttpRequestDataProxy' not found.

原因是HttpRequestData是抽象类且无无参构造函数，Moq无法直接创建它的代理对象。

解决方案 #

通过**自定义测试替身（Test Double）**模拟HttpRequestData和HttpResponseData，绕过Moq的限制。

步骤1：自定义HttpRequestData模拟类 #

using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Http;
using System.Net;
using System.Text;

namespace XUnitTest
{
    public class MockHttpRequestData : HttpRequestData
    {
        private readonly HttpResponseData _response;

        public MockHttpRequestData(FunctionContext context, HttpResponseData response)
            : base(context)
        {
            _response = response;
        }

        public override HttpResponseData CreateResponse(HttpStatusCode statusCode)
        {
            _response.StatusCode = statusCode;
            return _response;
        }

        // 实现其他抽象成员，返回测试无关的默认值
        public override Stream Body => Stream.Null;
        public override HttpHeadersCollection Headers => new();
        public override IReadOnlyCollection<IHttpCookie> Cookies => new List<IHttpCookie>();
        public override Uri Url => new Uri("http://localhost:3068/api/name/TestName/description/TestDesc");
        public override string Method => "GET";
    }
}

步骤2：自定义HttpResponseData模拟类 #

using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Http;
using System.Net;
using System.Text;

namespace XUnitTest
{
    public class MockHttpResponseData : HttpResponseData
    {
        private readonly MemoryStream _bodyStream = new();

        public MockHttpResponseData(FunctionContext context)
            : base(context)
        {
            Headers = new HttpHeadersCollection();
        }

        public override HttpStatusCode StatusCode { get; set; }
        public override HttpHeadersCollection Headers { get; set; }
        public override Stream Body => _bodyStream;

        public override void SetCookie(IHttpCookie cookie)
        {
            // 测试无需实现，留空即可
        }

        public override Task WriteStringAsync(string content, Encoding? encoding = null, CancellationToken cancellationToken = default)
        {
            encoding ??= Encoding.UTF8;
            var bytes = encoding.GetBytes(content);
            return _bodyStream.WriteAsync(bytes, 0, bytes.Length, cancellationToken);
        }
    }
}

步骤3：编写正确的Xunit测试代码 #

using Microsoft.Extensions.Logging;
using Xunit;
using Moq;
using System.Net;
using Microsoft.Azure.Functions.Worker;
using System.IO;
using System.Text.Json;
using FunctionApp.models;
using FunctionApp.service;
using FunctionApp;

namespace XUnitTest
{
    public class ExampleFunctionTests
    {
        [Fact]
        public async Task ExampleFunction_ReturnsBasicObject()
        {
            // Arrange
            var basicServiceMock = new Mock<IBasicService>();
            var functionContextMock = new Mock<FunctionContext>();

            var expectedBasic = new Basic { Name = "TestName", Description = "TestDesc" };
            basicServiceMock.Setup(s => s.Get(It.Is<Basic>(b => b.Name == "TestName" && b.Description == "TestDesc")))
                           .ReturnsAsync(expectedBasic);

            var function = new ExampleFunction(basicServiceMock.Object);

            var mockResponse = new MockHttpResponseData(functionContextMock.Object);
            var mockRequest = new MockHttpRequestData(functionContextMock.Object, mockResponse);

            // Act
            var result = await function.RunAsync(mockRequest, functionContextMock.Object, "TestName", "TestDesc");

            // Assert
            Assert.Equal(HttpStatusCode.OK, result.StatusCode);
            Assert.Equal("application/json; charset=utf-8", result.Headers.GetValues("Content-Type").First());

            mockResponse.Body.Seek(0, SeekOrigin.Begin);
            using var reader = new StreamReader(mockResponse.Body);
            var responseBody = await reader.ReadToEndAsync();
            var actualBasic = JsonSerializer.Deserialize<Basic>(responseBody);

            Assert.NotNull(actualBasic);
            Assert.Equal(expectedBasic.Name, actualBasic.Name);
            Assert.Equal(expectedBasic.Description, actualBasic.Description);

            basicServiceMock.Verify(s => s.Get(It.Is<Basic>(b => b.Name == "TestName" && b.Description == "TestDesc")), Times.Once);
        }
    }
}

关键说明 #

1. 自定义测试替身：通过继承抽象类并实现必要成员，完全控制对象行为，避免Moq的局限性。
2. 绕过扩展方法限制：直接在MockHttpRequestData中重写CreateResponse方法，返回预先准备的响应对象。
3. 精准验证逻辑：不仅验证响应结果，还确认服务方法是否接收了正确参数，确保业务逻辑符合预期。

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