在与 Asp.Net Core TestServer 的集成测试中设置虚拟 IP 地址

Question

我有一个 C# Asp.Net Core (1.x) 项目，实现了一个 Web REST API 及其相关的集成测试项目，在任何测试之前都有一个类似的设置：

// ...

IWebHostBuilder webHostBuilder = GetWebHostBuilderSimilarToRealOne()
    .UseStartup<MyTestStartup>();

TestServer server = new TestServer(webHostBuilder);
server.BaseAddress = new Uri("http://localhost:5000");

HttpClient client = server.CreateClient();

// ...

在测试期间，client 用于向 Web API（被测系统）发送 HTTP 请求并检索响应。

在实际测试系统中，有一些组件会从每个请求中提取发送者 IP 地址，如下所示：

HttpContext httpContext = ReceiveHttpContextDuringAuthentication();

// edge cases omitted for brevity
string remoteIpAddress = httpContext?.Connection?.RemoteIpAddress?.ToString()

现在在集成测试期间，这段代码无法找到 IP 地址，因为RemoteIpAddress 始终为空。

有没有办法从测试代码中将其设置为某个已知值？我在 SO 上搜索了这里，但找不到类似的东西。助教

Answer 1

我在 ASP.NET Core 2.2 项目中使用了Elliott's answer。但是，更新到 ASP.NET 5.0，我不得不将 CreateWebHostBuilder 的覆盖替换为 CreateHostBuilder 的以下覆盖：

protected override IHostBuilder CreateHostBuilder()
{
    return Host
        .CreateDefaultBuilder()
        .ConfigureWebHostDefaults(builder =>
        {
            builder.UseStartup<Startup>();
        })
        .ConfigureServices(services =>
        {
            services.AddSingleton<IStartupFilter, CustomStartupFilter>();
        });
}

Answer 2

使用 WebHost.CreateDefaultBuilder 可能会弄乱您的应用配置。

除非绝对必要，否则无需为了测试而更改产品代码。

添加您自己的中间件而不覆盖 Startup 类方法的最简单方法是按照 Elliott 的回答所建议的通过 IStartupFilter‍ 添加中间件。

但是不要使用WebHost.CreateDefaultBuilder，而是使用

base.CreateWebHostBuilder().ConfigureServices...

    public class CustomWAF : WebApplicationFactory<Startup>
    {
        protected override IWebHostBuilder CreateWebHostBuilder()
        {
            return base.CreateWebHostBuilder().ConfigureServices(services =>
            {
                services.AddSingleton<IStartupFilter, CustomStartupFilter>();
            });
        }
    }

Answer 3

根据这个答案in ASP.NET Core, is there any way to set up middleware from Program.cs?

还可以从 ConfigureServices 配置中间件，它允许您创建自定义 WebApplicationFactory 而无需 StartupStub 类：

public class CustomWebApplicationFactory : WebApplicationFactory<Startup>
{
    protected override IWebHostBuilder CreateWebHostBuilder()
    {
        return WebHost
            .CreateDefaultBuilder<Startup>(new string[0])
            .ConfigureServices(services =>
            {
                services.AddSingleton<IStartupFilter, CustomStartupFilter>();
            });
    }
}


public class CustomStartupFilter : IStartupFilter
{
    public Action<IApplicationBuilder> Configure(Action<IApplicationBuilder> next)
    {
        return app =>
        {
            app.UseMiddleware<FakeRemoteIpAddressMiddleware>();
            next(app);
        };
    }
}

Answer 4

您可以编写中间件来设置自定义 IP 地址，因为该属性是可写的：

public class FakeRemoteIpAddressMiddleware
{
    private readonly RequestDelegate next;
    private readonly IPAddress fakeIpAddress = IPAddress.Parse("127.168.1.32");

    public FakeRemoteIpAddressMiddleware(RequestDelegate next)
    {
        this.next = next;
    }

    public async Task Invoke(HttpContext httpContext)
    {
        httpContext.Connection.RemoteIpAddress = fakeIpAddress;

        await this.next(httpContext);
    }
}

然后你可以像这样创建StartupStub 类：

public class StartupStub : Startup
{
    public StartupStub(IConfiguration configuration) : base(configuration)
    {
    }

    public override void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        app.UseMiddleware<FakeRemoteIpAddressMiddleware>();
        base.Configure(app, env);
    }
}

并用它来创建TestServer：

new TestServer(new WebHostBuilder().UseStartup<StartupStub>());