如何模拟 owin 的 authorizationManager 来测试我的 api 控制器
How to mock owin's authorizationManager to test my api controller
我在我的 WebApi 中使用 ThinkTecture's resource based authorization。
我正在尝试测试我需要检查功能内部访问的控制器之一。但是现在,我不能再测试这个函数了,因为我不能模拟扩展方法,因为它是一个 nuget 方法,我不能修改 class 来注入另一个值。
我的控制器是这样的:
public class AlbumController : ApiController
{
public async Task<IHttpActionResult> Get(int id)
{
if (!(await Request.CheckAccessAsync(ChinookResources.AlbumActions.View,
ChinookResources.Album,
id.ToString())))
{
return this.AccessDenied();
}
return Ok();
}
}
并且 ResourceAuthorizationManager 像这样设置到启动中:
app.UseResourceAuthorization(new ChinookAuthorization());
ThinkTecture 项目的源代码是here。
感谢您的帮助
您总是可以将此静态调用包装到您的一些抽象中:
public interface IAuthorizationService
{
Task<bool> CheckAccessAsync(string view, string album, string id);
}
然后有一些实现将调用委托给静态扩展方法。但是现在,由于您将使用 IAuthorizationService
,您可以在单元测试中自由模拟 CheckAccessAsync
方法。
就测试此抽象的实现而言,您可能不需要它,因为它仅充当通向 ThinkTecture 类 的桥梁,后者应该已经过很好的测试。
我终于解决了我的问题。
真正的问题是 CheckAccess 方法是一个扩展。
(对于我的回答,每个 class 将引用可以找到的示例 here)
为了停止使用扩展方法,我将这些方法添加到我的 chinookAuthorization
public Task<bool> CheckAccessAsync(ClaimsPrincipal user, string action, params string[] resources)
{
var ctx = new ResourceAuthorizationContext(user ?? Principal.Anonymous, action, resources);
return CheckAccessAsync(ctx);
}
public Task<bool> CheckAccessAsync(ClaimsPrincipal user, IEnumerable<Claim> actions, IEnumerable<Claim> resources)
{
var authorizationContext = new ResourceAuthorizationContext(
user ?? Principal.Anonymous,
actions,
resources);
return CheckAccessAsync(authorizationContext);
}
然后我将我的控制器更改为具有 chinookAuthorization 实例
public class AlbumController : ApiController
{
protected readonly chinookAuthorization chinookAuth;
public BaseApiController(chinookAuthorization chinookAuth)
{
if (chinookAuth == null)
throw new ArgumentNullException("chinookAuth");
this.chinookAuth = chinookAuth;
}
public async Task<IHttpActionResult> Get(int id)
{
if (!(await chinookAuth.CheckAccessAsync((ClaimsPrincipal)RequestContext.Principal, ChinookResources.AlbumActions.View,
ChinookResources.Album,
id.ToString())))
{
return this.AccessDenied();
}
return Ok();
}
}
我仍在向我的 owin 启动声明我的 ChinookAuthorization,以继续对我的属性检查访问调用使用相同的模式。
所以现在,我只需要模拟 chinookAuthorization,模拟对 return true 的调用的响应,就是这样!
ResourceAuthorizationAttribute 使用 Reqest.CheckAccess 所以我认为抽象实现然后将其注入控制器不是一个好的解决方案,因为理论上 ResourceAuthorizationAttribute 和创建的服务可以使用不同的实现CheckAccess 方法。
我通过创建一个 BaseController 采用了一种更简单的方法
public class BaseController : ApiController
{
public virtual Task<bool> CheckAccessAsync(string action, params string[] resources)
{
return Request.CheckAccessAsync(action, resources);
}
}
并使 CheckAccessAsync 成为虚拟的,这样我就可以模拟它(例如通过 Moq)。
然后从我的控制器
public class AlbumController : BaseController
{
public async Task<IHttpActionResult> Get(int id)
{
if (!(await CheckAccessAsync(ChinookResources.AlbumActions.View,
ChinookResources.Album,
id.ToString())))
{
return this.AccessDenied();
}
return Ok();
}
}
然后对控制器进行单元测试非常简单:
[TestClass]
public class TestClass
{
Mock<AlbumController> mockedTarget
AlbumController target
[TestInitialize]
public void Init()
{
mockedTarget = new Mock<AlbumController>();
target = mockedTarget.Object;
}
[Test]
public void Test()
{
mockedTarget.Setup(x => x.CheckAccessAsync(It.IsAny<string>(),
It.IsAny<string[]>()))
.Returns(Task.FromResult(true));
var result = target.Get(1);
// Assert
}
}
我在我的 WebApi 中使用 ThinkTecture's resource based authorization。
我正在尝试测试我需要检查功能内部访问的控制器之一。但是现在,我不能再测试这个函数了,因为我不能模拟扩展方法,因为它是一个 nuget 方法,我不能修改 class 来注入另一个值。
我的控制器是这样的:
public class AlbumController : ApiController
{
public async Task<IHttpActionResult> Get(int id)
{
if (!(await Request.CheckAccessAsync(ChinookResources.AlbumActions.View,
ChinookResources.Album,
id.ToString())))
{
return this.AccessDenied();
}
return Ok();
}
}
并且 ResourceAuthorizationManager 像这样设置到启动中:
app.UseResourceAuthorization(new ChinookAuthorization());
ThinkTecture 项目的源代码是here。
感谢您的帮助
您总是可以将此静态调用包装到您的一些抽象中:
public interface IAuthorizationService
{
Task<bool> CheckAccessAsync(string view, string album, string id);
}
然后有一些实现将调用委托给静态扩展方法。但是现在,由于您将使用 IAuthorizationService
,您可以在单元测试中自由模拟 CheckAccessAsync
方法。
就测试此抽象的实现而言,您可能不需要它,因为它仅充当通向 ThinkTecture 类 的桥梁,后者应该已经过很好的测试。
我终于解决了我的问题。 真正的问题是 CheckAccess 方法是一个扩展。 (对于我的回答,每个 class 将引用可以找到的示例 here)
为了停止使用扩展方法,我将这些方法添加到我的 chinookAuthorization
public Task<bool> CheckAccessAsync(ClaimsPrincipal user, string action, params string[] resources)
{
var ctx = new ResourceAuthorizationContext(user ?? Principal.Anonymous, action, resources);
return CheckAccessAsync(ctx);
}
public Task<bool> CheckAccessAsync(ClaimsPrincipal user, IEnumerable<Claim> actions, IEnumerable<Claim> resources)
{
var authorizationContext = new ResourceAuthorizationContext(
user ?? Principal.Anonymous,
actions,
resources);
return CheckAccessAsync(authorizationContext);
}
然后我将我的控制器更改为具有 chinookAuthorization 实例
public class AlbumController : ApiController
{
protected readonly chinookAuthorization chinookAuth;
public BaseApiController(chinookAuthorization chinookAuth)
{
if (chinookAuth == null)
throw new ArgumentNullException("chinookAuth");
this.chinookAuth = chinookAuth;
}
public async Task<IHttpActionResult> Get(int id)
{
if (!(await chinookAuth.CheckAccessAsync((ClaimsPrincipal)RequestContext.Principal, ChinookResources.AlbumActions.View,
ChinookResources.Album,
id.ToString())))
{
return this.AccessDenied();
}
return Ok();
}
}
我仍在向我的 owin 启动声明我的 ChinookAuthorization,以继续对我的属性检查访问调用使用相同的模式。
所以现在,我只需要模拟 chinookAuthorization,模拟对 return true 的调用的响应,就是这样!
ResourceAuthorizationAttribute 使用 Reqest.CheckAccess 所以我认为抽象实现然后将其注入控制器不是一个好的解决方案,因为理论上 ResourceAuthorizationAttribute 和创建的服务可以使用不同的实现CheckAccess 方法。
我通过创建一个 BaseController 采用了一种更简单的方法
public class BaseController : ApiController
{
public virtual Task<bool> CheckAccessAsync(string action, params string[] resources)
{
return Request.CheckAccessAsync(action, resources);
}
}
并使 CheckAccessAsync 成为虚拟的,这样我就可以模拟它(例如通过 Moq)。
然后从我的控制器
public class AlbumController : BaseController
{
public async Task<IHttpActionResult> Get(int id)
{
if (!(await CheckAccessAsync(ChinookResources.AlbumActions.View,
ChinookResources.Album,
id.ToString())))
{
return this.AccessDenied();
}
return Ok();
}
}
然后对控制器进行单元测试非常简单:
[TestClass]
public class TestClass
{
Mock<AlbumController> mockedTarget
AlbumController target
[TestInitialize]
public void Init()
{
mockedTarget = new Mock<AlbumController>();
target = mockedTarget.Object;
}
[Test]
public void Test()
{
mockedTarget.Setup(x => x.CheckAccessAsync(It.IsAny<string>(),
It.IsAny<string[]>()))
.Returns(Task.FromResult(true));
var result = target.Get(1);
// Assert
}
}