PHP 单元测试

娣辩孩发布于2019-06-28 14:34 / 2360人阅读

摘要：上面的规定是必须遵守的，如果代码没有遵守规定不会把他当做单元测试代码。每个单元测试类以被测试的类名开头。每个单元测试函数应该为被测试函数名结尾。函数可能在测试环境不可执行，那么无法获取的执行结果，从而无法对进行单元测试。

本文首发于 https://jaychen.cc/article/34
作者 Jaychen

朋友，你听说过安。。。不是，写过单元测试吗。

单元测试是开发过程中必不可少的一环，一个项目有良好的单元测试代码，重构的勇气都大很多。这次写一篇小文来介绍一下 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 自动加载的使用，可以参考这篇文章。最后执行 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 结尾，必须继承 PHPUnitFrameworkTestCase 基类。

每个测试函数必须以 test 开头。

上面的规定是必须遵守的，如果代码没有遵守规定 PHPUnit 不会把他当做单元测试代码。除了以上的两条，还有一些良好的编码习惯可以参考：

单元测试代码都放在 test 目录下。

每个单元测试类以被测试的类名开头。例如被测试类为 CalculateService，那么单元测试类应该为 CalculateServiceTest。

每个单元测试函数应该为被测试函数名结尾。例如被测试函数为 abs，那么单元测试函数应该为 testAbs。

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

class UserServiceTest extends PHPUnitFrameworkTestCase
{
    public function testAbs()
    {
        $userService = new ServiceCalculateService();
        $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 开头。

PHPUnitFrameworkTestCase 有一个 setUp 函数，如果自己编写的测试类重写了这个函数，那么每次在开始执行测试函数之前，会先执行 setUp 进行测试之前的初始化。同样，也有一个 tearDown 的函数，如果重写，那么在测试函数执行完毕之后调用 tearDown 函数。

.... 更多的内容需参考 PHPUnit 的文档。

phpunit.xml 文件

在上面的例子中，我们使用 phpstorm 逐个执行测试函数，但是如果我们需要一次性执行所有的单元测试，那么我们可以编写 phpunit.xml 文件来实现。

给出一个 phpunit.xml 的编写例子来讲解 phpunit.xml 的作用



    
        
            test

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

除了使用 phpunit.xml 来一次性执行所有的单元测试，还可以在 phpunit.xml 中配置单元测试结果的输出日志。



    .....

此时在执行 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 PHPUnitFrameworkTestCase {
    public function testGet()
    {  
        $stub = $this->createMock(AppUserService::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 的基本操作就这些了，单元测试本身并不是一个很难的东西，阻碍单元测试的进行并不是在技术上，更多的是一个项目时间安排的衡量与考虑。

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/26256.html

PHPUnit实践一（初识）

摘要：另外一些单元测试可能会测试负向路径的场景，保证代码不仅会产生错误，而且是预期的错误。是一个面向程序员的测试框架，这是一个的体系结构的单元测试框架。本系列教程所有的PHPUnit测试基于PHPUnit6.5.9版本，Lumen 5.5框架前置日常我们的普通用到的测试：代码直接echo，debug等方法测试 -> 跟踪细节断点型测试 log日志辅助测试 -> 跟踪细节断点型测试 ...

weapon 2019-07-01 11:17 评论0 收藏0
PHPUnit实践一（初识）

摘要：另外一些单元测试可能会测试负向路径的场景，保证代码不仅会产生错误，而且是预期的错误。是一个面向程序员的测试框架，这是一个的体系结构的单元测试框架。本系列教程所有的PHPUnit测试基于PHPUnit6.5.9版本，Lumen 5.5框架前置日常我们的普通用到的测试：代码直接echo，debug等方法测试 -> 跟踪细节断点型测试 log日志辅助测试 -> 跟踪细节断点型测试 ...

hss01248 2019-05-29 17:12 评论0 收藏0
写一个“特殊”的查询构造器 - (八、单元测试、收尾工作)

摘要：单元测试的好处是给开发人员的，并不是给机器的。对于查询构造器这个项目，我们可以让其在远程运行环境安装相关数据库软件，执行数据表建立，数据导入，执行单元测试等操作。查询构造器的完整代码查询构造器的单元测试完整代码。 debug 模式对查询构造器进行调试并不难，从其构造 SQL -> 数据绑定 -> SQL 执行的过程中就能发现，要方便调试，只要可以观察以下信息：构造的 SQL 绑定...

Steve_Wang_ 2019-07-01 10:01 评论0 收藏0
PHP单元测试框架PHPUnit的使用

摘要：以前在学习开发时有专门写过的单元测试的文章，开发学习之单元测试，今天再总结下怎么在中使用单元测试。是一个用编程语言开发的开源软件，是一个单元测试框架。单元测试框架经常会包含每个测试的报告，以及给出你已经覆盖到的代码覆盖率。以前在学习IOS开发时有专门写过Objective-C的单元测试的文章，IOS开发学习之单元测试，今天再总结下怎么在PHP中使用单元测试。一、前言在这篇文章中，...

Bryan 2019-07-01 12:23 评论0 收藏0
PHP 单元测试与数据库测试

摘要：只实例化一次，供测试的清理和装载基境使用对于每个测试，只实例化一次至今为止，完成了最基础和入门的单元测试和数据库测试，最终数据库无非就是查看数据增删改查是否和预期一样。恭喜你，你已经构建完自己的单元测试环境了。我总感觉 PHP 的开发者们并没有对 PHP 的质量有所追求，可能是因为 PHP 的机制问题吧，让大部分的开发者总以为浏览器访问就没有问题，所以很多时候，做 PHP 开发的，就...

hersion 2019-06-27 15:58 评论0 收藏0