如何通过更改通过引用传递的参数来对调用具有副作用的函数的方法进行单元测试？

Question

我有一个调用内置 PHP 函数的方法，openssl_random_pseudo_bytes。

public function generateRandomBytes()
{
    $crypto_secure = TRUE;

    // $crypto_secure is passed by reference and will be set to FALSE by
    // openssl_random_pseudo_bytes if it uses an insecure algorithm
    $random_bytes = openssl_random_pseudo_bytes(16, $crypto_secure);
    if (!$crypto_secure)
    {
        throw new Security_Exception('Random bytes not generated by a cryptographically secure PRNG algorithm');
    }
    return $random_bytes;
}

我有一个 PHPUnit 测试用例来测试这个方法（它所做的只是验证随机生成的字符串是 16 字节长）。

public function testRandomBytesLength()
{
    $myclass = new MyClass();

    $this->assertEquals(16, strlen($myclass->generateRandomBytes()));
}

我的问题是，我如何测试 $crypto_secure 为 FALSE 并且必须抛出异常的情况？由于这个值是作为对openssl_random_pseudo_bytes 的引用传入和修改的，所以我不确定如何获得这个执行路径的测试覆盖率。我的第一个想法是，也许我可以使用 php.ini 配置来强制 openssl_random_pseudo_bytes 使用加密不安全的算法（在测试用例中通过 ini_set）。有什么建议吗？

Answer 1

一种选择是将你的代码抽象出来，这样你就可以模拟 openssl 方法的返回值：

public function generateRandomBytes()
{
    $crypto_secure = TRUE;
    $random_bytes = $this->randomPseudoBytes(16, $crypto_secure);
    if (!$crypto_secure)
    {
        throw new Security_Exception('Random bytes not generated by a cryptographically secure PRNG algorithm');
    }
    return $random_bytes;
}

protected function randomPseudoBytes($length, &$crypto_secure)
{
    return openssl_random_pseudo_bytes(16, $crypto_secure);
}

然后您可以控制核心函数周围的包装器，以测试您的代码如何对其变化做出反应：

/**
 * @expectedException Security_Exception
 * @expectedExceptionMessage Random bytes not generated by a cryptographically secure PRNG algorithm
 */
public function testCryptoIsNotSecure()
{
    $myclass = $this->getMockBuilder(MyClass::class)->setMethods(['randomPseudoBytes'])->getMock();

    $myclass->expects($this->once())
        ->method('randomPseudoBytes')
        ->will($this->returnCallback(function ($length, &$secure) {
            // Mock variable assignment via reference
            $secure = false;
        });

    $myclass->generateRandomBytes();
}

Answer 2

下面的答案是在openssl-random-pseudo-bytes 采用两个不可变参数的假设下编写的。相反，第二个参数是通过引用传递的，如果随机字节是由强算法创建的，则会给出反馈。鉴于这些信息，Robbie Averill 提供的答案是一种有效的方法，因为必须处理基本上两个返回语句和一个副作用，这本质上会使单元测试复杂化。

---

您的情况不需要您的安全例外。

您希望将openssl_random_pseudo_bytes 包装到您自己的自定义函数中，并且希望将长度硬编码为16 个字符，并始终使用true 调用openssl_random_pseudo_bytes。因此，您可以将您的课程编写为：

class MyClass
{
    public function generateRandomBytes()
    {
        return openssl_random_pseudo_bytes(16, true);
    }
}

这里唯一有意义的测试是检查返回的字符串长度是否为 16 个字符。你已经报道了那个案例。

---

为了显示异常抛出的不必要性，您宁愿将标志注入构造函数或作为参数：

class MyClass
{
    /**
     * @var bool
     */
    private $beSecure;

    public function __construct(bool $beSecure)
    {
        $this->beSecure = $beSecure;
    }


    /**
     * @return string
     * @throws Exception
     */
    public function generateRandomBytes(): string
    {
        if (!$this->beSecure) {
            // will always throw if false is injected, why would we do that?
            throw new Exception("I AM NOT SECURE!");
        }

        return openssl_random_pseudo_bytes(16, true);
    }
}

在您的单元测试中，您现在可以创建两个测试，一个用于安全案例，一个用于不安全案例，但您为什么要向该类注入 false？然后它总是会失败。