c# - 如何正确进行单元测试

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 的情况，而在您的情况下则没有必要:当您预期会出现异常并抛出异常时，它会起作用它应该(又名:它应该显示为绿色结果)。当您预期会出现异常并且没有抛出任何异常时，它将显示为失败(又名:红色结果)。更多关于 here .

事实上，a method that returns void can be tested .它可能不会返回一个值，而是改变某些东西的状态。在您的例子中，变量 configFile。对此进行测试的方法是检索值(例如通过提供 getter)和/或使用依赖注入(inject)并在测试中用变量替换假/模拟/ stub (选择您的行话)。

不应该有 try-catch block :它只会隐藏您的代码可能存在的任何问题。至于您的原始代码:不要捕获实际异常并将其作为 FileNotFoundException 重新抛出。 Look at all the possible causes you are hiding .

扩展评论:

I wouldn't want a develper to mess around with the configfile property directly, so should I make it public for the test, then change it back to private?

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

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

with regards to using stubs to test what's in configfile, it looks like I have to change everything to be interface dependant? Doesn't this just add tons more complexity that isn't needed?

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

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