嘲笑ASP.NET核心中的IPrincipal

Question

我有一個ASP.NET MVC核心應用程序，我正在編寫單元測試。其中一種操作方法使用用戶名的某些功能：

SettingsViewModel svm = _context.MySettings(User.Identity.Name); 

這明顯在單元測試中失敗。我環顧四周，所有的建議都來自.NET 4.5，以模擬HttpContext。我相信有更好的方法來做到這一點。我試圖注入IPrincipal，但它拋出了一個錯誤;我甚至試過這個（出於絕望，我想）：

public IActionResult Index(IPrincipal principal = null) { 
    IPrincipal user = principal ?? User; 
    SettingsViewModel svm = _context.MySettings(user.Identity.Name); 
    return View(svm); 
} 

但這也拋出了一個錯誤。 在文檔中找不到任何東西...

Answer 1

控制器的User通過控制器的HttpContext訪問。後者存儲在ControllerContext內。

最簡單的方法來替換用戶是通過分配一個不同的HttpContext與一個構造的用戶。我們可以使用DefaultHttpContext爲了這個目的，這樣你就不必嘲笑一切：

var user = new ClaimsPrincipal(new ClaimsIdentity(new Claim[] 
{ 
    new Claim(ClaimTypes.NameIdentifier, "1"), 
    new Claim(MyCustomClaim, "example claim value") 
})); 

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

Answer 2

我想要實現抽象工廠模式。

爲工廠創建專門用於提供用戶名的界面。

然後提供具體的類，其中一個提供User.Identity.Name，另一個提供適用於您的測試的其他硬編碼值。

然後，您可以根據生產與測試代碼使用適當的具體類。也許希望通過工廠作爲參數，或者根據一些配置值切換到正確的工廠。

interface IUserNameFactory 
{ 
    string BuildUserName(); 
} 

class ProductionFactory : IUserNameFactory 
{ 
    public BuildUserName() { return User.Identity.Name; } 
} 

class MockFactory : IUserNameFactory 
{ 
    public BuildUserName() { return "James"; } 
} 

IUserNameFactory factory; 

if(inProductionMode) 
{ 
    factory = new ProductionFactory(); 
} 
else 
{ 
    factory = new MockFactory(); 
} 

SettingsViewModel svm = _context.MySettings(factory.BuildUserName()); 

Answer 3

在以前的版本中，你可以有控制器，這對於一些非常簡單的單元測試取得直接設置User。

如果你看他的源代碼ControllerBase你會注意到User是從HttpContext中提取的。

/// <summary> 
/// Gets or sets the <see cref="ClaimsPrincipal"/> for user associated with the executing action. 
/// </summary> 
public ClaimsPrincipal User 
{ 
    get 
    { 
     return HttpContext?.User; 
    } 
} 

和控制器訪問HttpContext通過ControllerContext

/// <summary> 
/// Gets the <see cref="Http.HttpContext"/> for the executing action. 
/// </summary> 
public HttpContext HttpContext 
{ 
    get 
    { 
     return ControllerContext.HttpContext; 
    } 
} 

你會發現，這兩個是隻讀屬性。好消息是，ControllerContext屬性允許設置它的值，以便您的方式。

因此，目標是獲取該對象。在覈心HttpContext是抽象的，所以它是更容易嘲笑。

假設控制器像

public class MyController : Controller { 
    IMyContext _context; 

    public MyController(IMyContext context) { 
     _context = context; 
    } 

    public IActionResult Index() { 
     SettingsViewModel svm = _context.MySettings(User.Identity.Name); 
     return View(svm); 
    } 

    //...other code removed for brevity 
} 

使用起訂量，測試看起來是這樣的

public void Given_User_Index_Should_Return_ViewResult_With_Model() { 
    //Arrange 
    var username = "FakeUserName"; 
    var identity = new GenericIdentity(username, ""); 

    var mockPrincipal = new Mock<IPrincipal>(); 
    mockPrincipal.Setup(x => x.Identity).Returns(identity); 
    mockPrincipal.Setup(x => x.IsInRole(It.IsAny<string>())).Returns(true); 

    var mockHttpContext = new Mock<HttpContext>(); 
    mockHttpContext.Setup(m => m.User).Returns(mockPrincipal.Object); 

    var model = new SettingsViewModel() { 
     //...other code removed for brevity 
    }; 

    var mockContext = new Mock<IMyContext>(); 
    mockContext.Setup(m => m.MySettings(username)).Returns(model); 

    var controller = new MyController(mockContext.Object) { 
     ControllerContext = new ControllerContext { 
      HttpContext = mockHttpContext.Object 
     } 
    }; 

    //Act 
    var viewResult = controller.Index() as ViewResult; 

    //Assert 
    Assert.IsNotNull(viewResult); 
    Assert.IsNotNull(viewResult.Model); 
    Assert.AreEqual(model, viewResult.Model); 
} 

Answer 4

也有使用現有類的可能性，並在需要時模擬而已。

var user = new Mock<ClaimsPrincipal>(); 
_controller.ControllerContext = new ControllerContext 
{ 
    HttpContext = new DefaultHttpContext 
    { 
     User = user.Object 
    } 
};