PHP 单元测试

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

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

安装

安装 PHPUnit 的方式很简单,使用 composer 可以一行代码就可以安装。

1
composer require --dev phpunit/phpunit

安装之后,在 vendor/bin 目录下有一个 phpunit 的可执行文件,这个就是 phpunit 本体了

假设我们项目的目录结构如下:

1
2
3
4
5
6
7
8
➜  phpunit tree .

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

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

1
2
3
4
5
6
7
8
9
10
{
"autoload": {
"psr-4": {
"Controller\\": "controller/",
"Model\\": "model/",
"Service\\": "service/",
"Test\\": "test/",
}
},
}

使用

好了,假设我们现在进行开发,在 service 目录中添加了一个 CalculateService 的文件,并且编写了一个 abs 的函数。

1
2
3
4
5
6
7
8
9
10
11
<?php

namespace Service;

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

现在我们对 abs 函数进行单元测试,PHPUnit 规定了一个测试类必须遵守如下的规定:

  • 单元测试类名必须以 Test 结尾,必须继承 \PHPUnit\Framework\TestCase 基类。
  • 每个测试函数必须以 test 开头。

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?php

namespace Test;

use Service\CalculateService;
use PHPUnit\Framework\TestCase;

class CalculateServiceTest extends TestCase
{
public function testAbs()
{
$calculateService = new CalculateService();
$this->assertEquals(4, $calculateService->abs(4));
}
}

在上面的测试代码中,调用了我们要测试的函数 abs,然后断言 $calculateService->abs(4) 的结果为 4。在 phpstorm 中直接在 testAbs 函数处右键选择 run CalculateServiceTest 执行:

发现在控制台会输出如下内容

1
2
3
4
5
Time: 00:00.068, Memory: 6.00 MB

OK (1 test, 1 assertion)

Process finished with exit code 0

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

Powered by Hexo and Hexo-theme-hiker

Copyright © 2017 - 2021 Keep It Simple And Stupid All Rights Reserved.

访客数 : | 访问量 :