朋友,你听说过安。。。不是,写过单元测试吗。
单元测试是开发过程中必不可少的一环,一个项目有良好的单元测试代码,重构的勇气都大很多。这次写一篇小文来介绍一下 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 规定了一个测试类必须遵守如下的规定:
上面的规定是必须遵守的,如果代码没有遵守规定 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.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 配置相关的内容,还是需要查看文档。 :laughing:
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 } }
- 第一行创建了一个虚拟的
UserService
对象。 - 第二行假设
UserService
中的get
函数的返回值为 3。 - 第三行调用
$stub->get(1)
不会真的去执行get
函数,而是根据第二行的willReturn
函数直接返回 3。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 [email protected] 举报,一经查实,本站将立刻删除。