More IResult Implementations (#32738)

ilkayilknur · web-flow · commit 94b7c9ad9395 · 2021-05-16T11:40:52.000-07:00
* IResult implementation for SignInResult

* IResult implementation for SignOutResult

* IResult implementation for ForbidResult

* IResult implementation for ChallangeResult

* return Task directly instead of async/await.
diff --git a/src/Mvc/Mvc.Core/src/ChallengeResult.cs b/src/Mvc/Mvc.Core/src/ChallengeResult.cs
@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authentication;
+using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
@@ -13,7 +14,7 @@ namespace Microsoft.AspNetCore.Mvc
     /// <summary>
     /// An <see cref="ActionResult"/> that on execution invokes <see cref="M:HttpContext.ChallengeAsync"/>.
     /// </summary>
-    public class ChallengeResult : ActionResult
+    public class ChallengeResult : ActionResult, IResult
     {
         /// <summary>
         /// Initializes a new instance of <see cref="ChallengeResult"/>.
@@ -90,14 +91,25 @@ public ChallengeResult(IList<string> authenticationSchemes, AuthenticationProper
         public AuthenticationProperties? Properties { get; set; }
 
         /// <inheritdoc />
-        public override async Task ExecuteResultAsync(ActionContext context)
+        public override Task ExecuteResultAsync(ActionContext context)
         {
             if (context == null)
             {
                 throw new ArgumentNullException(nameof(context));
             }
 
-            var loggerFactory = context.HttpContext.RequestServices.GetRequiredService<ILoggerFactory>();
+            return ExecuteAsync(context.HttpContext);
+        }
+
+        /// <inheritdoc />
+        Task IResult.ExecuteAsync(HttpContext httpContext)
+        {
+            return ExecuteAsync(httpContext);
+        }
+
+        private async Task ExecuteAsync(HttpContext httpContext)
+        {
+            var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();
             var logger = loggerFactory.CreateLogger<ChallengeResult>();
 
             logger.ChallengeResultExecuting(AuthenticationSchemes);
@@ -106,12 +118,12 @@ public override async Task ExecuteResultAsync(ActionContext context)
             {
                 foreach (var scheme in AuthenticationSchemes)
                 {
-                    await context.HttpContext.ChallengeAsync(scheme, Properties);
+                    await httpContext.ChallengeAsync(scheme, Properties);
                 }
             }
             else
             {
-                await context.HttpContext.ChallengeAsync(Properties);
+                await httpContext.ChallengeAsync(Properties);
             }
         }
     }
diff --git a/src/Mvc/Mvc.Core/src/ForbidResult.cs b/src/Mvc/Mvc.Core/src/ForbidResult.cs
@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authentication;
+using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
@@ -13,7 +14,7 @@ namespace Microsoft.AspNetCore.Mvc
     /// <summary>
     /// An <see cref="ActionResult"/> that on execution invokes <see cref="M:HttpContext.ForbidAsync"/>.
     /// </summary>
-    public class ForbidResult : ActionResult
+    public class ForbidResult : ActionResult, IResult
     {
         /// <summary>
         /// Initializes a new instance of <see cref="ForbidResult"/>.
@@ -90,14 +91,25 @@ public ForbidResult(IList<string> authenticationSchemes, AuthenticationPropertie
         public AuthenticationProperties? Properties { get; set; }
 
         /// <inheritdoc />
-        public override async Task ExecuteResultAsync(ActionContext context)
+        public override Task ExecuteResultAsync(ActionContext context)
         {
             if (context == null)
             {
                 throw new ArgumentNullException(nameof(context));
             }
 
-            var loggerFactory = context.HttpContext.RequestServices.GetRequiredService<ILoggerFactory>();
+            return ExecuteAsync(context.HttpContext);
+        }
+
+        /// <inheritdoc />
+        Task IResult.ExecuteAsync(HttpContext httpContext)
+        {
+            return ExecuteAsync(httpContext);
+        }
+
+        private async Task ExecuteAsync(HttpContext httpContext)
+        {
+            var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();
             var logger = loggerFactory.CreateLogger<ForbidResult>();
 
             logger.ForbidResultExecuting(AuthenticationSchemes);
@@ -106,12 +118,12 @@ public override async Task ExecuteResultAsync(ActionContext context)
             {
                 for (var i = 0; i < AuthenticationSchemes.Count; i++)
                 {
-                    await context.HttpContext.ForbidAsync(AuthenticationSchemes[i], Properties);
+                    await httpContext.ForbidAsync(AuthenticationSchemes[i], Properties);
                 }
             }
             else
             {
-                await context.HttpContext.ForbidAsync(Properties);
+                await httpContext.ForbidAsync(Properties);
             }
         }
     }
diff --git a/src/Mvc/Mvc.Core/src/SignInResult.cs b/src/Mvc/Mvc.Core/src/SignInResult.cs
@@ -5,6 +5,7 @@
 using System.Security.Claims;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authentication;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc.Core;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -14,7 +15,7 @@ namespace Microsoft.AspNetCore.Mvc
     /// <summary>
     /// An <see cref="ActionResult"/> that on execution invokes <see cref="M:HttpContext.SignInAsync"/>.
     /// </summary>
-    public class SignInResult : ActionResult
+    public class SignInResult : ActionResult, IResult
     {
         /// <summary>
         /// Initializes a new instance of <see cref="SignInResult"/> with the
@@ -78,19 +79,30 @@ public SignInResult(string? authenticationScheme, ClaimsPrincipal principal, Aut
         public AuthenticationProperties? Properties { get; set; }
 
         /// <inheritdoc />
-        public override async Task ExecuteResultAsync(ActionContext context)
+        public override Task ExecuteResultAsync(ActionContext context)
         {
             if (context == null)
             {
                 throw new ArgumentNullException(nameof(context));
             }
 
-            var loggerFactory = context.HttpContext.RequestServices.GetRequiredService<ILoggerFactory>();
+            return ExecuteAsync(context.HttpContext);
+        }
+
+        /// <inheritdoc />
+        Task IResult.ExecuteAsync(HttpContext httpContext)
+        {
+            return ExecuteAsync(httpContext);
+        }
+
+        private Task ExecuteAsync(HttpContext httpContext)
+        {
+            var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();
             var logger = loggerFactory.CreateLogger<SignInResult>();
 
             logger.SignInResultExecuting(AuthenticationScheme, Principal);
 
-            await context.HttpContext.SignInAsync(AuthenticationScheme, Principal, Properties);
+            return httpContext.SignInAsync(AuthenticationScheme, Principal, Properties);
         }
     }
 }
diff --git a/src/Mvc/Mvc.Core/src/SignOutResult.cs b/src/Mvc/Mvc.Core/src/SignOutResult.cs
@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authentication;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc.Core;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -14,7 +15,7 @@ namespace Microsoft.AspNetCore.Mvc
     /// <summary>
     /// An <see cref="ActionResult"/> that on execution invokes <see cref="M:HttpContext.SignOutAsync"/>.
     /// </summary>
-    public class SignOutResult : ActionResult
+    public class SignOutResult : ActionResult, IResult
     {
         /// <summary>
         /// Initializes a new instance of <see cref="SignOutResult"/> with the default sign out scheme.
@@ -88,13 +89,24 @@ public SignOutResult(IList<string> authenticationSchemes, AuthenticationProperti
         public AuthenticationProperties? Properties { get; set; }
 
         /// <inheritdoc />
-        public override async Task ExecuteResultAsync(ActionContext context)
+        public override Task ExecuteResultAsync(ActionContext context)
         {
             if (context == null)
             {
                 throw new ArgumentNullException(nameof(context));
             }
 
+            return ExecuteAsync(context.HttpContext);
+        }
+
+        /// <inheritdoc />
+        Task IResult.ExecuteAsync(HttpContext httpContext)
+        {
+            return ExecuteAsync(httpContext);
+        }
+
+        private async Task ExecuteAsync(HttpContext httpContext)
+        {
             if (AuthenticationSchemes == null)
             {
                 throw new InvalidOperationException(
@@ -103,20 +115,20 @@ public override async Task ExecuteResultAsync(ActionContext context)
                         /* type: */ nameof(SignOutResult)));
             }
 
-            var loggerFactory = context.HttpContext.RequestServices.GetRequiredService<ILoggerFactory>();
+            var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();
             var logger = loggerFactory.CreateLogger<SignOutResult>();
 
             logger.SignOutResultExecuting(AuthenticationSchemes);
 
             if (AuthenticationSchemes.Count == 0)
             {
-                await context.HttpContext.SignOutAsync(Properties);
+                await httpContext.SignOutAsync(Properties);
             }
             else
             {
                 for (var i = 0; i < AuthenticationSchemes.Count; i++)
                 {
-                    await context.HttpContext.SignOutAsync(AuthenticationSchemes[i], Properties);
+                    await httpContext.SignOutAsync(AuthenticationSchemes[i], Properties);
                 }
             }
         }
diff --git a/src/Mvc/Mvc.Core/test/ChallengeResultTest.cs b/src/Mvc/Mvc.Core/test/ChallengeResultTest.cs
@@ -17,7 +17,7 @@ namespace Microsoft.AspNetCore.Mvc
     public class ChallengeResultTest
     {
         [Fact]
-        public async Task ChallengeResult_Execute()
+        public async Task ChallengeResult_ExecuteResultAsync()
         {
             // Arrange
             var result = new ChallengeResult("", null);
@@ -43,7 +43,7 @@ public async Task ChallengeResult_Execute()
         }
 
         [Fact]
-        public async Task ChallengeResult_ExecuteNoSchemes()
+        public async Task ChallengeResult_ExecuteResultAsync_NoSchemes()
         {
             // Arrange
             var result = new ChallengeResult(new string[] { }, null);
@@ -67,6 +67,43 @@ public async Task ChallengeResult_ExecuteNoSchemes()
             auth.Verify(c => c.ChallengeAsync(httpContext.Object, null, null), Times.Exactly(1));
         }
 
+        [Fact]
+        public async Task ChallengeResult_ExecuteAsync()
+        {
+            // Arrange
+            var result = new ChallengeResult("", null);
+
+            var auth = new Mock<IAuthenticationService>();
+
+            var httpContext = new Mock<HttpContext>();
+            httpContext.SetupGet(c => c.RequestServices)
+                .Returns(CreateServices().AddSingleton(auth.Object).BuildServiceProvider());
+
+            // Act
+            await ((IResult)result).ExecuteAsync(httpContext.Object);
+
+            // Assert
+            auth.Verify(c => c.ChallengeAsync(httpContext.Object, "", null), Times.Exactly(1));
+        }
+
+        [Fact]
+        public async Task ChallengeResult_ExecuteAsync_NoSchemes()
+        {
+            // Arrange
+            var result = new ChallengeResult(new string[] { }, null);
+
+            var auth = new Mock<IAuthenticationService>();
+            var httpContext = new Mock<HttpContext>();
+            httpContext.SetupGet(c => c.RequestServices)
+                .Returns(CreateServices().AddSingleton(auth.Object).BuildServiceProvider());
+
+            // Act
+            await ((IResult)result).ExecuteAsync(httpContext.Object);
+
+            // Assert
+            auth.Verify(c => c.ChallengeAsync(httpContext.Object, null, null), Times.Exactly(1));
+        }
+
         private static IServiceCollection CreateServices()
         {
             var services = new ServiceCollection();
@@ -75,4 +112,4 @@ private static IServiceCollection CreateServices()
             return services;
         }
     }
-}
+}
diff --git a/src/Mvc/Mvc.Core/test/SignInResultTest.cs b/src/Mvc/Mvc.Core/test/SignInResultTest.cs
@@ -100,6 +100,70 @@ public async Task ExecuteResultAsync_InvokesSignInAsyncOnConfiguredScheme()
             auth.Verify();
         }
 
+        [Fact]
+        public async Task ExecuteAsync_InvokesSignInAsyncOnAuthenticationManager()
+        {
+            // Arrange
+            var principal = new ClaimsPrincipal();
+            var httpContext = new Mock<HttpContext>();
+            var auth = new Mock<IAuthenticationService>();
+            auth
+                .Setup(c => c.SignInAsync(httpContext.Object, "", principal, null))
+                .Returns(Task.CompletedTask)
+                .Verifiable();
+            httpContext.Setup(c => c.RequestServices).Returns(CreateServices(auth.Object));
+            var result = new SignInResult("", principal, null);
+
+            // Act
+            await ((IResult)result).ExecuteAsync(httpContext.Object);
+
+            // Assert
+            auth.Verify();
+        }
+
+        [Fact]
+        public async Task ExecuteAsync_InvokesSignInAsyncOnAuthenticationManagerWithDefaultScheme()
+        {
+            // Arrange
+            var principal = new ClaimsPrincipal();
+            var httpContext = new Mock<HttpContext>();
+            var auth = new Mock<IAuthenticationService>();
+            auth
+                .Setup(c => c.SignInAsync(httpContext.Object, null, principal, null))
+                .Returns(Task.CompletedTask)
+                .Verifiable();
+            httpContext.Setup(c => c.RequestServices).Returns(CreateServices(auth.Object));
+            var result = new SignInResult(principal);
+
+            // Act
+            await ((IResult)result).ExecuteAsync(httpContext.Object);
+
+            // Assert
+            auth.Verify();
+        }
+
+        [Fact]
+        public async Task ExecuteAsync_InvokesSignInAsyncOnConfiguredScheme()
+        {
+            // Arrange
+            var principal = new ClaimsPrincipal();
+            var authProperties = new AuthenticationProperties();
+            var httpContext = new Mock<HttpContext>();
+            var auth = new Mock<IAuthenticationService>();
+            auth
+                .Setup(c => c.SignInAsync(httpContext.Object, "Scheme1", principal, authProperties))
+                .Returns(Task.CompletedTask)
+                .Verifiable();
+            httpContext.Setup(c => c.RequestServices).Returns(CreateServices(auth.Object));
+            var result = new SignInResult("Scheme1", principal, authProperties);
+
+            // Act
+            await ((IResult)result).ExecuteAsync(httpContext.Object);
+
+            // Assert
+            auth.Verify();
+        }
+
         private static IServiceProvider CreateServices(IAuthenticationService auth)
         {
             return new ServiceCollection()
diff --git a/src/Mvc/Mvc.Core/test/SignOutResultTest.cs b/src/Mvc/Mvc.Core/test/SignOutResultTest.cs

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using System.Collections.Generic;`
`6`	`6`	`using System.Threading.Tasks;`
`7`	`7`	`using Microsoft.AspNetCore.Authentication;`
	`8`	`+using Microsoft.AspNetCore.Http;`
`8`	`9`	`using Microsoft.Extensions.DependencyInjection;`
`9`	`10`	`using Microsoft.Extensions.Logging;`
`10`	`11`
`@@ -13,7 +14,7 @@ namespace Microsoft.AspNetCore.Mvc`
`13`	`14`	`/// <summary>`
`14`	`15`	`/// An <see cref="ActionResult"/> that on execution invokes <see cref="M:HttpContext.ChallengeAsync"/>.`
`15`	`16`	`/// </summary>`
`16`		`- public class ChallengeResult : ActionResult`
	`17`	`+ public class ChallengeResult : ActionResult, IResult`
`17`	`18`	`{`
`18`	`19`	`/// <summary>`
`19`	`20`	`/// Initializes a new instance of <see cref="ChallengeResult"/>.`
`@@ -90,14 +91,25 @@ public ChallengeResult(IList<string> authenticationSchemes, AuthenticationProper`
`90`	`91`	`public AuthenticationProperties? Properties { get; set; }`
`91`	`92`
`92`	`93`	`/// <inheritdoc />`
`93`		`- public override async Task ExecuteResultAsync(ActionContext context)`
	`94`	`+ public override Task ExecuteResultAsync(ActionContext context)`
`94`	`95`	`{`
`95`	`96`	`if (context == null)`
`96`	`97`	`{`
`97`	`98`	`throw new ArgumentNullException(nameof(context));`
`98`	`99`	`}`
`99`	`100`
`100`		`- var loggerFactory = context.HttpContext.RequestServices.GetRequiredService<ILoggerFactory>();`
	`101`	`+ return ExecuteAsync(context.HttpContext);`
	`102`	`+ }`
	`103`	`+`
	`104`	`+ /// <inheritdoc />`
	`105`	`+ Task IResult.ExecuteAsync(HttpContext httpContext)`
	`106`	`+ {`
	`107`	`+ return ExecuteAsync(httpContext);`
	`108`	`+ }`
	`109`	`+`
	`110`	`+ private async Task ExecuteAsync(HttpContext httpContext)`
	`111`	`+ {`
	`112`	`+ var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();`
`101`	`113`	`var logger = loggerFactory.CreateLogger<ChallengeResult>();`
`102`	`114`
`103`	`115`	`logger.ChallengeResultExecuting(AuthenticationSchemes);`
`@@ -106,12 +118,12 @@ public override async Task ExecuteResultAsync(ActionContext context)`
`106`	`118`	`{`
`107`	`119`	`foreach (var scheme in AuthenticationSchemes)`
`108`	`120`	`{`
`109`		`- await context.HttpContext.ChallengeAsync(scheme, Properties);`
	`121`	`+ await httpContext.ChallengeAsync(scheme, Properties);`
`110`	`122`	`}`
`111`	`123`	`}`
`112`	`124`	`else`
`113`	`125`	`{`
`114`		`- await context.HttpContext.ChallengeAsync(Properties);`
	`126`	`+ await httpContext.ChallengeAsync(Properties);`
`115`	`127`	`}`
`116`	`128`	`}`
`117`	`129`	`}`