当前位置：首页 > PHP教程 > php应用 > 列表

PHP单元测试框架PHPUnit用法详解

发布:smiling　来源: PHP粉丝网 　添加日期：2021-11-05 10:25:32　浏览: 评论：0　

本文实例讲述了PHP单元测试框架PHPUnit用法，分享给大家供大家参考，具体如下：

以前在学习IOS开发时有专门写过Objective-C的单元测试的文章，IOS开发学习之单元测试，今天再总结下怎么在PHP中使用单元测试。

一、前言

在这篇文章中，我们使用 composer 的依赖包管理工具进行phpunit包安装和管理，composer 官方地址 https://getcomposer.org/，按照提示进行全局安装即可，另外，我们也会使用一个非常好用的Monolog记录日志组件记录日志，方便我们查看。

在根目录下建立 coomposer.json 的配置文件,输入以下内容:

  1. { 
  2.   "autoload": { 
  3.     "classmap": [ 
  4.       "./" 
  5.     ] 
  6.   } 
  7. } 

上面的意思是将根目录下的所有的类文件都加载进来， 在命令行执行 composer install 后，在根目录会生成出一个vendor的文件夹，我们以后通过 composer 安装的任何第三方代码都会被生成在这里。

二、为什么要单元测试？

只要你想到输入一些东西到print语句或调试表达式中，就用测试代替它。 --Martin Fowler

PHPUnit 是一个用PHP编程语言开发的开源软件，是一个单元测试框架。PHPUnit由Sebastian Bergmann创建，源于Kent Beck的SUnit，是xUnit家族的框架之一。

单元测试是对单独的代码对象进行测试的过程，比如对函数、类、方法进行测试。单元测试可以使用任意一段已经写好的测试代码，也可以使用一些已经存在的测试框架，比如JUnit、PHPUnit或者Cantata++，单元测试框架提供了一系列共同、有用的功能来帮助人们编写自动化的检测单元，例如检查一个实际的值是否符合我们期望的值的断言。单元测试框架经常会包含每个测试的报告，以及给出你已经覆盖到的代码覆盖率。

总之一句话，使用 phpunit 进行自动测试，会使你的代码更健壮，减少后期维护的成本，也是一种比较标准的规范，现如今流行的PHP框架都带了单元测试，如Laraval,Symfony,Yii2等，单元测试已经成了标配。

另外，单元测试用例是通过命令操控测试脚本的，而不是通过浏览器访问URL的。

三、安装PHPUnit

使用 composer 方式安装 PHPUnit，其他安装方式请看这里

composer require --dev phpunit/phpunit ^6.2

安装 Monolog 日志包,做 phpunit 测试记录日志用。

composer require monolog/monolog

安装好之后，我们可以看coomposer.json 文件已经有这两个扩展包了：

  1. "require": { 
  2.   "monolog/monolog": "^1.23", 
  3.   }, 
  4. "require-dev": { 
  5.     "phpunit/phpunit": "^6.2" 
  6.   }, 

四、PHPUnit简单用法

1、单个文件测试

创建目录tests，新建文件 StackTest.php，编辑如下：

  1. <?php 
  2. /** 
  3.  * 1、composer 安装Monolog日志扩展，安装phpunit单元测试扩展包 
  4.  * 2、引入autoload.php文件 
  5.  * 3、测试案例 
  6.  * 
  7.  * 
  8.  */ 
  9. namespace App\tests; 
  10. require_once __DIR__ . '/../vendor/autoload.php'; 
  11. define("ROOT_PATH", dirname(__DIR__) . "/"); 
  12. use Monolog\Logger; 
  13. use Monolog\Handler\StreamHandler; 
  14. use PHPUnit\Framework\TestCase; 
  15. class StackTest extends TestCase 
  16. { 
  17.   public function testPushAndPop() 
  18.   { 
  19.     $stack = []; 
  20.     $this->assertEquals(0, count($stack)); 
  21.     array_push($stack, 'foo'); 
  22.     // 添加日志文件,如果没有安装monolog，则有关monolog的代码都可以注释掉 
  23.     $this->Log()->error('hello', $stack); 
  24.     $this->assertEquals('foo', $stack[count($stack)-1]); 
  25.     $this->assertEquals(1, count($stack)); 
  26.     $this->assertEquals('foo', array_pop($stack)); 
  27.     $this->assertEquals(0, count($stack)); 
  28.   } 
  29.   public function Log() 
  30.   { 
  31.     // create a log channel 
  32.     $log = new Logger('Tester'); 
  33.     $log->pushHandler(new StreamHandler(ROOT_PATH . 'storage/logs/app.log', Logger::WARNING)); 
  34.     $log->error("Error"); 
  35.     return $log; 
  36.   } 
  37. } 

代码解释：

