根据私有方法测试公共方法的方法

Question

我正在尝试向遗留代码添加测试，当我开始添加代码时，我感觉有些地方出了问题。

在以下代码中，公共方法 RegisterChange 调用了两个私有方法：

1. 获取要存储的对象
2. 存储对象

public class ChangeService {

    IRepository repository;

    public ChangeService(IRepository repository){
        this.repository = repository;
    }

    public bool RegisterChange( int entityId ){ 
        var entity = GetParsedEntity( entityId );       
        SaveEntity( entity );
        return true;
    }

    private Entity GetParsedEntity( int id ) {
        var entity = repository.GetEntityById( id );
        return new Entity{ Name = entity.Name };
    }

    private void SaveEntity( Entity entity ) {
        repository.Save( Entity );
    }
}

public class ChangeServiceFact(){

    [Fact]
    public void When_valid_entity__Should_save_entity(){

        var mock = new Mock<IRepository>();
        var service = new ChangeService(mock.object);

        var result = service.RegisterChange( 0 );

        Assert.True(result);
    }   
}

所以，当我模拟存储库时，我必须去检查私有方法的代码以了解要模拟哪些操作。

我在这种方法中看到的问题是，由于代码不仅测试了测试主体（公共方法）而且还测试了私有方法，所以通过查看测试结果并不清楚哪个应该是测试结果测试对象（公共方法）。

如果稍后有人决定修改一个私有方法（例如从 GetParsedEntity 抛出异常），测试将继续正确通过，但客户端代码可能会因为此更改而失败。

在这种特殊情况下，我使用 C#、XUnit 和 Moq，但我认为这是一个更一般的测试问题。

Answer 1

我在这种方法中看到的问题是，由于代码不仅测试了测试主体（公共方法）而且还测试了私有方法，所以通过查看测试结果并不清楚哪个应该是测试结果测试对象（公共方法）。

您提到的测试对象在不知道其完整合同的情况下没有明显的效果。这里的完整合同是什么？上面提到的公共方法和构造函数，它需要依赖。这里重要的是依赖关系，应该测试与这种依赖关系的交互。私有方法（一如既往）是实现细节 - 与单元测试无关。

话虽如此，让我们回到合同上来。测试对象的实际合同是什么（ChangeService方法）？要根据某个 id 从存储库中检索对象，请创建不同的对象并将后者保存在同一存储库中。这是你的测试。

[Fact]
public void ChangeService_StoresNewEntityInRepository_BasedOnProvidedId()
{
    const string ExpectedName = "some name";
    var otherEntity = new OtherEntity { Name = ExpectedName };
    var mock = new Mock<IRepository>();
    var service = new ChangeService(mock.object);
    mock.Setup(m => m.GetEntityById(0)).Return(otherEntity);

    service.RegisterChange(0);

    mock.Verify(m => m.SaveEntity(It.Is<Entity>(e => e.Name == ExpectedName));
}