如何测试工厂类？

Question

鉴于这个类：

class MyBuilder {
    public function build($param1, $param2) {

        // build dependencies ...

        return new MyClass($dep1, $dep2, $dep3);
    }
}

如何对这个类进行单元测试？

单元测试意味着我想测试它的行为，所以我想测试它以正确的依赖关系构建我的对象。但是，new 指令是硬编码的，我无法模拟它。

目前，我已将类的名称添加为参数（这样我就可以提供模拟类的类名），但这很丑：

class MyBuilder {
    public function build($classname, $param1, $param2) {

        // build dependencies ...

        return new $classname($dep1, $dep2, $dep3);
    }
}

是否有干净的解决方案或设计模式可以让我的工厂可测试？

Answer 1

工厂本质上是可测试的，您只是试图对实现进行过于严格的控制。

你会检查你是否通过$this->assertInstanceOf() 获得了你的类的实例。然后使用生成的对象，您将确保正确设置属性。为此，您可以使用任何公共访问器方法或使用 PHPUnit 中可用的 $this->assertAttribute* 方法。

http://phpunit.de/manual/current/en/writing-tests-for-phpunit.html#writing-tests-for-phpunit.assertions.assertEquals

许多常见的断言还能够检查受保护和私有属性的属性。

我不会在您的参数列表中指定类名，因为您的用法是工厂将只返回一种类型，并且仅更改了依赖项。让它返回一个模拟对象类型是不必要的，并且会使您的测试更加复杂。

测试最终会是这样的：

public function testBuild() {
    $factory = new MyBuilder();

    //I would likely put the following into a data provider
    $param1 = 'foo';
    $param2 = 'bar';

    $depen1 = 'boo';
    $depen2 = 'baz';
    $depen3 = 'boz';

    $object = $factory->build($param1, $param2);

    $this->assertInstanceOf('MyClass', $object);

    //Check the object definition
    //This would change depending on your actual implementation of your class
    $this->assertAttributeEquals($depen1, 'attr1', $object);
    $this->assertAttributeEquals($depen2, 'attr2', $object);
    $this->assertAttributeEquals($depen3, 'attr3', $object);
}

您现在正在确保您的工厂返回正确的对象。首先确保它是正确的类型。然后确保它已正确初始化。

您依赖MyClass 的存在才能通过测试，但这并不是一件坏事。您的工厂旨在创建 MyClass 对象，因此如果该类未定义，那么您的测试肯定会失败。

在开发过程中测试失败也不是坏事。

Answer 2

那么你想测试什么？

所以我想测试它是否会使用正确的依赖项构建我的对象。

我确实看到了这个问题。有可能您可以创建一个具有不正确依赖关系的对象（首先不应该是这种情况，或者在其他测试中测试过，而不是在工厂中测试），或者您想要测试不应该测试的工厂细节全部。

否则 - 如果它不是在模拟您正在寻找的工厂 - 我看不出为什么简单

$actual = $subject->build($param1, $param2);
$this->assertInstanceOf('MyClass', $actual);

不会成功。它测试工厂构建方法的行为，它返回正确的类型。

另见Open-Close-Principle

---

对于测试，您可以创建从您的 Builder 扩展而来的 MockBuilder：

class MyMockBuilder extends MyBuilder {
    public function build($param1, $param2) {

        // build dependencies ...

        return new MyMockClass($dep1, $dep2, $dep3);
    }
}

将类名设置为 1:1 的参数对我来说似乎不切实际，因为它将工厂变成了不同的东西。创建是工厂的一个细节，没有任何东西可以外化。所以应该封装。因此，用于测试的 MockBuilder。你切换工厂。

Answer 3

在我看来，您需要为该构建器验证两件事：

• 返回正确的实例
• 注入的值是正确的。

检查实例是简单的部分。验证值需要一些技巧。

最简单的方法是改变自动加载器。您需要确保当 MyClass 请求自动加载器获取时，而不是 /src/app/myclass.php 文件加载 /test/app/myclass.php，它实际上包含一个“透明”模拟（您可以使用简单的 getter 验证值）。

坏主意

更新：

另外，如果你不想弄乱自动加载器，你可以在 myBuilderTest.php 文件的顶部包含模拟类文件，其中包含 MyClass 的定义。

...这实际上似乎是一种更清洁的方式。

namespace Foo\Bar;
use PHPUnit_Framework_TestCase;

require TEST_ROOT . '/mocks/myclass.php'

class MyBuilderTest extends PHPUnit_Framework_TestCase
{
    public function MyBuilder_verify_injected_params_test()
    {
         $target = new MyBuilder;
         $instance = $target->build('a', 'b');

         $this->assertEquals('a', $instance->getFirstConstructorParam(); 
    }
}