php - 使用 PHPUnit 测试触发错误的方法的返回值

Question

这个问题特定于使用 PHPUnit。

PHPUnit 自动将 php 错误转换为异常。 有没有办法测试碰巧触发 php 错误的方法的返回值(内置错误或用户通过 trigger_error 生成的错误)？

要测试的代码示例:

function load_file ($file)
{
    if (! file_exists($file)) {
        trigger_error("file {$file} does not exist", E_USER_WARNING);
        return false;
    }
    return file_get_contents($file);
}

这是我想要编写的测试类型:

public function testLoadFile ()
{
    $this->assertFalse(load_file('/some/non-existent/file'));
}

我遇到的问题是触发的错误导致我的单元测试失败(正如它应该的那样)。但是，如果我 try catch 它，或者设置预期的异常，则触发错误后的任何代码都不会执行，因此我无法测试该方法的返回值。

这个例子不起作用:

public function testLoadFile ()
{
    $this->setExpectedException('Exception');
    $result = load_file('/some/non-existent/file');

    // code after this point never gets executed

    $this->assertFalse($result);
}

有什么想法可以实现这一目标吗？

Answer 1

没有办法在一个单元测试中做到这一点。如果您将测试返回值和通知分解为两个不同的测试，这是可能的。

PHPUnit 的错误处理程序捕获 PHP 错误并发出通知，并将它们转换为异常 - 根据定义，异常会停止程序执行。您正在测试的函数根本不会返回。但是，即使在运行时，您也可以暂时禁用错误到异常的转换。

通过示例可能会更容易，因此，这两个测试应该如下所示:

public function testLoadFileTriggersErrorWhenFileNotFound()
{
    $this->setExpectedException('PHPUnit_Framework_Error_Warning'); // Or whichever exception it is
    $result = load_file('/some/non-existent/file');

}

public function testLoadFileRetunsFalseWhenFileNotFound()
{
    PHPUnit_Framework_Error_Warning::$enabled = FALSE;
    $result = load_file('/some/non-existent/file');

    $this->assertFalse($result);
}

这还有一个额外的好处，那就是让您的测试更加清晰、干净和自记录。

回复:评论:这是一个很好的问题，直到我进行了几次测试之后我才知道。看起来它不会恢复默认/原始值，至少从 PHPUnit 3.3.17(当前的稳定版本)开始是这样。

所以，我实际上会将上面的内容修改为如下所示:

public function testLoadFileRetunsFalseWhenFileNotFound()
{
    $warningEnabledOrig = PHPUnit_Framework_Error_Warning::$enabled;
    PHPUnit_Framework_Error_Warning::$enabled = false;

    $result = load_file('/some/non-existent/file');

    $this->assertFalse($result);

    PHPUnit_Framework_Error_Warning::$enabled = $warningEnabledOrig;
}

回复:第二条评论:

这并不完全正确。我正在查看 PHPUnit 的错误处理程序，它的工作原理如下:

• 如果是 E_WARNING，则使用 PHPUnit_Framework_Error_Warning 作为异常类。
• 如果是 E_NOTICE 或 E_STRICT 错误，请使用 PHPUnit_Framework_Error_Notice
• 否则，使用 PHPUnit_Framework_Error 作为异常类。

所以，是的，E_USER_* 的错误不会转换为 PHPUnit 的 *_Warning 或 *_Notice 类，它们仍然会转换为通用的 PHPUnit_Framework_Error 异常。

进一步的想法

虽然这完全取决于函数的使用方式，但如果是我的话，我可能会转而抛出实际的异常，而不是触发错误。是的，这会改变该方法的逻辑流程以及使用该方法的代码...现在，当无法读取文件时，执行不会停止。但这取决于您来决定所请求的文件不存在是否确实是异常行为。我更倾向于使用异常而不是错误/警告/通知，因为它们更容易处理、测试和融入您的应用程序流程。我通常会保留诸如折旧方法调用之类的通知。