phpunitphpunit入门


备注

本节概述了phpunit是什么,以及开发人员为什么要使用它。

它还应该提到phpunit中的任何大型主题,并链接到相关主题。由于phpunit的文档是新的,您可能需要创建这些相关主题的初始版本。

版本

支持结束这些PHP版本支持发布日期
5.4 2016年8月5日 PHP 5.6,PHP 7。 2016年6月3日
4.8 2017年2月3日 PHP 5.3,PHP 5.4,PHP 5.5和PHP 5.6。 2015年8月7日

为我们的类创建第一个PHPUnit测试

想象一下,我们有一个Math.php 类, Math.php 具有计算fiobanacci和阶乘数的逻辑。像这样的东西:

<?php    
class Math {
    public function fibonacci($n) {
        if (is_int($n) && $n > 0) {
            $elements = array();
            $elements[1] = 1;
            $elements[2] = 1;
            for ($i = 3; $i <= $n; $i++) {
                $elements[$i] = bcadd($elements[$i-1], $elements[$i-2]);
            }
            return $elements[$n];
        } else {
            throw new 
                InvalidArgumentException('You should pass integer greater than 0');
        }
    }

    public function factorial($n) {
        if (is_int($n) && $n >= 0) {
            $factorial = 1;
            for ($i = 2; $i <= $n; $i++) {
                $factorial *= $i;
            }
            return $factorial;
        } else {
            throw new 
                InvalidArgumentException('You should pass non-negative integer');
        }
    }
}
 

最简单的测试

我们想测试fibonaccifactorial 方法的逻辑。让我们用Math.php 将文件MathTest.php 创建到同一目录中。在我们的代码中,我们可以使用不同的断言 。最简单的代码将是这样的(我们只使用assertEqualsassertTrue ):

<?php
require 'Math.php';

use PHPUNIT_Framework_TestCase as TestCase;
// sometimes it can be
// use PHPUnit\Framework\TestCase as TestCase;

class MathTest extends TestCase{
    public function testFibonacci() {
        $math = new Math();
        $this->assertEquals(34, $math->fibonacci(9));
    }

    public function testFactorial() {
        $math = new Math();
        $this->assertEquals(120, $math->factorial(5));
    }

    public function testFactorialGreaterThanFibonacci() {
        $math = new Math();
        $this->assertTrue($math->factorial(6) > $math->fibonacci(6));
    }
}
 

我们可以使用命令phpunit MathTest 从控制台运行此测试,输出将是:

    PHPUnit 5.3.2 by Sebastian Bergmann and contributors.

...                                                                 3 / 3 (100%)

Time: 88 ms, Memory: 10.50Mb

OK (3 tests, 3 assertions)
 

使用dataProviders

测试方法可以接受任意参数。这些参数由数据提供者方法提供 。要使用的数据提供程序方法是使用@dataProvider 批注指定的。 :

<?php
require 'Math.php';

use PHPUNIT_Framework_TestCase as TestCase;
// sometimes it can be
// use PHPUnit\Framework\TestCase as TestCase;

class MathTest extends TestCase {
    /**
     * test with data from dataProvider
     * @dataProvider providerFibonacci
     */
    public function testFibonacciWithDataProvider($n, $result) {
        $math = new Math();
        $this->assertEquals($result, $math->fibonacci($n));
    }

    public function providerFibonacci() {
        return array(
            array(1, 1),
            array(2, 1),
            array(3, 2),
            array(4, 3),
            array(5, 5),
            array(6, 8),
        );
    }
}
 

我们可以使用命令phpunit MathTest 从控制台运行此测试,输出将是:

    PHPUnit 5.3.2 by Sebastian Bergmann and contributors.

......                                                              6 / 6 (100%)

Time: 97 ms, Memory: 10.50Mb

OK (6 tests, 6 assertions)


<?php
require 'Math.php';
use PHPUNIT_Framework_TestCase as TestCase;
// sometimes it can be
// use PHPUnit\Framework\TestCase as TestCase;
 

测试异常

我们可以使用expectException() 方法测试被测代码是否抛出异常。同样在这个例子中,我们添加了一个失败的测试来显示失败测试的控制台输出

<?php
require 'Math.php';
use PHPUNIT_Framework_TestCase as TestCase;
// sometimes it can be
// use PHPUnit\Framework\TestCase as TestCase;

class MathTest extends TestCase {
    public function testExceptionsForNegativeNumbers() {
        $this->expectException(InvalidArgumentException::class);
        $math = new Math();
            $math->fibonacci(-1);
    }

    public function testFailedForZero() {
        $this->expectException(InvalidArgumentException::class);
        $math = new Math();
        $math->factorial(0);
    }
}
 

我们可以使用命令phpunit MathTest 从控制台运行此测试,输出将是:

        PHPUnit 5.3.2 by Sebastian Bergmann and contributors.

.F                                                                  2 / 2 (100%)

Time: 114 ms, Memory: 10.50Mb

