使用 MOQ 测试存储库

Question

我正在尝试使用 MOQ 来测试存储库以模拟存储库的行为。我是 MOQ 的新手，所以请多多包涵。

给定以下方法：

public static SubmissionVersion DeleteNote(IRepository repository, SubmissionVersion version, Guid noteId)
{
    Note note = repository.GetById<Note>(noteId);
    version.Notes.Remove(note);
    repository.Save(version);
    repository.Delete(note);
    return repository.GetById<SubmissionVersion>(version.Id);
}

这个测试看起来好吗？

[Fact]
public void DeleteNoteV2()
{
    // Arrange
    var note = new Note{ Id = Guid.NewGuid()};

    var subVersion = new Mock<SubmissionVersion>();
    subVersion.Setup(x => x.Notes.Remove(note));

    var repo = new Mock<IRepository>();
    repo.Setup(x => x.GetById<Note>(note.Id)).Returns(note);
    repo.Setup(x => x.GetById<SubmissionVersion>(It.IsAny<Guid?>())).Returns(subVersion.Object);

    // Act
    SubmissionVersion.DeleteNote(repo.Object, subVersion.Object, note.Id.Value);

    // Assert
    repo.Verify(x => x.GetById<Note>(note.Id), Times.Once());
    repo.Verify(x => x.Save(subVersion.Object), Times.Once());
    repo.Verify(x => x.Delete(note), Times.Once());

    subVersion.Verify(x => x.Notes.Remove(It.IsAny<Note>()), Times.Once());
}

Answer 1

你的方法很好，但是我会调整一些东西。我对您的测试和模拟组件进行了一些更改，您可以在下面看到。

单元测试

您在单元测试中测试的方法（见下文）与您在问题中定义的方法并不真正匹配。

单元测试方法调用：

SubmissionVersion.DeleteNote(repo.Object, subVersion.Object, note.Id.Value);

待测方法：

public static SubmissionVersion DeleteNote
  (IRepository repository, SubmissionVersion version, Guid noteId)

我假设上述方法是另一个类的一部分，我将其称为 NotesHelper - 这不是存储库调用的理想名称，但它只是为了让编译工作。

我会亲自将您的单元测试分成 2 个单独的单元测试。一是验证是否调用了所需的方法，二是验证笔记是否已从集合中删除。

另外，我没有创建一个模拟的 SubmissionVersion，而是创建了一个 fakeSubmissionVersion。 这是因为 SubmissionVersion 中的例程可能不可模拟。您还可以进行基于状态的测试（首选）以确保 version.Notes.Remove(note);已被调用。

[Fact]
public void DeleteNote_Deletion_VerifyExpectedMethodsInvokecOnlyOnce()
{
    // Arrange
    var note = new Note { Id = Guid.NewGuid() };
    var fakeSubmissionVersion = new SubmissionVersion() { Notes = new List<Note>() };
    var repo = new Mock<IRepository>();
    repo.Setup(x => x.GetById<Note>(It.IsAny<Guid>())).Returns(note);

    // Act
    NotesHelper.DeleteNote(repo.Object, fakeSubmissionVersion, note.Id.Value);

    // Assert
    repo.Verify(x => x.GetById<Note>(note.Id), Times.Once());
    repo.Verify(x => x.Save(fakeSubmissionVersion), Times.Once());
    repo.Verify(x => x.Delete(note), Times.Once());
}

可以通过在自己的测试中定义每个验证来进一步改进上述测试。

[Fact]
public void DeleteNote_Deletion_VerifyDeleteMethodCalledOnlyOnce()

这样，如果一个测试失败，我们将准确地知道哪个方法没有被期望调用。有时，如上所述进行多次验证可能会出现问题。例如，如果尚未调用 Save 方法，您将永远不会知道 Delete 方法是否已被调用。这是因为在Save方法没有被调用并且测试执行已经终止的时候抛出了异常。

这将导致多次测试，但它们更具可读性和可维护性。当然你可以将通用代码重构为工厂或辅助方法。

[Fact]
public void DeleteNote_RemoveNotes_ReturnsExpectedNotes()
{
    // Arrange
    var note = new Note { Id = Guid.NewGuid() };
    var fakeSubmissionVersion = new SubmissionVersion() { Notes = new List<Note>() { note } };
    var repo = new Mock<IRepository>();
    repo.Setup(x => x.GetById<Note>(It.IsAny<Guid>())).Returns(note);

    // Act
    NotesHelper.DeleteNote(repo.Object, fakeSubmissionVersion, note.Id.Value);

    // Assert
    Assert.AreEqual(0, fakeSubmissionVersion.Notes.Count);
}

附加说明：还提供描述性单元测试方法名称可提高单元测试的可读性。