StackTest为测试类

StackTest 继承于 PHPUnit\Framework\TestCase

测试方法testPushAndPop()，测试方法必须为public权限，一般以test开头，或者你也可以选择给其加注释@test来表

在测试方法内，类似于 assertEquals() 这样的断言方法用来对实际值与预期值的匹配做出断言。

命令行执行:

phpunit 命令 测试文件命名

  1. ➜ framework# ./vendor/bin/phpunit tests/StackTest.php 
  2. // 或者可以省略文件后缀名 
  3. // ./vendor/bin/phpunit tests/StackTest 

执行结果：

  1. ➜  framework# ./vendor/bin/phpunit tests/StackTest.php 
  2. PHPUnit 6.4.1 by Sebastian Bergmann and contributors. 
  3. .                                                                   1 / 1 (100%) 
  4. Time: 56 ms, Memory: 4.00MB 
  5. OK (1 test, 5 assertions) 

我们可以在app.log文件中查看我们打印的日志信息。

2、类文件引入

Calculator.php

  1. <?php 
  2. class Calculator 
  3. { 
  4.   public function sum($a, $b) 
  5.   { 
  6.     return $a + $b; 
  7.   } 
  8. } 
  9. ?> 

单元测试类：

CalculatorTest.php

  1. <?php 
  2. namespace App\tests; 
  3. require_once __DIR__ . '/../vendor/autoload.php'; 
  4. require "Calculator.php"; 
  5. use PHPUnit\Framework\TestCase; 
  6. class CalculatorTest extends TestCase 
  7. { 
  8.   public function testSum() 
  9.   { 
  10.     $obj = new Calculator; 
  11.     $this->assertEquals(0, $obj->sum(0, 0)); 
  12.   } 
  13. } 

命令执行：

> ./vendor/bin/phpunit tests/CalculatorTest

执行结果：

  1. PHPUnit 6.4.1 by Sebastian Bergmann and contributors. 
  2.  
  3. F                                                                   1 / 1 (100%) 
  4. Time: 117 ms, Memory: 4.00MB 
  5. There was 1 failure: 

如果我们把这里的断言故意写错，$this->assertEquals(1, $obj->sum(0, 0));

看执行结果：

  1. PHPUnit 6.4.1 by Sebastian Bergmann and contributors. 
  2. F                                                                   1 / 1 (100%) 
  3. Time: 117 ms, Memory: 4.00MB 
  4. There was 1 failure: 
  5. 1) App\tests\CalculatorTest::testSum 
  6. Failed asserting that 0 matches expected 1. 
  7. /Applications/XAMPP/xamppfiles/htdocs/web/framework/tests/CalculatorTest.php:22 
  8. FAILURES! 
  9. Tests: 1, Assertions: 1, Failures: 1. 

会直接报出方法错误信息及行号，有助于我们快速找出bug

3、高级用法

你是否已经厌烦了在每一个测试方法命名前面加一个test，是否因为只是调用的参数不同，却要写多个测试用例而纠结？我最喜欢的高级功能，现在隆重推荐给你，叫做框架生成器。

Calculator.php

  1. <?php 
  2. class Calculator 
  3. { 
  4.   public function sum($a, $b) 
  5.   { 
  6.     return $a + $b; 
  7.   } 
  8. } 
  9. ?> 

命令行启动测试用例，使用关键字 --skeleton

> ./vendor/bin/phpunit --skeleton Calculator.php

执行结果：

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

Wrote test class skeleton for Calculator to CalculatorTest.php.

是不是很简单，因为没有测试数据，所以这里加测试数据，然后重新执行上边的命令

  1. <?php 
  2. class Calculator 
  3. { 
  4.   /** 
  5.    * @assert (0, 0) == 0 
  6.    * @assert (0, 1) == 1 
  7.    * @assert (1, 0) == 1 
  8.    * @assert (1, 1) == 2 
  9.    */ 
  10.   public function sum($a, $b) 
  11.   { 
  12.     return $a + $b; 
  13.   } 
  14. } 
  15. ?> 

原始类中的每个方法都进行@assert注解的检测。这些被转变为测试代码，像这样

  1. /** 
  2.  * Generated from @assert (0, 0) == 0. 
  3.  */ 
  4. public function testSum() { 
  5.   $obj = new Calculator; 
  6.   $this->assertEquals(0, $obj->sum(0, 0)); 
  7. } 

执行结果：

  1. ./vendor/bin/phpunit tests/CalculatorTest 
  2. PHPUnit 6.4.1 by Sebastian Bergmann and contributors. 
  3. .... 
  4. Time: 0 seconds 
  5. OK (4 tests)

Tags: PHP单元测试 PHPUnit

分享到：

相关文章

推荐文章

热门文章

最新评论文章