There was 1 failure:

1) MathTest::testFailedForZero
Failed asserting that exception of type "InvalidArgumentException" is thrown.

FAILURES!
Tests: 2, Assertions: 2, Failures: 1.
 

SetUp和TearDown

此外, PHPUnit 还支持共享设置代码。在运行测试方法之前,将调用名为setUp()的模板方法。 setUp() 是您创建要测试的对象的位置。一旦测试方法运行完毕,无论是成功还是失败,都会调用另一个名为tearDown() 模板方法。 tearDown() 用于清理测试对象。

<?php
require 'Math.php';

use PHPUNIT_Framework_TestCase as TestCase;
// sometimes it can be
// use PHPUnit\Framework\TestCase as TestCase;

class MathTest extends TestCase {
    public $fixtures;
    protected function setUp() {
        $this->fixtures = [];
    }

    protected function tearDown() {
        $this->fixtures = NULL;
    }

    public function testEmpty() {
        $this->assertTrue($this->fixtures == []);
    }
}
 

更多信息

您可以在测试中使用PHPUnit 更多机会。有关详细信息,请参阅官方手册

使用Stub和Mock的APItest的PHPUNIT示例

您将为其创建单元测试用例的类。 class Authorization {

/* Observer so that mock object can work. */    
 public function attach(Curl $observer)
{
    $this->observers = $observer;
}

/* Method for which we will create test */
public  function postAuthorization($url, $method) {
    
    return $this->observers->callAPI($url, $method);
}
 

}

现在我们不希望我们的测试代码有任何外部交互,因此我们需要为callAPI函数创建一个模拟对象,因为这个函数实际上是通过curl调用外部URL。 class AuthorizationTest extends PHPUnit_Framework_TestCase {

protected $Authorization;

/**
 * This method call every time before any method call.
 */
protected function setUp() {
    $this->Authorization = new Authorization();
}

/**
 * Test Login with invalid user credential
 */
function testFailedLogin() {

    /*creating mock object of Curl class which is having callAPI function*/
    $observer = $this->getMockBuilder('Curl')
                     ->setMethods(array('callAPI'))
                     ->getMock();

    /* setting the result to call API. Thus by default whenver call api is called via this function it will return invalid user message*/
    $observer->method('callAPI')
            ->will($this->returnValue('"Invalid user credentials"'));

    /* attach the observer/mock object so that our return value is used */
    $this->Authorization->attach($observer);

    /* finally making an assertion*/
    $this->assertEquals('"Invalid user credentials"',           $this->Authorization->postAuthorization('/authorizations', 'POST'));
}
 

}

下面是curl类的代码(只是一个示例) class Curl{ function callAPI($url, $method){

    //sending curl req
}
 

}

最小的例子测试

给出一个简单的PHP类:

class Car
{
    private $speed = 0;

    public getSpeed() {
        return $this->speed;
    }

    public function accelerate($howMuch) {
        $this->speed += $howMuch;
    }
}
 

您可以编写一个PHPUnit测试,通过调用公共方法并检查它们是否按预期运行来测试被测试类的行为:

class CarTest extends PHPUnit_Framework_TestCase
{
    public function testThatInitalSpeedIsZero() {
        $car = new Car();
        $this->assertSame(0, $car->getSpeed());
    }

    public function testThatItAccelerates() {
        $car = new Car();
        $car->accelerate(20);
        $this->assertSame(20, $car->getSpeed());
    }

    public function testThatSpeedSumsUp() {
        $car = new Car();
        $car->accelerate(30);
        $car->accelerate(50);
        $this->assertSame(80, $car->getSpeed());
    }
}
 

重要部分:

  1. 测试类需要从PHPUnit_Framework_TestCase派生。
  2. 每个测试函数名称都应以前缀'test'开头
  3. 使用$this->assert... 函数来检查预期值。

模拟课程

使用验证期望的测试double替换对象的实践,例如断言已调用方法,被称为模拟。

让我们假设我们有SomeService来测试。

class SomeService
{
    private $repository;
    public function __construct(Repository $repository)
    {
        $this->repository = $repository;
    }

    public function methodToTest()
    {
        $this->repository->save('somedata');
    }
}   
 

我们想测试methodToTest 真的调用了存储库的save 方法。但是我们不想实际实例化存储库(或者Repository 可能只是一个接口)。

在这种情况下,我们可以模拟Repository

use PHPUnit\Framework\TestCase as TestCase;

class SomeServiceTest extends TestCase
{    
    /**
     * @test
     */
    public function testItShouldCallRepositorySavemethod()
    {
        // create an actual mock
        $repositoryMock = $this->createMock(Repository::class);

        $repositoryMock->expects($this->once()) // test if method is called only once
             ->method('save')                   // and method name is 'save'
             ->with('somedata');                // and it is called with 'somedata' as a parameter

        $service = new SomeService($repositoryMock);
        $service->someMethod();
    }
}