Cookie proxying and auto redirect configuration #128

HttpHandlerOptions are added to ReRoute configuration and passed down to HttpClientHttpRequester as Request properties.

test/Ocelot.UnitTests/Configuration/FileConfigurationCreatorTests.cs

@@ -45,6 +45,7 @@ namespace Ocelot.UnitTests.Configuration
         private Mock<IReRouteOptionsCreator> _fileReRouteOptionsCreator;
         private Mock<IRateLimitOptionsCreator> _rateLimitOptions;
         private Mock<IRegionCreator> _regionCreator;
+        private Mock<IHttpHandlerOptionsCreator> _httpHandlerOptionsCreator;
 
         public FileConfigurationCreatorTests()
         {
@@ -66,6 +67,7 @@ namespace Ocelot.UnitTests.Configuration
             _fileReRouteOptionsCreator = new Mock<IReRouteOptionsCreator>();
             _rateLimitOptions = new Mock<IRateLimitOptionsCreator>();
             _regionCreator = new Mock<IRegionCreator>();
+            _httpHandlerOptionsCreator = new Mock<IHttpHandlerOptionsCreator>();
 
             _ocelotConfigurationCreator = new FileOcelotConfigurationCreator( 
                 _fileConfig.Object, _validator.Object, _logger.Object,
@@ -73,7 +75,7 @@ namespace Ocelot.UnitTests.Configuration
                 _qosProviderFactory.Object, _qosProviderHouse.Object, _claimsToThingCreator.Object,
                 _authOptionsCreator.Object, _upstreamTemplatePatternCreator.Object, _requestIdKeyCreator.Object,
                 _serviceProviderConfigCreator.Object, _qosOptionsCreator.Object, _fileReRouteOptionsCreator.Object,
-                _rateLimitOptions.Object, _regionCreator.Object);
+                _rateLimitOptions.Object, _regionCreator.Object, _httpHandlerOptionsCreator.Object);
         }
 
         [Fact]
@@ -444,6 +446,45 @@ namespace Ocelot.UnitTests.Configuration
                 .BDDfy();
         }
 
+        [Fact]
+        public void should_call_httpHandler_creator()
+        {
+            var reRouteOptions = new ReRouteOptionsBuilder()
+                .Build();
+            var httpHandlerOptions = new HttpHandlerOptions(true, true);
+
+            this.Given(x => x.GivenTheConfigIs(new FileConfiguration
+            {
+                ReRoutes = new List<FileReRoute>
+                            {
+                                new FileReRoute
+                                {
+                                    DownstreamHost = "127.0.0.1",
+                                    UpstreamPathTemplate = "/api/products/{productId}",
+                                    DownstreamPathTemplate = "/products/{productId}",
+                                    UpstreamHttpMethod = new List<string> { "Get" }
+                                }
+                            },
+            }))
+                .And(x => x.GivenTheFollowingOptionsAreReturned(reRouteOptions))
+                .And(x => x.GivenTheConfigIsValid())
+                .And(x => x.GivenTheFollowingHttpHandlerOptionsAreReturned(httpHandlerOptions))
+                .When(x => x.WhenICreateTheConfig())
+                .Then(x => x.ThenTheHttpHandlerOptionsCreatorIsCalledCorrectly())
+                .BDDfy();
+        }
+
+        private void GivenTheFollowingHttpHandlerOptionsAreReturned(HttpHandlerOptions httpHandlerOptions)
+        {
+            _httpHandlerOptionsCreator.Setup(x => x.Create(It.IsAny<FileReRoute>()))
+                .Returns(httpHandlerOptions);
+        }
+
+        private void ThenTheHttpHandlerOptionsCreatorIsCalledCorrectly()
+        {
+            _httpHandlerOptionsCreator.Verify(x => x.Create(_fileConfiguration.ReRoutes[0]), Times.Once());
+        }
+
         [Theory]
         [MemberData(nameof(AuthenticationConfigTestData.GetAuthenticationData), MemberType = typeof(AuthenticationConfigTestData))]
         public void should_create_with_headers_to_extract(string provider, IAuthenticationConfig config, FileConfiguration fileConfig)

