使用私有/受保护常量测试类

Kla*_*usK 6 unit-testing constants access-modifiers php-7.1

在测试类方法时,有时我需要将返回值与某个类中定义的某个常量进行比较。

class FooBar
{
    const RANDOM = 18;
}
....
// Somewhere in test...
$this->assertEquals(FooBar::RANDOM, $mock->doSomething());
Run Code Online (Sandbox Code Playgroud)

现在,从 PHP 7.1 开始,可以使用可见性修饰符定义类常量,这可以更改为:

private const RANDOM = 18;
Run Code Online (Sandbox Code Playgroud)

然而,这会阻止测试工作,因为现在我们正在尝试访问私有常量。

所以现在我们有两个选择:

  1. 将常量声明为公共常量。
  2. 在测试中使用反射。这意味着测试变成:

$this->assertEquals( (new ReflectionClass(FooBar::class))->getConstant('RANDOM'), $mock->doSomething() );

第一种方法感觉非常错误,因为我们只是为了测试而不断公开,而不是因为类/层次结构/业务模型需要它公开。

第二个感觉也不对劲,因为任何 IDE 都找不到这个用例,因此任何搜索/替换/重构都会在这里失败。

所以我的问题是,是否应该使用第二种场景而不关心重构会破坏测试?或者甚至可能在断言中不鼓励使用一般常量?

Tom*_*far 5

恕我直言,在测试中使用常量实际上是一种不好的做法。

您应该测试常量的文字值。$this->assertSame(18, $mock->doSomething())

为什么?

因为测试给您带来的重要价值之一是您注意到代码更改的意外后果。由于常量是私有的,它的值永远不会在类之外使用。但许多不同的事情可能取决于它的内部价值。

现在想象一下,一位不熟悉代码库的初级开发人员的任务是更改使用常量的地方之一,并将其​​从 18 更改为 16。他将去将常量的值从 18 更改为 16,并进行粗略的操作。检查常量的使用位置(没有注意到您的 doSomething() 方法)。现在,在您的方法中,您绝对需要随机数为 18,而不是 16!但如果你使用常量,他永远不会知道,因为当他将其从 18 更改为 16 时,断言也会从 18 更改为 16。测试就会通过。

我的经验法则:

切勿使用从应用程序代码中提取的断言的预期值。尽可能使用文字值。