Mocking IPrincipal in ASP.NET Core

by

The controller’s User is accessed through the HttpContext of the controller. The latter is stored within the ControllerContext.

The easiest way to set the user is by assigning a different HttpContext with a constructed user. We can use DefaultHttpContext for this purpose, that way we don’t have to mock everything. Then we just use that HttpContext within a controller context and pass that to the controller instance:

var user = new ClaimsPrincipal(new ClaimsIdentity(new Claim[]
{
    new Claim(ClaimTypes.Name, "example name"),
    new Claim(ClaimTypes.NameIdentifier, "1"),
    new Claim("custom-claim", "example claim value"),
}, "mock"));

var controller = new SomeController(dependencies…);
controller.ControllerContext = new ControllerContext()
{
    HttpContext = new DefaultHttpContext() { User = user }
};

When creating your own ClaimsIdentity, make sure to pass an explicit authenticationType to the constructor. This makes sure that IsAuthenticated will work correctly (in case you use that in your code to determine whether a user is authenticated).

More Related Contents:

  1. Pass complex parameters to [Theory]
  2. Execute unit tests serially (rather than in parallel)
  3. How do you unit test ASP.NET Core MVC Controllers that return anonymous objects?
  4. Recommended unit testing tool to test web services, api calls and sql calls [closed]
  5. How do I generate a stream from a string?
  6. Resolving instances with ASP.NET Core DI from within ConfigureServices
  7. Unit Testing: DateTime.Now
  8. ASP.NET Core Dependency Injection error: Unable to resolve service for type while attempting to activate
  9. How do I get client IP address in ASP.NET Core?
  10. Mocking HttpClient in unit tests
  11. Use multiple JWT Bearer Authentication
  12. How to get a list of all routes in ASP.NET Core?
  13. Can a unit test project load the target application’s app.config file?
  14. Controlling execution order of unit tests in Visual Studio
  15. Why am I getting an Exception with the message “Invalid setup on a non-virtual (overridable in VB) member…”?
  16. How do you test private methods with NUnit?
  17. How to add IHttpContextAccessor in the Startup class in the DI in ASP.NET Core 1.0?
  18. ASP.NET Core v2 (2015) MVC : How to get raw JSON bound to a string without a type?
  19. Async provider in .NET Core DI
  20. ASP.NET Core Get Json Array using IConfiguration
  21. Integration test and hosting ASP.NET Core 6.0 without Startup class
  22. NSubstitute – Testing for a specific linq expression
  23. MSTest cannot find the assembly
  24. ASP.Net Core MVC – Client-side validation for custom attribute
  25. Include ONLY .xml file of SPECIFIC nuget package in a different folder
  26. How can I get “Copy to Output Directory” to work with Unit Tests?
  27. Injection of IUrlHelper in ASP.NET Core
  28. Unit testing with EF Core and in memory database
  29. Unit testing HTTP requests in c#
  30. Mocking using Moq in c#

Leave a Comment