如何编写实现合同的类应该通过的单元测试

Question

我不确定这是否是一个有效的问题。 当您有问题但不知道要输入搜索的相关术语时，这很困难。 所以我的搜索没有产生任何有意义的结果。 我只是想知道编写一个实现合同的类应该通过的单元测试是否是一回事。

例如，我想定义以下合同：

abstract class FooContract
{

    public function setup(): bool
    {
        // General setup code
    }

    abstract function run(): string;
}

程序员可以编写一个名为 Baz 的 class 来实现合约：

class Baz extends FooContract
{

    public function run(): string
    {
        // run code
    }
}

我想给程序员一个选择，让她不必在每次实现 FooContract 时都编写完整的测试。 所以我想给class Baz的程序员以下一组单元测试：

trait FooContractTest
{
    private function getInstanceOrFail()
    {
        if (method_exists($this, 'getInstance')) {
            if (($instance = $this->getInstance()) instanceof FooContract) {
                return $instance;
            }
        }
        throw new Exception('Define the method getInstance() in your test. You should then return an instance of FooContract under test from getInstance');
    }

    public function test_can_setup()
    {
        $this->assertTrue($this->getInstanceOrFail()->setup());
    }

    public function test_can_run()
    {
        $this->assertEquals('Done', $this->getInstanceOrFail()->run());
    }
}

我希望 Baz 的程序员按如下方式运行测试：

class BazTest extends PHPUnit_TestCase
{
    use FooContractTest;

    public function getInstance()
    {
        return new Baz;
    }
}

我的问题是，这是一回事吗？ 有更好的方法吗？

Answer 1

在我看来，您想提供一组可重用的测试。 包含常见测试的特征对我来说似乎是一个公平的解决方案。

重命名特征以更清楚地说明其用途，例如CommonFooContractTests 、 FooContractCommonTests 。 请记住，用后缀“测试”命名它可能会导致 PHPUnit 出现问题，因为它可能认为这是一个测试。 使用“Common”和“Tests”之类的词会更清楚一些。

我将通过使用具有预期返回类型的抽象方法来使实例依赖项成为特征中的要求，并将实例 getter 重命名为特征特定的工厂方法。

trait FooContractCommonTests
{
    abstract public function createFooContract(): FooContract;

    public function testCanSetup(): void
    {
        $this->assertTrue($this->createFooContract()->setup());
    }
}

如果您不能使用返回类型，则使用测试来评估预期类型并使所有其他测试依赖于它：

trait FooContractCommonTests
{
    abstract public function createFooContract();

    public function testGetInstanceIsInstanceOfFooContract(): void
    {
        $this->assertInstanceOf(FooContract::class, $this->createFooContract());
    }

    /**
     * @depends testGetInstanceIsInstanceOfFooContract
     */
    public function testCanSetup(): void
    {
        $this->assertTrue($this->createFooContract()->setup());
    }
}

除此之外，我认为使用通用测试特征没有太大问题，即使您已经使用getInstanceOrFail实现了它，它也不是那么糟糕，尽管我确实认为具有预期返回类型的抽象方法是最干净和最清晰的执行。