test/Ocelot.UnitTests/Configuration/HttpHandlerOptionsCreatorTests.cs

@@ -0,0 +1,71 @@
+using Ocelot.Configuration;
+using Ocelot.Configuration.Creator;
+using Ocelot.Configuration.File;
+using Shouldly;
+using TestStack.BDDfy;
+using Xunit;
+
+namespace Ocelot.UnitTests.Configuration
+{
+
+    public class HttpHandlerOptionsCreatorTests
+    {
+        private readonly IHttpHandlerOptionsCreator _httpHandlerOptionsCreator;
+        private FileReRoute _fileReRoute;
+        private HttpHandlerOptions _httpHandlerOptions;
+
+        public HttpHandlerOptionsCreatorTests()
+        {
+            _httpHandlerOptionsCreator = new HttpHandlerOptionsCreator();
+        }
+
+        [Fact]
+        public void should_create_options_with_useCookie_and_allowAutoRedirect_true_as_default()
+        {
+            var fileReRoute = new FileReRoute();
+            var expectedOptions = new HttpHandlerOptions(true, true);
+
+            this.Given(x => GivenTheFollowing(fileReRoute))
+                .When(x => WhenICreateHttpHandlerOptions())
+                .Then(x => ThenTheFollowingOptionsReturned(expectedOptions))
+                .BDDfy();
+        }
+
+        [Fact]
+        public void should_create_options_with_specified_useCookie_and_allowAutoRedirect()
+        {
+            var fileReRoute = new FileReRoute
+            {
+                HttpHandlerOptions = new FileHttpHandlerOptions
+                {
+                    AllowAutoRedirect = false,
+                    UseCookieContainer = false
+                }
+            };
+
+            var expectedOptions = new HttpHandlerOptions(false, false);
+
+            this.Given(x => GivenTheFollowing(fileReRoute))
+                .When(x => WhenICreateHttpHandlerOptions())
+                .Then(x => ThenTheFollowingOptionsReturned(expectedOptions))
+                .BDDfy();
+        }
+
+        private void GivenTheFollowing(FileReRoute fileReRoute)
+        {
+            _fileReRoute = fileReRoute;
+        }
+
+        private void WhenICreateHttpHandlerOptions()
+        {
+            _httpHandlerOptions = _httpHandlerOptionsCreator.Create(_fileReRoute);
+        }
+
+        private void ThenTheFollowingOptionsReturned(HttpHandlerOptions options)
+        {
+            _httpHandlerOptions.ShouldNotBeNull();
+            _httpHandlerOptions.AllowAutoRedirect.ShouldBe(options.AllowAutoRedirect);
+            _httpHandlerOptions.UseCookieContainer.ShouldBe(options.UseCookieContainer);
+        }
+    }
+}

test/Ocelot.UnitTests/Request/HttpRequestBuilderMiddlewareTests.cs

@@ -15,8 +15,9 @@
     using TestStack.BDDfy;
     using Xunit;
     using Ocelot.Requester.QoS;
-    using Microsoft.AspNetCore.Builder;
-
+    using Ocelot.Configuration;
+    using Microsoft.AspNetCore.Builder;
+
     public class HttpRequestBuilderMiddlewareTests : ServerHostedMiddlewareTest
     {
         private readonly Mock<IRequestCreator> _requestBuilder;
@@ -50,12 +51,13 @@
                 new ReRouteBuilder()
                     .WithRequestIdKey("LSRequestId")
                     .WithUpstreamHttpMethod(new List<string> { "Get" })
+                    .WithHttpHandlerOptions(new HttpHandlerOptions(true, true))
                     .Build());
 
             this.Given(x => x.GivenTheDownStreamUrlIs("any old string"))
                 .And(x => x.GivenTheQosProviderHouseReturns(new OkResponse<IQoSProvider>(new NoQoSProvider())))
                 .And(x => x.GivenTheDownStreamRouteIs(downstreamRoute))
