如何在 Visual Studio 中为 Web API 编写测试代码？

Question

我对测试项目有点陌生。我目前有一个包含 Get、Put、Post 和 Delete 方法的 web api 项目。当谈到编写测试用例时，我很困惑。我应该编写测试代码来测试 Http URL 吗？

我的 web api 代码：

    // GET api/values/5
    [HttpGet("{id}")]
    public IActionResult Get(string id)
    {
        using (var unitOfWork = new UnitOfWork(_db))
        {
            var r = unitOfWork.Resources.Get(id);

            unitOfWork.Complete();

            Models.resource result = ConvertResourceFromCoreToApi(r);

            if (result == null)
            {
                return NotFound();
            }
            else
            {
                return Ok(result);
            }
        }
    }

在我的测试项目中，我有点卡在这里。我们正在使用 Xunit。如何编写测试代码来测试 Get 方法？或者我应该编写代码来测试 URL api/values/5，但是如何？

    [Fact]
    public void GetTest()
    {
        using (var unitOfWork = new UnitOfWork(new MockDatabase()))
        {

        }
    }

任何帮助将不胜感激。

Answer 1

在真正对控制器进行单元测试之前，您需要进行一些更改。您需要在其构造函数中将 UnitOfWork 类的实例传递给控制器​​。那么你的控制器方法代码就变成了：

// GET api/values/5
[HttpGet("{id}")]
public IActionResult Get(string id)
{    
    var r = unitOfWork.Resources.Get(id);

    unitOfWork.Complete();

    Models.resource result = ConvertResourceFromCoreToApi(r);

    if (result == null)
    {
        return NotFound();
    }
    else
    {
        return Ok(result);
    }

然后在你的单元测试中你这样做：

[Fact]
public void GetTest()
{
    // Arrange
    // You really want to mock your unit of work so you can determine
    // what you are going to send back
    var unitOfWork = new MockUnitOfWork();
    var systemUnderTest = new Controller(unitOfWork);
    system.Request = new HttpRequestMessage();

    // Act
    var result = systemUnderTest.Get(1);

    // Assert
    // Here you need to verify that you got back the expected result
}

将 UnitOfWork 类注入控制器可能是另一个问题。 Mark Seemann 在这个主题上有一个出色的post，但它可能有点先进。有许多不同的方法可以用更简单的方法来实现这一点（但可能没有那么健壮的方法）。谷歌是你的朋友。但是，如果您有任何问题，请发布另一个问题。

希望对您有所帮助。

Answer 2

您需要对控制器进行一些设计更改以使其易于测试。在您的操作中，您正在创建一个实例，这将使使用对控制器的虚假依赖项进行测试变得困难。此外，您的控制器应该依赖于抽象而不是具体化，这将使控制器更具可测试性。

public class MyWebApiController : ApiController {
    private IUnitOfWork unitOfWork;

    public MyWebApiController(IUnitOfWork unitOfWork) {
       this.unitOfWork = unitOfWork;
    }

    // GET api/values/5
    [HttpGet("{id}")]
    public IActionResult Get(string id) {        
        var r = unitOfWork.Resources.Get(id);

        unitOfWork.Complete();

        Models.resource result = ConvertResourceFromCoreToApi(r);

        if (result == null) {
            return NotFound();
        } else {
            return Ok(result);
        }        
    }

    //...other code
}

注意控制器使用依赖注入来注入IUnitOfWork。这使得控制器更具可测试性，因为您可以在单元测试时注入其依赖项的模拟。

从那里创建控制器实例并使用依赖项的模拟调用被测方法。

[Fact]
public void GetTest() {
    //Arrange (Setup the parts needed to run test)
    var unitOfWork = new MockUnitOfWork(new MockDatabase());

    //Or using your mocking framework of choice
    //var unitOfWork = Mock.Of<IUnitOfWork>(); //this is using Moq

    var controller = new MyWebApiController(unitOfWork);
    var id = "Test Id value here";

    //Act (call the method under test)
    var result - controller.Get(id);

    //Assert (check results)
    //...Do your assertion pertaining to result of calling method under test
}

参考：Unit Testing Controllers in ASP.NET Web API 2