如何正确进行单元测试

Question

我正在尝试使用测试驱动设计方法编写一个应用程序 - 我对单元测试相当陌生，所以我只是想知道测试正确输入和异常的正确方法是什么。

我有一个用于加载配置文件的类：

class Config
{
    private XmlDocument configfile;

    public Config()
    {
        configfile = new XmlDocument();
    }

    public void LoadConfigFile(string filename)
    {
        if(string.IsNullOrEmpty(filename)) 
            throw new System.ArgumentException("You must specify a filename");

        try
        {
            configfile.Load(filename);
        }
        catch (Exception ex)
        {
            throw new System.IO.FileNotFoundException("File could not be loaded");
        }
    }
}

因此，这里可以执行 3 个测试：

1. 加载实际文件并确保没有错误
2. 尝试加载无效文件（不存在的文件）
3. 不指定文件名参数

测试这些的正确方法是编写 3 个测试方法，如下所示：

    /// <summary>
    ///A test for LoadConfigFile
    ///</summary>
    [TestMethod()]
    public void LoadConfigFileTest()
    {
        Config target = new Config(); // TODO: Initialize to an appropriate value
        string filename = "config.xml"; // TODO: Initialize to an appropriate value
        target.LoadConfigFile(filename);
        Assert.Inconclusive("A method that does not return a value cannot be verified.");
    }

    /// <summary>
    ///A test for LoadConfigFile
    ///</summary>
    [TestMethod()]
    [ExpectedException(typeof(System.ArgumentException))]
    public void LoadConfigFileTest1()
    {
        Config target = new Config(); // TODO: Initialize to an appropriate value
        string filename = ""; // TODO: Initialize to an appropriate value
        target.LoadConfigFile(filename);
        Assert.Inconclusive("A method that does not return a value cannot be verified.");
    }

    /// <summary>
    ///A test for LoadConfigFile
    ///</summary>
    [TestMethod()]
    [ExpectedException(typeof(System.IO.FileNotFoundException))]
    public void LoadConfigFileTest2()
    {
        Config target = new Config(); // TODO: Initialize to an appropriate value
        string filename = "blah.xml"; // TODO: Initialize to an appropriate value
        target.LoadConfigFile(filename);
        Assert.Inconclusive("A method that does not return a value cannot be verified.");
    }

另外，这 3 个测试都应该有 try {} catch () {} 语句吗？与第一个测试一样，隐含了正确性，在第二个和第三个测试中，我无论如何都会检查异常，因此异常对测试没有影响。

Answer 1

你走在正确的道路上，但还没有完全实现。

很少会出现必须调用的情况，Assert.Inconclusive而在您的情况下则没有必要：当您期望异常并且抛出异常时，它将按预期工作（又名：它应该显示为绿色）结果）。当您期望出现异常但没有抛出任何异常时，它将显示为失败（又名：红色结果）。更多内容请参见此处。

其实返回的方法void 是可以测试的。它可能会改变某些东西的状态，而不是返回一个值。在你的情况下变量configFile. 测试这一点的方法是检索值（例如通过提供 getter）和/或使用依赖项注入并在测试中用变量替换 fake/mock/stub（选择您的术语）。

不应该有 try-catch 块：它只会隐藏代码可能存在的任何问题。至于您的原始代码：不要捕获实际的异常并将其重新抛出为FileNotFoundException. 看看你隐藏的所有可能的原因。

扩展评论：

我不希望开发人员直接弄乱 configfile 属性，所以我应该将其公开用于测试，然后将其更改回私有吗？

这是一个值得关注的问题，每个开发人员在进行测试时都会面临这个问题。重要的是要认识到，单元的内部运作不是您通常应该测试的东西。实现细节正是它们的本质：实现细节。然而，有时替代方案甚至更不受欢迎，因此您必须进行比较，无论您是否想要这样做。

这可能是一个合法的用例，幸运的是有一个相当好的解决方法！我在这里进行了更详细的介绍，但我建议授予internal访问权限，configfile无论是使用内部构造函数、方法、属性还是仅使用字段。通过应用该[InternalsVisibleTo]属性，您可以从单元测试项目中提供对它的访问，同时仍然对公众隐藏它。

关于使用存根来测试配置文件中的内容，看起来我必须将所有内容更改为接口相关的？这不是增加了很多不必要的复杂性吗？

定义“需要什么”。确实，通过定义接口并注入这些接口，您的代码中会有一个额外的抽象层，但这样做是有原因的：由于类的松散耦合性质，您现在可以通过注入另一个实现来更轻松地测试它。

这个过程 - 依赖注入 - 是单元测试的支柱，也将有助于你的第一句话。