如何避免添加 getter 以促进单元测试？

Question

在阅读了 blog post 提到为了方便测试而公开一个公共 getter 似乎是错误的之后，我找不到任何更好实践的具体示例。

假设我们有这个简单的例子：

public class ProductNameList
{
    private IList<string> _products;
    public void AddProductName(string productName)
    {
        _products.Add(productName);
    }
}

假设出于面向对象设计的原因，我没有必要公开公开产品列表。那么我如何测试 AddProductName() 是否完成了它的工作？ （也许它添加了两次产品，或者根本没有。）

一种解决方案是公开 _products 的只读版本，我可以在其中测试它是否只有一个产品名称——我传递给 AddProductName() 的那个。

我之前提到的博客文章说它更多的是关于交互（即是否添加了产品名称）而不是状态。但是，state 正是我正在检查的内容。我已经知道 AddProductName() 已被调用——我想在该方法完成工作后测试对象的状态是否正确。

免责声明：虽然这个问题类似于 Balancing Design Principles: Unit Testing，(1) 语言不同（C# 而不是 Java），(2) 这个问题有示例代码，以及 (3) 我觉得这个问题没有得到充分的回答（即，代码将有助于演示概念）。

Answer 1

单元测试应该测试公共 API。

如果你“无需公开产品清单”，那你又何必关心AddProductName 是否完成了它的工作呢？如果该列表完全是私有的并且永远不会影响其他任何东西，它会产生什么影响？

找出影响 AddProductName 对可以使用 API 检测到的状态有什么影响，并对其进行测试。

这里有非常相似的问题：Domain Model (Exposing Public Properties)

Answer 2

您可以保护您的访问器，以便您可以模拟，或者您可以使用 internal 以便您可以在测试中访问该属性，但正如您所建议的那样，IMO 将是错误的。

我认为有时我们会非常想确保我们代码中的每一个小东西都经过测试。有时我们需要退后一步，问我们为什么要存储这个值，它的目的是什么？然后，我们可以开始测试组件的行为是否正确，而不是测试该值是否已设置。

编辑

你可以在你的场景中做的一件事是有一个混蛋构造函数，你可以在其中注入一个 IList，然后测试你是否添加了一个产品：

public class ProductNameList
{
    private IList<string> _products;

    internal ProductNameList(IList<string> products)
    {
        _products = products;
    }
    ...
}

然后你会像这样测试它：

[Test]
public void FooTest()
{
    var productList = new List<string>();

    var productNameList = new ProductNameList(productList);

    productNameList.AddProductName("Foo");

    Assert.IsTrue(productList[0] == "Foo");
}

您需要记住让内部组件对您的测试程序集可见。

Answer 3

使用_products protected 而不是private。在你的模拟中，你可以添加一个访问器。

Answer 4

要测试 AddProductName() 是否有效，而不是为 _ProductNames 使用公共 getter，而是调用 GetProductNames() - 或 API 中定义的等效项。这样的函数不一定在同一个类中。

现在，如果您的 API 没有公开任何获取产品名称信息的方法，那么 AddProductName() 就没有可观察到的副作用（在这种情况下，它是一个毫无意义的函数）。

如果 AddProductName() 确实有副作用，但它们是间接的 - 比如说，ProductList 中的一个将产品名称列表写入文件的方法，那么 ProductList 应该分为两个类 - 一个管理列表，另一个另一个调用它的是 Add and Get API，并执行副作用。