[英]How to Unit Test with ActionResult<T>?
我有一个 xUnit 测试,如:
[Fact]
public async void GetLocationsCountAsync_WhenCalled_ReturnsLocationsCount()
{
_locationsService.Setup(s => s.GetLocationsCountAsync("123")).ReturnsAsync(10);
var controller = new LocationsController(_locationsService.Object, null)
{
ControllerContext = { HttpContext = SetupHttpContext().Object }
};
var actionResult = await controller.GetLocationsCountAsync();
actionResult.Value.Should().Be(10);
VerifyAll();
}
来源是
/// <summary>
/// Get the current number of locations for a user.
/// </summary>
/// <returns>A <see cref="int"></see>.</returns>
/// <response code="200">The current number of locations.</response>
[HttpGet]
[Route("count")]
public async Task<ActionResult<int>> GetLocationsCountAsync()
{
return Ok(await _locations.GetLocationsCountAsync(User.APropertyOfTheUser()));
}
结果的值为空,导致我的测试失败,但如果您查看ActionResult.Result.Value
(一个内部属性),它包含预期的解析值。
如何在单元测试中填充 actionResult.Value?
在运行时,由于隐式转换,您的原始测试代码仍然可以工作。
但是根据提供的调试器图像,测试似乎对结果的错误属性进行了断言。
因此,虽然更改被测方法允许测试通过,但无论哪种方式都可以实时运行
ActioResult<TValue>
有两个属性,根据使用它的操作返回的内容进行设置。
/// <summary>
/// Gets the <see cref="ActionResult"/>.
/// </summary>
public ActionResult Result { get; }
/// <summary>
/// Gets the value.
/// </summary>
public TValue Value { get; }
因此,当控制器操作使用Ok()
返回时,它将通过隐式转换设置操作结果的ActionResult<int>.Result
属性。
public static implicit operator ActionResult<TValue>(ActionResult result)
{
return new ActionResult<TValue>(result);
}
但是测试断言了Value
属性(参考 OP 中的图像),在这种情况下没有设置。
无需修改被测代码以满足测试,它可以访问Result
属性并对该值进行断言
[Fact]
public async Task GetLocationsCountAsync_WhenCalled_ReturnsLocationsCount() {
//Arrange
_locationsService
.Setup(_ => _.GetLocationsCountAsync(It.IsAny<string>()))
.ReturnsAsync(10);
var controller = new LocationsController(_locationsService.Object, null) {
ControllerContext = { HttpContext = SetupHttpContext().Object }
};
//Act
var actionResult = await controller.GetLocationsCountAsync();
//Assert
var result = actionResult.Result as OkObjectResult;
result.Should().NotBeNull();
result.Value.Should().Be(10);
VerifyAll();
}
问题是将它包装在Ok
。 如果您返回对象本身,则Value
会正确填充。
如果您查看docs中的Microsoft 示例,它们仅将控制器方法用于非默认响应,例如NotFound
:
[HttpGet("{id}")]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public ActionResult<Product> GetById(int id)
{
if (!_repository.TryGetProduct(id, out var product))
{
return NotFound();
}
return product;
}
问题在于ActionResult<T>
的令人困惑的接口,它从未被设计为供我们人类使用。 正如其他答案中所述, ActionResult<T>
设置了其Result
或Value
属性,但不能同时设置两者。 当您返回OkObjectResult
,框架会填充Result
属性。 当您返回一个对象时,框架会填充Value
属性。
我为我的测试库创建了以下简单的帮助程序,以帮助我在使用OkObjectResult Ok()
或从ObjectResult
继承的其他结果时测试返回值
private static T GetObjectResultContent<T>(ActionResult<T> result)
{
return (T) ((ObjectResult) result.Result).Value;
}
这让我可以执行以下操作:
var actionResult = await controller.Get("foobar");
Assert.IsType<OkObjectResult>(actionResult.Result);
var resultObject = GetObjectResultContent<ObjectType>(actionResult);
Assert.Equal("foobar", resultObject.Id);
作为@Nkosi 和@Otto Teinonen 提供的答案的延续,有一个隐式操作符可以转换为/从Value/Result
此外, ActionResult<TValue>
实现接口IConvertToActionResult
public sealed class ActionResult<TValue> : IConvertToActionResult
并提供基于空值处理Result
和Value
的Convert
方法,查看源并返回非空值。 设置了Result
或Value
。
如果 Controler 没有返回Ok(value)
,则使用OkObjectResult
可能会返回 null 并导致测试失败,例如:
var result = actionResult.Result as OkObjectResult; //may be null
下一个扩展方法处理 Result 和 Value 并返回类型化对象 T
public static T GetObjectResult<T>(this ActionResult<T> result)
{
if (result.Result != null)
return (T)((ObjectResult)result.Result).Value;
return result.Value;
}
测试用例
[Test]
public async Task Test()
{
var controller = new ProductsController(Repo);
var result = await controller.GetProduct(1);
await Repo.Received().GetProduct(1);
//result.Result.Should().BeOfType<OkObjectResult>(); // may fail if controller didn't return Ok(value)
result.GetObjectResult().ProductId.Should().Equals(1);
}
另一种方法是序列化然后在 json 类型中脱盐:
[Fact]
public void Test1()
{
var controller = new ProductController();
var result = controller.Products();
var okResult = Assert.IsType<OkObjectResult>(result);
if (okResult.Value == null) return;
var json = JsonConvert.SerializeObject(okResult.Value);
var values = JsonConvert.DeserializeObject<Product>(json);
if (values != null) Assert.Equal(1, values.Id);
}
private class Product
{
public int Id { get; set; }
public string Name { get; set; }
}
[Route("api/product")]
[ApiController]
public class ProductController : ControllerBase
{
[HttpGet]
public IActionResult Products() => Ok(new { Id = 1, Name = "Smartphone" });
}
基于其他答案,我认为这就是你想要的......
var actionResult = await controller.GetLocationsCountAsync();
var okResult = Assert.IsType<OkObjectResult>(actionResult.Result);
var value = Assert.IsType<int>(okResult.Value);
Assert.Equal(10, value);
所需的.Value
在OkObjectResult
我的返回类型是IEnumerable<MyClass>
所以我使用了:
var values = Assert.IsAssignableFrom<IEnumerable<MyClass>>(okResult.Value);
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.