如何通过单元测试证明这段代码中的错误

Question

我们公司有一个习惯，当报告错误时，我们会执行以下步骤：

1. 编写一个失败的单元测试，清楚地显示错误的存在
2. 修复错误
3. 重新运行测试以证明错误已修复
4. 提交修复和测试避免将来出现回归

现在我遇到了一段带有非常简单错误的遗留代码。情况如下所示：

public final class SomeClass {
    ...
    public void someMethod(Parameter param) {
        try {
            if (param.getFieldValue("fieldName").equals("true")) { // Causes NullPointerException
                ...
            }
        } catch (Exception ex) {
            log.warn("Troubles ...", ex);
        }
    }
}

这里的问题是 fieldName 不是强制性的，因此如果不存在，您将得到 NPE。明显的解决方法是：

if ("true".equals(param.getFieldValue("fieldName"))) {
    ...
}

我的问题是如何编写单元测试以使方法失败。如果我传入一条不包含 fieldName 的消息，它只会记录 NPE，但不会失败......

您可能会想到该方法的作用是什么？我可以测试一下该方法的效果。不幸的是，它与一些远程系统通信，因此这将需要大量的集成测试，对于如此小的和直接的错误来说，这似乎有点过分了。

请注意，在代码中进行任何不直接导致错误的更改（如果不是不可能的话）将非常困难。因此，仅仅为了更容易测试而更改代码可能不是一个选择。这是相当可怕的遗留代码，每个人都不敢碰它。

Answer 1

您可以做几件事：

1. 存根记录器并检查是否记录了错误，作为错误是否发生的指示器。如果记录器无法轻松更换，您可以使用 TypeMock 或 Moles。
2. 将 try 块内的部分重构为自己的方法，并仅调用 try 块内的该方法，并使您的单元测试也调用该方法。现在，异常不会被静默记录，您可以检查它是否被抛出。

Answer 2

我认为最好的做法是模拟记录器，并断言记录器没有被调用进行传递。如果这是一个很大的变化，我假设记录器被用在很多地方，这将帮助您将来进行其他测试。为了快速修复，您可以在异常捕获器中引发一个事件，但我认为这不是一种非常“干净”的方法。

Answer 3

恕我直言，任何包罗万象的都是错误的。您想要捕获您正在寻找的特定异常。单元测试也是为了让代码变得更好，所以你可以将其更改为

catch (ExpectedException ex)

Answer 4

log 可能是一个注入的服务，这意味着 SomeClass 看起来像这样：

public final class SomeClass 
{
    private final Logger log;

    public SomeClass(Logger log)
    {
        this.log = log;
    }
}

所以在你的单元测试中，你可以传递一个假的 Logger （可能构造使用模拟框架），它允许您检测测试期间是否记录了警告。

如果 log 是全局变量，您可以使该全局变量可写，以便您可以以类似的方式替换测试中的记录器。

另一种选择是在单元测试中将 Handler 添加到 log 中，以检测 warn 调用（假设您正在使用 java.util.logging.Logger，但是情况似乎并非如此，因为该方法是 警告，而不是警告）。

Answer 5

好吧，你公司的方法确实意味着你有时必须编写大量额外的测试，你可能会争论这是否是解决这个“明显的简单错误”的方法。但你这样做是有原因的。

我会这样看：

• 你的方法应该有一定的效果。
• 目前还没有这个效果。
• 如果你想修复它并测试该方法是否有效，你需要检查效果。

因此，您可能应该编写整个代码，甚至使用外部系统，以证明该功能有效。或者在这种情况下，没有。

Answer 6

在测试开始时为此类/记录器添加一个警告级别的附加记录器附加程序（并在结束时将其删除）。

然后运行 ​​someMethod 并检查新的附加程序是否仍然为空（然后没有异常）或有内容（然后有异常）。

Answer 7

您可以考虑使用 Boolean.toBoolean(String) 或 "true".equalsIgnoreCase(text)

如果您不希望出现此行为，您可能需要添加一个测试来显示“True”和“TRUE”被视为 false。