如何使我的 PHPUnit 测试更简洁、更短？

Question

我正在为我的 Web 应用程序编写的 PHPUnit 测试的长度和不透明性让我感到厌烦。似乎测试中的代码比他们正在测试的代码多一个数量级。

例如，假设我的网站有一个 CatController 对象，此方法在其上：

public function addCat(Default_Model_Cat $cat)
{
    $workflow = $this->catWorkflowFactory->create(array($this->serviceExecutor));
    $workflow->addCat($cat);
}

为了彻底测试它，我必须创建的单元测试是这样的：

public function testAddCat()
{
    $cat = $this->getMockBuilder('Default_Model_Cat')
        ->disableOriginalConstructor()
        ->getMock();
    $controller = $this->getMockBuilder('CatController')
        ->disableOriginalConstructor()
        ->setMethods(array('none'))
        ->getMock();
    $workflow = $this->getMockBuilder('Default_Model_Workflow_Cat')
        ->setMethods(array('addCat'))
        ->disableOriginalConstructor()
        ->getMock();
    $workflow->expects($this->once())
        ->method('addCat')
        ->with($cat);
    $controller->serviceExecutor = $this->getMockBuilder('ServiceExecutor')
        ->disableOriginalConstructor()
        ->getMock();
    $controller->catWorkflowFactory = $this->getMockBuilder('Factory')
        ->disableOriginalConstructor()
        ->setMethods(array('create'))
        ->getMock();
    $controller->catWorkflowFactory->expects($this->once())
        ->method('create')
        ->with($controller->serviceExecutor)
        ->will($this->returnValue($workflow));
    $controller->addCat($cat);
}

有什么语法可以让单元测试更短更易读吗？例如，与其说“这个对象是一个将调用这个方法的模拟对象，当在它上面调用这个方法时，它将用这个参数调用一次并返回这个值”，如果我能只要说once(object->method(argument)) => $returnvalue之类的话。

Answer 1

您越能将类设计为在单元测试中可用而不需要被模拟，那么您需要编写的模拟代码就越少。但是对于上面的例子，我的第一反应是这个方法不需要单元测试，因为它并没有真正执行任何逻辑，写完后不会改变。

话虽如此，假设您将需要此类的其他方法中的工作流实例，请将创建它的代码提取到新方法中。这允许您为每个测试模拟该方法，并且只在一个测试中模拟更长的时间。

例如，如果您还有一个 removeCat() 方法，它看起来像这样：

public function addCat(Default_Model_Cat $cat) {
    $this->createWorkflow()->addCat($cat);
}

public function removeCat(Default_Model_Cat $cat) {
    $this->createWorkflow()->removeCat($cat);
}

public function createWorkflow() {
    return $this->catWorkflowFactory->create(array($this->serviceExecutor));
}

上述方法非常短，实际上不需要单元测试，但现在它们会短一点：

public function testAddCat() {
    $cat = $this->getMockBuilder('Default_Model_Cat')
        ->disableOriginalConstructor()
        ->getMock();
    $controller = $this->getMockBuilder('CatController')
        ->disableOriginalConstructor()
        ->setMethods(array('createWorkflow'))
        ->getMock();
    $workflow = $this->getMockBuilder('Default_Model_Workflow_Cat')
        ->setMethods(array('addCat'))
        ->disableOriginalConstructor()
        ->getMock();
    $controller->expects($this->once())
        ->method('createWorkflow')
        ->will($this->returnValue($workflow));
    $workflow->expects($this->once())
        ->method('addCat')
        ->with($cat);
    $controller->addCat($cat);
}

如果控制器中有很多这样的方法，则可以在测试用例中创建辅助方法来创建模拟。最后，您真的需要禁用模拟上的原始构造函数吗？我很少需要自己做。

Answer 2

如果您有一个CatController 对象，则尽可能不要在测试中模拟它。你想测试那个类，所以使用真正的类。

你可以摆脱所有的"setMethod" 电话。默认情况下，所有方法都会被模拟，这就是你想要的。

还有其他一些模拟库可以减少一些人喜欢的模拟代码行数，例如 Phake 和 Mockery，但我没有太多的个人经验。

让我感到有点奇怪的是，您使用公共属性设置了模拟。我本来希望那些进入 Controllers 构造函数。

鉴于这是你可以做到的方法：

public function testAddCat()
{
    $cat = $this->getMockBuilder('Default_Model_Cat')
        ->disableOriginalConstructor()
        ->getMock();

    $workflow = $this->getMockBuilder('Default_Model_Workflow_Cat')
        ->disableOriginalConstructor()
        ->getMock();
    $workflow->expects($this->once())
        ->method('addCat')
        ->with($cat);

    $controller = new CatController(/*if you need params here pass them!*/);
    // You can use this to avoid mocking the object if you want
    // If your tests are more of a usage doc maybe don't
    $controller->serviceExecutor = "My fake Executor";

    $controller->catWorkflowFactory = $this->getMockBuilder('Factory')
        ->disableOriginalConstructor()
        ->getMock();
    $controller->catWorkflowFactory->expects($this->once())
        ->method('create')
        ->with(array("My fake Executor"))
        ->will($this->returnValue($workflow));

    $controller->addCat($cat);
}

---

让我们在设置中添加一些常见的东西

为了让每个函数更易于阅读，让我们将默认的 mock 放到 setup 中。

public function setUp() {

    $this->controller = new CatController(/*if you need params, pass them!*/);
    $this->serviceExecutor = $this->getMockBuilder('ServiceExecutor')
        ->disableOriginalConstructor()
        ->getMock();
    $this->controller->serviceExecutor = $this->serviceExecutor;
    $this->cat = $this->getMockBuilder('Default_Model_Cat')
        ->disableOriginalConstructor()
        ->getMock();
    $this->workflow = $this->getMockBuilder('Default_Model_Workflow_Cat')
        ->disableOriginalConstructor()
        ->getMock();
    $this->controller->catWorkflowFactory = $this->getMockBuilder('Factory')
        ->disableOriginalConstructor()
        ->getMock();
}

以及方法：

public function testAddCat()
{
    $this->workflow->expects($this->once())
        ->method('addCat')
        ->with($this->cat);

    $this->controller->catWorkflowFactory->expects($this->once())
        ->method('create')
        ->with(array($this->serviceExecutor))
        ->will($this->returnValue($this->workflow));

    $this->controller->addCat($cat);
}

它仍然不是真的漂亮，但我们将它分成更易于管理的块。

安装程序会创建所有假对象，但它们什么都不做（因此它们不会通过任何测试，并且安装时间应该是疏忽

而测试的重点是描述应该发生的事情。

---

总的来说，我会说“如果使用该类有那么复杂，那么测试表明需要做很多事情可能是件好事”。如果这是一个问题，可能会改变类。使用它的生产罐头也将很难正确设置所有内容。但是许多框架/方法使控制器在这方面“特别”，所以你最了解:)