单元测试在第n次调用函数时抛出异常

时间:2012-10-13 16:48:11

标签: php phpunit

假设您有一种最终归结为

的方法
class Pager
{
    private $i;

    public function next()
    {
        if ($this->i >= 3) {
            throw new OutOfBoundsException();
        }

        $this->i++;
    }
}

你将如何对这门课程进行单元测试。即测试是否使用PHPUnit在next()的第三次调用中抛出异常?我已经添加了我的尝试作为答案,但我不确定这是否真的是要走的路。

5 个答案:

答案 0 :(得分:7)

如何在前两次调用中测试null,并测试抛出的异常,如下所示:

class PagerTest
{
    public function setUp()
    {
        $this->pager = new Pager();
    }

    public function testTooManyNextCalls()
    {
        $this->assertNull($this->pager->next());
        $this->assertNull($this->pager->next());
        $this->assertNull($this->pager->next());

        $this->setExpectedException('OutOfBoundsException');
        $this->pager->next();
    }
}

答案 1 :(得分:4)

在进行单元测试时,避免测试实现细节非常重要。相反,您希望仅限于测试代码的公共接口。为什么?由于实施细节经常变化,但您的API应该很少更改。测试实现细节意味着您将不断重写测试,因为这些实现会发生变化,并且您不希望这样做。

那对OP的代码意味着什么呢?我们来看看公共Pager::next方法。使用Pager类API 的代码不关心 Pager::next如何确定是否应抛出异常。 关心Pager::next如果出现问题,实际上会抛出异常。

我们不想测试方法如何决定抛出OutOfBoundsException - 这是一个实现细节。我们只想在适当时测试它是否这样做。

因此,为了测试这种情况,我们模拟Pager::next将抛出的情况。为了实现这一目标,我们只需实现所谓的“测试缝”。 ...

<?php
class Pager
{
    protected $i;

    public function next()
    {
        if ($this->isValid()) {
            $this->i++;
        } else {
            throw new OutOfBoundsException();
        }
    }

    protected function isValid() {
        return $this->i < 3;
    }
}

在上面的代码中,受保护的Pager::isValid方法是我们的​​测试接缝。它在我们的代码(因此名称)中暴露了一个接缝,我们可以将其锁定以用于测试目的。使用我们的新测试接缝和PHPUnit的模拟API,测试Pager::next引发$i无效值的异常是微不足道的:

class PagerTest extends PHPUnit_Framework_TestCase
{
    /**
     * @covers Pager::next
     * @expectedException OutOfBoundsException
     */
    public function testNextThrowsExceptionOnInvalidIncrementValue() {
        $pagerMock = $this->getMock('Pager', array('isValid'));
        $pagerMock->expects($this->once())
                  ->method('isValid')
                  ->will($this->returnValue(false));
        $pagerMock->next();
    }
}

请注意,此测试特别关注 实现方法Pager::isValid如何确定当前增量无效。测试只是模拟方法在调用它时返回false,这样我们就可以测试我们的公共Pager::next方法在它应该这样做的时候抛出异常。

Test Doubles section of the PHPUnit manual完全涵盖了PHPUnit模拟API。 API不是世界历史上最直观的东西,但通过一些重复使用它通常是有道理的。

答案 2 :(得分:1)

这是我目前所拥有的,但我想知道是否有更好的方法来做到这一点。

class PagerTest
{
    public function setUp()
    {
        $this->pager = new Pager();
    }

    public function testTooManyNextCalls()
    {
        for ($i = 0; $i < 10; $i++) {
            try {
                $this->pager->next();
            } catch(OutOfBoundsException $e) {
                if ($i == 3) {
                    return;
                } else {
                    $this->fail('OutOfBoundsException was thrown unexpectedly, on iteration ' . $i);
                }
            }

            if ($i > 3) {
                $this->fail('OutOfBoundsException was not thrown when expected');
            }
        }
    }
}

答案 3 :(得分:1)

您可以使用以下内容:

class PagerTest extends PHPUnit_Framework_TestCase {

    /**
     * @expectedException OutOfBoundsException
     */
     public function testTooManyNextCalls() {
         $this->pager = new Pager();

         $this->pager->next();
         $this->pager->next();
         $this->pager->next();

         $this->assertTrue(false);
    }
}

如果在第3个方法调用中抛出异常,则永远不应该到达始终失败的assert语句并且测试应该通过。另一方面,如果没有抛出异常,测试将失败。

答案 4 :(得分:0)

您可以将值$ this-&gt; i传递给异常实例化,然后该异常实例化将成为异常的消息。

class Pager
{
    private $i;

    public function next()
    {
        if ($this->i >= 3) {
            throw new OutOfBoundsException($this->i);
        }

        $this->i++;
    }
}
$a=new Pager();
$a->next();
$a->next();
$a->next();
$a->next();

//outputs: "Exception: 3"