如何使用 XUnit 对 Web API controller 进行单元测试

Question

我正在尝试使用 XUnit 在我的 Web API 中对我的 controller 中的方法进行单元测试。 该方法的作用是从数据库中按 ISBN 获取单个标题。 我在单元测试期间遇到的问题是我不确定如何插入我必须执行测试的虚拟数据，以及 Assert function 如何工作。

标题控制器.cs

[ApiController]
[Route("titlecontroller")]
public class TitleController : Controller
{
    private IGtlTitleRepository _gtlTitleRepository;

    public TitleController(IGtlTitleRepository gtlTitleRepository)
    {
        _gtlTitleRepository = gtlTitleRepository;
    }

    [Route("getTitle/{ISBN}")]
    [HttpGet()]
    public GtlTitle GetTitle(string ISBN)    
    {
        return _gtlTitleRepository.GetTitle(ISBN);
    }
}

IGtlTitleRepository.cs

    public interface IGtlTitleRepository
{
    GtlTitle GetTitle(string ISBN);
}

MockGtlTitleRepository.cs

    public class MockGtlTitleRepository : IGtlTitleRepository
{
    private readonly string _connection;
    public MockGtlTitleRepository(IOptions<ConnectionStringList> connectionStrings)
    {
        _connection = connectionStrings.Value.GTLDatabase;
    }


    private List<GtlTitle> _titleList;

    public GtlTitle GetTitle(string ISBN)
    {
        using (var connection = new SqlConnection(_connection))
        {
            connection.Open();
            return connection.QuerySingle<GtlTitle>("GetTitleByISBN", new { ISBN }, commandType: CommandType.StoredProcedure);
        }
    }

}

对，至于我的测试代码，我能够编写以下代码，但正如我上面所说，我无法找到测试该方法的正确方法。

 public class UnitTest1
{
    [Fact]
    public void Test1()
    {

        var repositoryMock = new Mock<IGtlTitleRepository>();
        var title = new GtlTitle();
        repositoryMock.Setup(r => r.GetTitle("978-0-10074-5")).Returns(title);
        var controller = new TitleController(repositoryMock.Object);

        var result = controller.GetTitle("978-0-10074-5");
       // assert??
        repositoryMock.VerifyAll();
    }
}

为了正确测试方法，在这个单元测试中应该做什么？

编辑：

GtlTitle.cs

public class GtlTitle
{
    public string ISBN { get; set; }
    public string VolumeName { get; set; }
    public string TitleDescription { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string PublisherName { get; set; }

}

Answer 1

在进行测试之前，我建议在您的代码中更新一些内容：

• 使您的存储库方法和 controller 操作异步（因此 web 服务器可以在等待先前调用的数据库往返时处理请求）
• 使用ActionResult作为操作返回类型。 这样您就可以向客户端发送不同的 http 状态码。
• 未找到标题时返回 404 NotFound 状态码，而不是返回成功结果，其中null作为有效负载。
• 考虑对 API 端点使用 RESTful 方法。 例如，titles 资源的基本 uri 应该类似于api/titles
• 不要指定getTitle来获取标题端点，因为您知道 HTTP 动词哪个端点映射到 (GET) 和基本资源 url (api/titles)。

应用这些注释：

[ApiController]
[Route("api/titles")]
public class TitleController : Controller
{
    private IGtlTitleRepository _gtlTitleRepository;

    public TitleController(IGtlTitleRepository gtlTitleRepository)
    {
        _gtlTitleRepository = gtlTitleRepository;
    }

    [HttpGet("{ISBN}")] // GET api/titles/{ISBN}
    public async Task<ActionResult<GtlTitle>> GetTitle(string ISBN)    
    {
        var title = await _gtlTitleRepository.GetTitle(ISBN);
        if (title == null)
            return NotFound();

        return title;
    }
}

测试成功的标题检索：

[Fact]
public async Task Should_Return_Title_When_Title_Found()
{
    var repositoryMock = new Mock<IGtlTitleRepository>();
    var title = new GtlTitle();
    repositoryMock.Setup(r => r.Get("978-0-10074-5")).Returns(Task.FromResult(title));

    var controller = new TitleController(repositoryMock.Object);

    var result = await controller.GetTitle("978-0-10074-5");
    Assert.Equal(title, result.Value);
}

找不到标题时：

[Fact]
public async Task Should_Return_404_When_Title_Not_Found()
{
    var repositoryMock = new Mock<IGtlTitleRepository>();
    repositoryMock.Setup(r => r.Get("978-0-10074-5")).Returns(Task.FromResult<GtlTitle>(null));

    var controller = new TitleController(repositoryMock.Object);

    var result = await controller.GetTitle("978-0-10074-5");
    Assert.IsType<NotFoundResult>(result.Result);
}