.NET Core 如何对服务进行单元测试？

Question

我已经构建了一个 WebAPI，并希望创建一个单元测试项目来自动测试我的服务。

我的 WebAPI 的流程很简单：

控制器（DI 服务）-> 服务（DI 存储库）-> _repo CRUD

假设我有这样的服务：

public int Cancel(string id) //change status filed to 'n'
{
    var item = _repo.Find(id);
    item.status = "n";
    _repo.Update(item);
    return _repo.SaveChanges();
}

我想构建一个单元测试，它只使用 InMemoryDatabase。

public void Cancel_StatusShouldBeN() //Testing Cancel() method of a service
{
    _service.Insert(item); 

    int rs = _service.Cancel(item.Id);
    Assert.Equal(1, rs);

    item = _service.GetByid(item.Id);
    Assert.Equal("n", item.status);
}

我搜索了其他相关问题，发现

您不能在测试类上使用依赖注入。

我只是想知道是否有其他解决方案可以实现我的单元测试想法？

Answer 1

在进行单元测试时，您应该明确提供您正在测试的类的所有依赖项。 即依赖注入；不是让服务自己构建它的依赖关系，而是让它依赖外部组件来提供它们。当您在依赖注入容器之外并且在您手动创建您正在测试的类的单元测试中时，提供依赖关系是您的责任。

实际上，这意味着您可以向构造函数提供模拟对象或实际对象。例如，您可能希望提供一个没有目标的真实记录器、一个带有连接内存数据库的真实数据库上下文或一些模拟服务。

让我们假设这个例子，你正在测试的服务看起来像这样：

public class ExampleService
{
    public ExampleService(ILogger<ExampleService> logger,
        MyDbContext databaseContext,
        UtilityService utilityService)
    {
        // …
    }
    // …
}

所以为了测试ExampleService，我们需要提供这三个对象。在这种情况下，我们将为每个执行以下操作：

• ILogger<ExampleService>——我们将使用一个真正的记录器，没有任何附加的目标。因此，对记录器的任何调用都可以正常工作，而无需我们提供一些模拟，但我们不需要测试日志输出，因此我们不需要真正的目标
• MyDbContext – 在这里，我们将使用带有附加内存数据库的真实数据库上下文
• UtilityService – 为此，我们将创建一个模拟，它只是在我们要测试的方法中设置我们需要的实用方法。

所以单元测试可能如下所示：

[Fact]
public async Task TestExampleMethod()
{
    var logger = new LoggerFactory().CreateLogger<ExampleService>();
    var dbOptionsBuilder = new DbContextOptionsBuilder().UseInMemoryDatabase();

    // using Moq as the mocking library
    var utilityServiceMock = new Mock<UtilityService>();
    utilityServiceMock.Setup(u => u.GetRandomNumber()).Returns(4);

    // arrange
    using (var db = new MyDbContext(dbOptionsBuilder.Options))
    {
        // fix up some data
        db.Set<Customer>().Add(new Customer()
        {
            Id = 2,
            Name = "Foo bar"
        });
        await db.SaveChangesAsync();
    }

    using (var db = new MyDbContext(dbOptionsBuilder.Options))
    {
        // create the service
        var service = new ExampleService(logger, db, utilityServiceMock.Object);

        // act
        var result = service.DoSomethingWithCustomer(2);

        // assert
        Assert.NotNull(result);
        Assert.Equal(2, result.CustomerId);
        Assert.Equal("Foo bar", result.CustomerName);
        Assert.Equal(4, result.SomeRandomNumber);
    }
}

在您特定的Cancel 情况下，您希望避免使用您当前未测试的服务的任何方法。所以如果你想测试Cancel，你应该从你的服务调用的唯一方法是Cancel。测试可能如下所示（只是在这里猜测依赖关系）：

[Fact]
public async Task Cancel_StatusShouldBeN()
{
    var logger = new LoggerFactory().CreateLogger<ExampleService>();
    var dbOptionsBuilder = new DbContextOptionsBuilder().UseInMemoryDatabase();

    // arrange
    using (var db = new MyDbContext(dbOptionsBuilder.Options))
    {
        // fix up some data
        db.Set<SomeItem>().Add(new SomeItem()
        {
            Id = 5,
            Status = "Not N"
        });
        await db.SaveChangesAsync();
    }

    using (var db = new MyDbContext(dbOptionsBuilder.Options))
    {
        // create the service
        var service = new YourService(logger, db);

        // act
        var result = service.Cancel(5);

        // assert
        Assert.Equal(1, result);
    }

    using (var db = new MyDbContext(dbOptionsBuilder.Options))
    {
        var item = db.Set<SomeItem>().Find(5);
        Assert.Equal(5, item.Id);
        Assert.Equal("n", item.Status);
    }
}

顺便说一句。请注意，我一直在打开一个新的数据库上下文，以避免从缓存的实体中获取结果。通过打开一个新的上下文，我可以验证这些更改实际上是否已完全进入数据库。