PHP单元测试框架PHPUnit的使用

单元测试是开发过程当中必不可少的一环，一个项目有良好的单元测试代码，重构的勇气都大不少。此次写一篇小文来介绍一下 PHP 的单元测试工具 PHPUnit 的使用。

PHPUnit 的使用并不难，这篇文章主要仍是充当一个引子，介绍基本概念和使用，有了这篇文章的基础以后，去看官网的文档就会更加顺风顺水。

安装

安装 PHPUnit 的方式很简单，使用 composer 能够一行代码就能够安装。

composer require --dev phpunit/phpunit

安装以后，在 vendor/bin 目录下有一个 phpunit 的可执行文件，这个就是 phpunit 本体了。假设咱们项目的目录结构以下：

➜  phpunit tree .

├── controller
├── model
├── service
├── test
└── vendor
├── composer.json

其中咱们的单元测试代码都放在 test 目录下。使用 composer 来为咱们解决 autoload 的问题。

{
  "autoload": {
    "psr-4": {
      "Controller\\": "controller/",
      "Model\\": "model/",
      "Service\\": "service/",
      "Test\\": "test/",
    }
  },
}

最后执行 composer dumpautoload -o 让自动加载生效。

到这里咱们的安装就算结束了。若是你使用 phpstorm 进行开发，那么你须要进行以下的配置：

这里指明了从哪里加载 PHPUnit，因为咱们使用 composer 安装，因此，这里的文件选择 composer 生成的 autoload.php 文件便可。

使用

好了，假设咱们如今进行开发，在 service 目录中添加了一个 CalculateService 的文件，而且编写了一个 abs 的函数。

namespace Service;

class CalculateService
{
    public function abs($num)
    {
        return abs($num);
    }
}

如今咱们对 abs 函数进行单元测试，PHPUnit 规定了一个测试类必须遵照以下的规定：
单元测试类名必须以 Test 结尾，必须继承 \PHPUnit\Framework\TestCase 基类。
每一个测试函数必须以 test 开头。

上面的规定是必须遵照的，若是代码没有遵照规定 PHPUnit 不会把他当作单元测试代码。

除了以上的两条，还有一些良好的编码习惯能够参考：

单元测试代码都放在 test 目录下。
每一个单元测试类以被测试的类名开头。例如被测试类为 CalculateService，那么单元测试类应该为 CalculateServiceTest。
每一个单元测试函数应该为被测试函数名结尾。例如被测试函数为 abs，那么单元测试函数应该为 testAbs。

根据上面的规范，编写单元测试代码

class UserServiceTest extends \PHPUnit\Framework\TestCase
{
    public function testAbs()
    {
        $userService = new \Service\CalculateService();
        $this->assertEquals(4, $userService->abs(4));
    }
}

在上面的测试代码中，调用了咱们要测试的函数 abs，而后断言 $userService->abs(4) 的结果为 4。在 phpstorm 中直接在 testAbs 函数处右键选择 run UserServiceTest 执行：

发如今控制台会输出以下内容

Time: 17 ms, Memory: 4.00MB

OK (1 test, 1 assertion)

代表 abs 经过了 $userService->abs(4) == 4 的测试用例。这里注意一点，这里并不代表 abs 函数已经经过测试，一个良好的测试应该包含多个测试用例来覆盖尽量多的可能性。

如今 PHPUnit 基本的单元测试已经运行成功了，在 [PHPUnit 的文档]中，有更多关于测试的用法。因为 PHPUnit 的用法过多，这里不能一一说明，这里提一些其余用法。

PHPUnit 提供了 @test 的注解，若是一个测试函数添加了 @test 注解，那么测试函数名字就没必要以 test 开头。
\PHPUnit\Framework\TestCase 有一个 setUp 函数，若是本身编写的测试类重写了这个函数，那么每次在开始执行测试函数以前，会先执行 setUp 进行测试以前的初始化。一样，也有一个 tearDown 的函数，若是重写，那么在测试函数执行完毕以后调用 tearDown 函数。
.... 更多的内容需参考 PHPUnit 的文档。

phpunit.xml 文件

在上面的例子中，咱们使用 phpstorm 逐个执行测试函数，可是若是咱们须要一次性执行全部的单元测试，那么咱们能够编写 phpunit.xml 文件来实现。

给出一个 phpunit.xml 的编写例子来说解 phpunit.xml 的做用

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    <testsuites>
        <testsuite>
            <directory>test</directory>
        </testsuite>
    </testsuites>
</phpunit>

这里 <directory>test</directory> 指定了测试代码都放在 test 目录下，在 phpstorm 下右键点击 phpunit.xml 文件选择 Run phpunit.xml，phpunit 就会到 test 目录下查找全部单元测试并逐个执行。

除了使用 phpunit.xml 来一次性执行全部的单元测试，还能够在 phpunit.xml 中配置单元测试结果的输出日志。

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    .....
    <logging>
        <log type="testdox-html" target="tmp/log.html"/>
    </logging>
</phpunit>

此时在执行 phpunit.xml 文件，就会在项目目录下生成一个 tmp/log.html 文件，这个文件记录了全部单元测试的结果。

固然，更多 phpunit.xml 配置相关的内容，仍是须要查看文档。

Mock 测试

PHPUnit 还提供了 Mock 测试。这里先介绍一下什么是 Mock 测试。

假设 foo 函数调用了 bar 函数，那么在对 foo 函数进行单元测试会有两个问题：

foo 函数依赖于 bar 函数的结果，那么在对 foo 进行单元测试的时候必然会引入 bar ，那么这样子单元测试就没意义了，若是测试不经过，那么没法保证 bug 出在 foo 仍是 bar。
bar 函数可能在测试环境不可执行，那么 foo 没法获取 bar 的执行结果，从而没法对 foo 进行单元测试。

Mock 测试就是为了解决上面的问题而出现的，使用 Mock 咱们能够虚拟出一个 bar 的调用，而且假设 bar 调用返回结果。若是仍是听不懂，上一段代码就知道了。

class MockTest extends \PHPUnit\Framework\TestCase {
    public function testGet()
    {  
        $stub = $this->createMock(\App\UserService::class);     //1
        $stub->method('get')->willReturn(3);                     //2
        $this->assertEquals(3,$stub->get(1));                      //3
    } 
}

上面的测试函数就使用到了 Mock，一行一行代码来分析：

第一行建立了一个虚拟的 UserService 对象。
第二行假设 UserService 中的 get 函数的返回值为 3。
第三行调用 $stub->get(1) 不会真的去执行 get 函数，而是根据第二行的 willReturn 函数直接返回 3。

以上就是一个简单的 Mock 测试，固然 Mock 测试还有不少复杂的用法，这里没办法一一展开，其实掌握基本的用法，更多复杂的高级用法在实践中碰到了再去查看文档也不迟。

好了，PHPUnit 的基本操做就这些了，单元测试自己并非一个很难的东西，阻碍单元测试的进行并非在技术上，更多的是一个项目时间安排的衡量与考虑。