-                .And(x => x.GivenTheRequestBuilderReturns(new Ocelot.Request.Request(new HttpRequestMessage(), true, new NoQoSProvider())))
+                .And(x => x.GivenTheRequestBuilderReturns(new Ocelot.Request.Request(new HttpRequestMessage(), true, new NoQoSProvider(), false, false)))
                 .When(x => x.WhenICallTheMiddleware())
                 .Then(x => x.ThenTheScopedDataRepositoryIsCalledCorrectly())
                 .BDDfy();
@@ -103,7 +105,11 @@
             _request = new OkResponse<Ocelot.Request.Request>(request);
 
             _requestBuilder
-                .Setup(x => x.Build(It.IsAny<HttpRequestMessage>(), It.IsAny<bool>(), It.IsAny<IQoSProvider>()))
+                .Setup(x => x.Build(It.IsAny<HttpRequestMessage>(),
+                                    It.IsAny<bool>(),
+                                    It.IsAny<IQoSProvider>(),
+                                    It.IsAny<bool>(),
+                                    It.IsAny<bool>()))
                 .ReturnsAsync(_request);
         }
 

test/Ocelot.UnitTests/Request/HttpRequestCreatorTests.cs

@@ -15,6 +15,9 @@
         private readonly bool _isQos;
         private readonly IQoSProvider _qoSProvider;
         private readonly HttpRequestMessage _requestMessage;
+        private readonly bool _useCookieContainer;
+        private readonly bool _allowAutoRedirect;
+
         private Response<Ocelot.Request.Request> _response;
 
         public HttpRequestCreatorTests()
@@ -22,6 +25,9 @@
             _requestCreator = new HttpRequestCreator();
             _isQos = true;
             _qoSProvider = new NoQoSProvider();
+            _useCookieContainer = false;
+            _allowAutoRedirect = false;
+
             _requestMessage = new HttpRequestMessage();
         }
 
@@ -30,12 +36,19 @@
         {
             this.When(x => x.WhenIBuildARequest())
                 .Then(x => x.ThenTheRequestContainsTheRequestMessage())
+                .Then(x => x.ThenTheRequestContainsTheIsQos())
+                .Then(x => x.ThenTheRequestContainsTheQosProvider())
+                .Then(x => x.ThenTheRequestContainsUseCookieContainer())
+                .Then(x => x.ThenTheRequestContainsAllowAutoRedirect())
                 .BDDfy();
         }
 
         private void WhenIBuildARequest()
         {
-            _response = _requestCreator.Build(_requestMessage, _isQos, _qoSProvider).GetAwaiter().GetResult();
+            _response = _requestCreator.Build(_requestMessage,
+                    _isQos, _qoSProvider, _useCookieContainer, _allowAutoRedirect)
+                .GetAwaiter()
+                .GetResult();
         }
 
         private void ThenTheRequestContainsTheRequestMessage()
@@ -52,5 +65,15 @@
         {
             _response.Data.QosProvider.ShouldBe(_qoSProvider);
         }
+
+        private void ThenTheRequestContainsUseCookieContainer()
+        {
+            _response.Data.UseCookieContainer.ShouldBe(_useCookieContainer);
+        }
+
+        private void ThenTheRequestContainsAllowAutoRedirect()
+        {
+            _response.Data.AllowAutoRedirect.ShouldBe(_allowAutoRedirect);
+        }
     }
 }

test/Ocelot.UnitTests/Requester/HttpRequesterMiddlewareTests.cs

@@ -28,7 +28,7 @@
         [Fact]
         public void should_call_scoped_data_repository_correctly()
         {
-            this.Given(x => x.GivenTheRequestIs(new Ocelot.Request.Request(new HttpRequestMessage(),true, new NoQoSProvider())))
+            this.Given(x => x.GivenTheRequestIs(new Ocelot.Request.Request(new HttpRequestMessage(),true, new NoQoSProvider(), false, false)))
                 .And(x => x.GivenTheRequesterReturns(new HttpResponseMessage()))
                 .And(x => x.GivenTheScopedRepoReturns())
                 .When(x => x.WhenICallTheMiddleware())