Fixed issues with RedirectHandler and added tests

2026-06-03 03:01:31 +00:00 · 2015-05-22 18:07:39 -04:00
parent eb7e14bd8c
commit ea9f3a4761
3 changed files with 267 additions and 11 deletions
@@ -0,0 +1,225 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Octokit.Internal;
+using Xunit;
+
+namespace Octokit.Tests.Http
+{
+    public class RedirectHandlerTests
+    {
+
+        [Fact]
+        public async Task OkStatusShouldPassThrough()
+        {
+            var invoker = CreateInvoker(new HttpResponseMessage(HttpStatusCode.OK));
+            var httpRequestMessage = CreateRequest(HttpMethod.Get);
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.Equal(response.StatusCode, HttpStatusCode.OK);
+            Assert.Same(response.RequestMessage, httpRequestMessage);
+        }
+
+        
+        [Theory]
+        [InlineData(HttpStatusCode.MovedPermanently)]  // 301
+        [InlineData(HttpStatusCode.Found)]  // 302
+        [InlineData(HttpStatusCode.TemporaryRedirect)]  // 307
+        public async Task ShouldRedirectSameMethod(HttpStatusCode statusCode)
+        {
+            var redirectResponse = new HttpResponseMessage(statusCode);
+            redirectResponse.Headers.Location = new Uri("http://example.org/bar");
+
+            var invoker = CreateInvoker(redirectResponse,
+                                        new HttpResponseMessage(HttpStatusCode.OK));
+            var httpRequestMessage = CreateRequest(HttpMethod.Post);
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.Equal(response.RequestMessage.Method, httpRequestMessage.Method);
+            Assert.NotSame(response.RequestMessage, httpRequestMessage);
+        }
+
+        [Fact]
+        public async Task Status303ShouldRedirectChangeMethod()
+        {
+            var redirectResponse = new HttpResponseMessage(HttpStatusCode.SeeOther);
+            redirectResponse.Headers.Location = new Uri("http://example.org/bar");
+
+            var invoker = CreateInvoker(redirectResponse,
+                                        new HttpResponseMessage(HttpStatusCode.OK));
+            var httpRequestMessage = CreateRequest(HttpMethod.Post);
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.Equal(HttpMethod.Get, response.RequestMessage.Method);
+            Assert.NotSame(response.RequestMessage, httpRequestMessage);
+        }
+
+        [Fact]
+        public async Task RedirectWithSameHostShouldKeepAuthHeader()
+        {
+            var redirectResponse = new HttpResponseMessage(HttpStatusCode.Redirect);
+            redirectResponse.Headers.Location = new Uri("http://example.org/bar");
+
+            var invoker = CreateInvoker(redirectResponse,
+                                        new HttpResponseMessage(HttpStatusCode.OK));
+            var httpRequestMessage = CreateRequest(HttpMethod.Get);
+            httpRequestMessage.Headers.Authorization = new AuthenticationHeaderValue("fooAuth", "aparam");
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.NotSame(response.RequestMessage, httpRequestMessage);
+            Assert.Equal("fooAuth", response.RequestMessage.Headers.Authorization.Scheme);
+        }
+
+
+        [Theory]
+        [InlineData(HttpStatusCode.MovedPermanently)]  // 301
+        [InlineData(HttpStatusCode.Found)]  // 302
+        [InlineData(HttpStatusCode.SeeOther)]  // 303
+        [InlineData(HttpStatusCode.TemporaryRedirect)]  // 307
+        public async Task RedirectWithDifferentHostShouldLoseAuthHeader(HttpStatusCode statusCode)
+        {
+            var redirectResponse = new HttpResponseMessage(statusCode);
+            redirectResponse.Headers.Location = new Uri("http://example.net/bar");
+
+            var invoker = CreateInvoker(redirectResponse,
+                                        new HttpResponseMessage(HttpStatusCode.OK));
+            var httpRequestMessage = CreateRequest(HttpMethod.Get);
+            httpRequestMessage.Headers.Authorization = new AuthenticationHeaderValue("fooAuth", "aparam");
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.NotSame(response.RequestMessage, httpRequestMessage);
+            Assert.Null(response.RequestMessage.Headers.Authorization);
+
+        }
+        
+        [Fact]
+        public async Task DisabledRedirectShouldPassThrough()
+        {
+            var invoker = CreateInvoker(new HttpResponseMessage(HttpStatusCode.Found));
+            var httpRequestMessage = CreateRequest(HttpMethod.Get);
+            httpRequestMessage.Properties[RedirectHandler.AllowAutoRedirectKey] = false;
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.Equal(response.StatusCode, HttpStatusCode.Redirect);
+            Assert.Same(response.RequestMessage, httpRequestMessage);
+        }
+
+        [Theory]
+        [InlineData(HttpStatusCode.MovedPermanently)]  // 301
+        [InlineData(HttpStatusCode.Found)]  // 302
+        [InlineData(HttpStatusCode.TemporaryRedirect)]  // 307
+         public async Task Status301ShouldRedirectPOSTWithBody(HttpStatusCode statusCode)
+        {
+            var redirectResponse = new HttpResponseMessage(statusCode);
+            redirectResponse.Headers.Location = new Uri("http://example.org/bar");
+
+            var invoker = CreateInvoker(redirectResponse,
+                                        new HttpResponseMessage(HttpStatusCode.OK));
+            var httpRequestMessage = CreateRequest(HttpMethod.Post);
+            httpRequestMessage.Content = new StringContent("Hello World");
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.Equal(response.RequestMessage.Method, httpRequestMessage.Method);
+            Assert.NotSame(response.RequestMessage, httpRequestMessage);
+            Assert.Equal("Hello World", await response.RequestMessage.Content.ReadAsStringAsync());
+        }
+
+        // POST see other with content
+        [Fact]
+        public async Task Status303ShouldRedirectToGETWithoutBody()
+        {
+            var redirectResponse = new HttpResponseMessage(HttpStatusCode.SeeOther);
+            redirectResponse.Headers.Location = new Uri("http://example.org/bar");
+
+            var invoker = CreateInvoker(redirectResponse,
+                                        new HttpResponseMessage(HttpStatusCode.OK));
+            var httpRequestMessage = CreateRequest(HttpMethod.Post);
+            httpRequestMessage.Content = new StringContent("Hello World");
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.Equal(HttpMethod.Get, response.RequestMessage.Method);
+            Assert.NotSame(response.RequestMessage, httpRequestMessage);
+            Assert.Null(response.RequestMessage.Content);
+        }
+
+        [Fact]
+        public async Task Exceed3RedirectsShouldReturn()
+        {
+            var redirectResponse = new HttpResponseMessage(HttpStatusCode.Found);
+            redirectResponse.Headers.Location = new Uri("http://example.org/bar");
+
+            var redirectResponse2 = new HttpResponseMessage(HttpStatusCode.Found);
+            redirectResponse2.Headers.Location = new Uri("http://example.org/foo");
+
+
+            var invoker = CreateInvoker(redirectResponse, redirectResponse2);
+
+            var httpRequestMessage = CreateRequest(HttpMethod.Get);
+
+            var response = await invoker.SendAsync(httpRequestMessage, new CancellationToken());
+
+            Assert.NotSame(response.RequestMessage, httpRequestMessage);
+            Assert.Equal(4, (int)response.RequestMessage.Properties[RedirectHandler.RedirectCountKey]);
+        }
+        
+        static HttpRequestMessage CreateRequest(HttpMethod method)
+        {
+            var httpRequestMessage = new HttpRequestMessage();
+            httpRequestMessage.RequestUri = new Uri("http://example.org/foo");
+            httpRequestMessage.Properties[RedirectHandler.AllowAutoRedirectKey] = true;
+            httpRequestMessage.Method = method;
+            return httpRequestMessage;
+        }
+
+        static HttpMessageInvoker CreateInvoker(HttpResponseMessage httpResponseMessage1, HttpResponseMessage httpResponseMessage2 = null)
+        {
+
+            var redirectHandler = new RedirectHandler()
+            {
+                InnerHandler = new MockRedirectHandler(httpResponseMessage1, httpResponseMessage2)
+            };
+            var invoker = new HttpMessageInvoker(redirectHandler);
+            return invoker;
+        }
+    }
+
+    public class MockRedirectHandler : HttpMessageHandler
+    {
+        readonly HttpResponseMessage _response1;
+        readonly HttpResponseMessage _response2;
+        private bool _Response1Sent = false;
+        public MockRedirectHandler(HttpResponseMessage response1, HttpResponseMessage response2 = null)
+        {
+            _response1 = response1;
+            _response2 = response2;
+        }
+
+        protected async override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+        {
+            if (!_Response1Sent)
+            {
+                _Response1Sent = true;
+                _response1.RequestMessage = request;
+                return _response1;
+            }
+            else
+            {
+                _response2.RequestMessage = request;
+                return _response2;
+            }
+        }
+    }
+}