Refactor unit tests to handle the obsolete property

Author: sebastienros

src/Middleware/HttpOverrides/test/ForwardedHeadersMiddlewareTest.cs

@@ -104,7 +104,7 @@ public async Task XForwardedForFirstValueIsInvalid(int limit, string header, str
     [InlineData(2, "13.113.113.13:34567, 12.112.112.12:23456, 11.111.111.11:12345", "12.112.112.12", 23456, "13.113.113.13:34567", true)]
     [InlineData(3, "13.113.113.13:34567, 12.112.112.12:23456, 11.111.111.11:12345", "13.113.113.13", 34567, "", false)]
     [InlineData(3, "13.113.113.13:34567, 12.112.112.12:23456, 11.111.111.11:12345", "13.113.113.13", 34567, "", true)]
-    public async Task XForwardedForForwardLimit(int limit, string header, string expectedIp, int expectedPort, string remainingHeader, bool requireSymmetry)
+    public async Task XForwardedForForwardLimit_Obsolete(int limit, string header, string expectedIp, int expectedPort, string remainingHeader, bool requireSymmetry)
     {
         using var host = new HostBuilder()
             .ConfigureWebHost(webHostBuilder =>
@@ -123,6 +123,61 @@ public async Task XForwardedForForwardLimit(int limit, string header, string exp
 #pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
                     options.KnownNetworks.Clear();
 #pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
+                    app.UseForwardedHeaders(options);
+                });
+            }).Build();
+
+        await host.StartAsync();
+
+        var server = host.GetTestServer();
+
+        var context = await server.SendAsync(c =>
+        {
+            c.Request.Headers["X-Forwarded-For"] = header;
+            c.Connection.RemoteIpAddress = IPAddress.Parse("10.0.0.1");
+            c.Connection.RemotePort = 99;
+        });
+
+        Assert.Equal(expectedIp, context.Connection.RemoteIpAddress.ToString());
+        Assert.Equal(expectedPort, context.Connection.RemotePort);
+        Assert.Equal(remainingHeader, context.Request.Headers["X-Forwarded-For"].ToString());
+    }
+
+    [Theory]
+    [InlineData(1, "11.111.111.11:12345", "11.111.111.11", 12345, "", false)]
+    [InlineData(1, "11.111.111.11:12345", "11.111.111.11", 12345, "", true)]
+    [InlineData(10, "11.111.111.11:12345", "11.111.111.11", 12345, "", false)]
+    [InlineData(10, "11.111.111.11:12345", "11.111.111.11", 12345, "", true)]
+    [InlineData(1, "12.112.112.12:23456, 11.111.111.11:12345", "11.111.111.11", 12345, "12.112.112.12:23456", false)]
+    [InlineData(1, "12.112.112.12:23456, 11.111.111.11:12345", "11.111.111.11", 12345, "12.112.112.12:23456", true)]
+    [InlineData(2, "12.112.112.12:23456, 11.111.111.11:12345", "12.112.112.12", 23456, "", false)]
+    [InlineData(2, "12.112.112.12:23456, 11.111.111.11:12345", "12.112.112.12", 23456, "", true)]
+    [InlineData(10, "12.112.112.12:23456, 11.111.111.11:12345", "12.112.112.12", 23456, "", false)]
+    [InlineData(10, "12.112.112.12:23456, 11.111.111.11:12345", "12.112.112.12", 23456, "", true)]
+    [InlineData(10, "12.112.112.12.23456, 11.111.111.11:12345", "11.111.111.11", 12345, "12.112.112.12.23456", false)] // Invalid 2nd value
+    [InlineData(10, "12.112.112.12.23456, 11.111.111.11:12345", "11.111.111.11", 12345, "12.112.112.12.23456", true)] // Invalid 2nd value
+    [InlineData(10, "13.113.113.13:34567, 12.112.112.12.23456, 11.111.111.11:12345", "11.111.111.11", 12345, "13.113.113.13:34567,12.112.112.12.23456", false)] // Invalid 2nd value
+    [InlineData(10, "13.113.113.13:34567, 12.112.112.12.23456, 11.111.111.11:12345", "11.111.111.11", 12345, "13.113.113.13:34567,12.112.112.12.23456", true)] // Invalid 2nd value
+    [InlineData(2, "13.113.113.13:34567, 12.112.112.12:23456, 11.111.111.11:12345", "12.112.112.12", 23456, "13.113.113.13:34567", false)]
+    [InlineData(2, "13.113.113.13:34567, 12.112.112.12:23456, 11.111.111.11:12345", "12.112.112.12", 23456, "13.113.113.13:34567", true)]
+    [InlineData(3, "13.113.113.13:34567, 12.112.112.12:23456, 11.111.111.11:12345", "13.113.113.13", 34567, "", false)]
+    [InlineData(3, "13.113.113.13:34567, 12.112.112.12:23456, 11.111.111.11:12345", "13.113.113.13", 34567, "", true)]
+    public async Task XForwardedForForwardLimit(int limit, string header, string expectedIp, int expectedPort, string remainingHeader, bool requireSymmetry)
+    {
+        using var host = new HostBuilder()
+            .ConfigureWebHost(webHostBuilder =>
+            {
+                webHostBuilder
+                .UseTestServer()
+                .Configure(app =>
+                {
+                    var options = new ForwardedHeadersOptions
+                    {
+                        ForwardedHeaders = ForwardedHeaders.XForwardedFor,
+                        RequireHeaderSymmetry = requireSymmetry,
+                        ForwardLimit = limit,
+                    };
+                    options.KnownProxies.Clear();
                     options.KnownIPNetworks.Clear();
                     app.UseForwardedHeaders(options);
                 });
@@ -847,7 +902,7 @@ public async Task XForwardedProtoOverrideCanBeIndependentOfXForwardedForCount(in
     [InlineData("h2, h1", "", "::1", true, "http")]
     [InlineData("h2, h1", "F::, D::", "::1", true, "h1")]
     [InlineData("h2, h1", "E::, D::", "F::", true, "http")]
-    public async Task XForwardedProtoOverrideLimitedByLoopback(string protoHeader, string forHeader, string remoteIp, bool loopback, string expected)
+    public async Task XForwardedProtoOverrideLimitedByLoopback_Obsolete(string protoHeader, string forHeader, string remoteIp, bool loopback, string expected)
     {
         using var host = new HostBuilder()
             .ConfigureWebHost(webHostBuilder =>
@@ -867,6 +922,56 @@ public async Task XForwardedProtoOverrideLimitedByLoopback(string protoHeader, s
 #pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
                         options.KnownNetworks.Clear();
 #pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
+                        options.KnownProxies.Clear();
+                    }
+                    app.UseForwardedHeaders(options);
+                });
+            }).Build();
+
+        await host.StartAsync();
+
+        var server = host.GetTestServer();
+
+        var context = await server.SendAsync(c =>
+        {
+            c.Request.Headers["X-Forwarded-Proto"] = protoHeader;
+            c.Request.Headers["X-Forwarded-For"] = forHeader;
+            c.Connection.RemoteIpAddress = IPAddress.Parse(remoteIp);
+        });
+
+        Assert.Equal(expected, context.Request.Scheme);
+    }
+
+    [Theory]
+    [InlineData("", "", "::1", false, "http")]
+    [InlineData("h1", "", "::1", false, "http")]
+    [InlineData("h1", "F::", "::1", false, "h1")]
+    [InlineData("h1", "F::", "E::", false, "h1")]
+    [InlineData("", "", "::1", true, "http")]
+    [InlineData("h1", "", "::1", true, "http")]
+    [InlineData("h1", "F::", "::1", true, "h1")]
+    [InlineData("h1", "", "F::", true, "http")]
+    [InlineData("h1", "E::", "F::", true, "http")]
+    [InlineData("h2, h1", "", "::1", true, "http")]
+    [InlineData("h2, h1", "F::, D::", "::1", true, "h1")]
+    [InlineData("h2, h1", "E::, D::", "F::", true, "http")]
+    public async Task XForwardedProtoOverrideLimitedByLoopback(string protoHeader, string forHeader, string remoteIp, bool loopback, string expected)
+    {
+        using var host = new HostBuilder()
+            .ConfigureWebHost(webHostBuilder =>
+            {
+                webHostBuilder
+                .UseTestServer()
+                .Configure(app =>
+                {
+                    var options = new ForwardedHeadersOptions
+                    {
+                        ForwardedHeaders = ForwardedHeaders.XForwardedProto | ForwardedHeaders.XForwardedFor,
+                        RequireHeaderSymmetry = true,
+                        ForwardLimit = 5,
+                    };
+                    if (!loopback)
+                    {
                         options.KnownIPNetworks.Clear();
                         options.KnownProxies.Clear();
                     }
@@ -1127,7 +1232,7 @@ public async Task XForwardForIPv4ToIPv6Mapping(string forHeader, string knownPro
     [Theory]
     [InlineData(1, "httpa, httpb, httpc", "httpc", "httpa,httpb")]
     [InlineData(2, "httpa, httpb, httpc", "httpb", "httpa")]
-    public async Task ForwardersWithDIOptionsRunsOnce(int limit, string header, string expectedScheme, string remainingHeader)
+    public async Task ForwardersWithDIOptionsRunsOnce_Obsolete(int limit, string header, string expectedScheme, string remainingHeader)
     {
         using var host = new HostBuilder()
             .ConfigureWebHost(webHostBuilder =>
@@ -1143,6 +1248,45 @@ public async Task ForwardersWithDIOptionsRunsOnce(int limit, string header, stri
 #pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
                         options.KnownNetworks.Clear();
 #pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
+                        options.ForwardLimit = limit;
+                    });
+                })
+                .Configure(app =>
+                {
+                    app.UseForwardedHeaders();
+                    app.UseForwardedHeaders();
+                });
+            }).Build();
+
+        await host.StartAsync();
+
+        var server = host.GetTestServer();
+
+        var context = await server.SendAsync(c =>
+        {
+            c.Request.Headers["X-Forwarded-Proto"] = header;
+        });
+
+        Assert.Equal(expectedScheme, context.Request.Scheme);
+        Assert.Equal(remainingHeader, context.Request.Headers["X-Forwarded-Proto"].ToString());
+    }
+
+    [Theory]
+    [InlineData(1, "httpa, httpb, httpc", "httpc", "httpa,httpb")]
+    [InlineData(2, "httpa, httpb, httpc", "httpb", "httpa")]
+    public async Task ForwardersWithDIOptionsRunsOnce(int limit, string header, string expectedScheme, string remainingHeader)
+    {
+        using var host = new HostBuilder()
+            .ConfigureWebHost(webHostBuilder =>
+            {
+                webHostBuilder
+                .UseTestServer()
+                .ConfigureServices(services =>
+                {
+                    services.Configure<ForwardedHeadersOptions>(options =>
+                    {
+                        options.ForwardedHeaders = ForwardedHeaders.XForwardedProto;
+                        options.KnownProxies.Clear();
                         options.KnownIPNetworks.Clear();
                         options.ForwardLimit = limit;
                     });
@@ -1170,7 +1314,7 @@ public async Task ForwardersWithDIOptionsRunsOnce(int limit, string header, stri
     [Theory]
     [InlineData(1, "httpa, httpb, httpc", "httpb", "httpa")]
     [InlineData(2, "httpa, httpb, httpc", "httpa", "")]
-    public async Task ForwardersWithDirectOptionsRunsTwice(int limit, string header, string expectedScheme, string remainingHeader)
+    public async Task ForwardersWithDirectOptionsRunsTwice_Obsolete(int limit, string header, string expectedScheme, string remainingHeader)
     {
         using var host = new HostBuilder()
             .ConfigureWebHost(webHostBuilder =>
@@ -1188,6 +1332,42 @@ public async Task ForwardersWithDirectOptionsRunsTwice(int limit, string header,
 #pragma warning disable ASPDEPR005 // KnownNetworks is obsolete
                     options.KnownNetworks.Clear();
 #pragma warning restore ASPDEPR005 // KnownNetworks is obsolete
+                    app.UseForwardedHeaders(options);
+                    app.UseForwardedHeaders(options);
+                });
+            }).Build();
+
+        await host.StartAsync();
+
+        var server = host.GetTestServer();
+
+        var context = await server.SendAsync(c =>
+        {
+            c.Request.Headers["X-Forwarded-Proto"] = header;
+        });
+
+        Assert.Equal(expectedScheme, context.Request.Scheme);
+        Assert.Equal(remainingHeader, context.Request.Headers["X-Forwarded-Proto"].ToString());
+    }
+
+    [Theory]
+    [InlineData(1, "httpa, httpb, httpc", "httpb", "httpa")]
+    [InlineData(2, "httpa, httpb, httpc", "httpa", "")]
+    public async Task ForwardersWithDirectOptionsRunsTwice(int limit, string header, string expectedScheme, string remainingHeader)
+    {
+        using var host = new HostBuilder()
+            .ConfigureWebHost(webHostBuilder =>
+            {
+                webHostBuilder
+                .UseTestServer()
+                .Configure(app =>
+                {
+                    var options = new ForwardedHeadersOptions
+                    {
+                        ForwardedHeaders = ForwardedHeaders.XForwardedProto,
+                        ForwardLimit = limit,
+                    };
+                    options.KnownProxies.Clear();
                     options.KnownIPNetworks.Clear();
                     app.UseForwardedHeaders(options);
                     app.UseForwardedHeaders(options);