PHP單元測試框架PHPUnit的使用

之前在學習IOS開發時有專門寫過Objective-C的單元測試的文章，IOS開發學習之單元測試，今天再總結下怎麼在PHP中使用單元測試。

1、前言

在這篇文章中，咱們使用 composer 的依賴包管理工具進行phpunit包安裝和管理，composer 官方地址 https://getcomposer.org/，按照提示進行全局安裝便可，另外，咱們也會使用一個很是好用的Monolog記錄日誌組件記錄日誌，方便咱們查看。

在根目錄下創建 coomposer.json 的配置文件,輸入如下內容:

{
    "autoload": {
        "classmap": [
            "./"
        ]
    }
}

上面的意思是將根目錄下的全部的類文件都加載進來， 在命令行執行 composer install 後，在根目錄會生成出一個vendor的文件夾，咱們之後經過 composer 安裝的任何第三方代碼都會被生成在這裏。

2、爲何要單元測試？

只要你想到輸入一些東西到print語句或調試表達式中，就用測試代替它。 --Martin Fowler

PHPUnit 是一個用PHP編程語言開發的開源軟件，是一個單元測試框架。PHPUnit由Sebastian Bergmann建立，源於Kent Beck的SUnit，是xUnit家族的框架之一。

單元測試是對單獨的代碼對象進行測試的過程，好比對函數、類、方法進行測試。單元測試可使用任意一段已經寫好的測試代碼，也可使用一些已經存在的測試框架，好比JUnit、PHPUnit或者Cantata++，單元測試框架提供了一系列共同、有用的功能來幫助人們編寫自動化的檢測單元，例如檢查一個實際的值是否符合咱們指望的值的斷言。單元測試框架常常會包含每一個測試的報告，以及給出你已經覆蓋到的代碼覆蓋率。

總之一句話，使用 phpunit 進行自動測試，會使你的代碼更健壯，減小後期維護的成本，也是一種比較標準的規範，現現在流行的PHP框架都帶了單元測試，如Laraval,Symfony,Yii2等，單元測試已經成了標配。

另外，單元測試用例是經過命令操控測試腳本的，而不是經過瀏覽器訪問URL的。

3、安裝PHPUnit

使用 composer 方式安裝 PHPUnit，其餘安裝方式請看這裏

composer require --dev phpunit/phpunit ^6.2

安裝 Monolog 日誌包,作 phpunit 測試記錄日誌用。

composer require monolog/monolog

安裝好以後，咱們能夠看coomposer.json 文件已經有這兩個擴展包了：

"require": {  
     "monolog/monolog": "^1.23",
    },

 "require-dev": {
        "phpunit/phpunit": "^6.2"
    },

4、PHPUnit簡單用法

一、單個文件測試

建立目錄tests，新建文件 StackTest.php，編輯以下：

<?php
/**
 * 一、composer 安裝Monolog日誌擴展，安裝phpunit單元測試擴展包
 * 二、引入autoload.php文件
 * 三、測試案例
 *
 *
 */
namespace App\tests;
require_once __DIR__ . '/../vendor/autoload.php';
define("ROOT_PATH", dirname(__DIR__) . "/");

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

use PHPUnit\Framework\TestCase;


class StackTest extends TestCase
{
    public function testPushAndPop()
    {
        $stack = [];
        $this->assertEquals(0, count($stack));

        array_push($stack, 'foo');

        // 添加日誌文件,若是沒有安裝monolog，則有關monolog的代碼均可以註釋掉
        $this->Log()->error('hello', $stack);

        $this->assertEquals('foo', $stack[count($stack)-1]);
        $this->assertEquals(1, count($stack));

        $this->assertEquals('foo', array_pop($stack));
        $this->assertEquals(0, count($stack));
    }

    public function Log()
    {
        // create a log channel
        $log = new Logger('Tester');
        $log->pushHandler(new StreamHandler(ROOT_PATH . 'storage/logs/app.log', Logger::WARNING));
        $log->error("Error");
        return $log;
    }
}

代碼解釋：

1. StackTest爲測試類
2. StackTest 繼承於 PHPUnit\Framework\TestCase
3. 測試方法testPushAndPop()，測試方法必須爲public權限，通常以test開頭，或者你也能夠選擇給其加註釋@test來表
4. 在測試方法內，相似於 assertEquals() 這樣的斷言方法用來對實際值與預期值的匹配作出斷言。

命令行執行:
phpunit 命令 測試文件命名

➜  framework#  ./vendor/bin/phpunit tests/StackTest.php

// 或者能夠省略文件後綴名
//  ./vendor/bin/phpunit tests/StackTest

執行結果：

➜  framework# ./vendor/bin/phpunit tests/StackTest.php
PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 56 ms, Memory: 4.00MB

OK (1 test, 5 assertions)

咱們能夠在app.log文件中查看咱們打印的日誌信息。

二、類文件引入

Calculator.php

<?php  
class Calculator  
{  
    public function sum($a, $b)  
    {  
        return $a + $b;  
    }  
}  
?>

單元測試類：
CalculatorTest.php

<?php

namespace App\tests;
require_once __DIR__ . '/../vendor/autoload.php';
require "Calculator.php";

use PHPUnit\Framework\TestCase;


class CalculatorTest extends TestCase
{
    public function testSum()
    {
        $obj = new Calculator;
        $this->assertEquals(0, $obj->sum(0, 0));

    }

}

命令執行：

> ./vendor/bin/phpunit tests/CalculatorTest

執行結果：

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 117 ms, Memory: 4.00MB

There was 1 failure:

若是咱們把這裏的斷言故意寫錯，$this->assertEquals(1, $obj->sum(0, 0));
看執行結果：

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 117 ms, Memory: 4.00MB

There was 1 failure:

1) App\tests\CalculatorTest::testSum
Failed asserting that 0 matches expected 1.

/Applications/XAMPP/xamppfiles/htdocs/web/framework/tests/CalculatorTest.php:22

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

會直接報出方法錯誤信息及行號，有助於咱們快速找出bug

三、高級用法

你是否已經厭煩了在每個測試方法命名前面加一個test，是否由於只是調用的參數不一樣，卻要寫多個測試用例而糾結？我最喜歡的高級功能，如今隆重推薦給你，叫作框架生成器。

Calculator.php

<?php  
class Calculator  
{  
    public function sum($a, $b)  
    {  
        return $a + $b;  
    }  
}  
?>

命令行啓動測試用例，使用關鍵字 --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.

是否是很簡單，由於沒有測試數據，因此這裏加測試數據，而後從新執行上邊的命令

<?php  
class Calculator  
{  
    /** 
     * @assert (0, 0) == 0 
     * @assert (0, 1) == 1 
     * @assert (1, 0) == 1 
     * @assert (1, 1) == 2 
     */  
    public function sum($a, $b)  
    {  
        return $a + $b;  
    }  
}  
?>

原始類中的每一個方法都進行@assert註解的檢測。這些被轉變爲測試代碼，像這樣

/**
     * Generated from @assert (0, 0) == 0.
     */
    public function testSum() {
        $obj = new Calculator;
        $this->assertEquals(0, $obj->sum(0, 0));
    }

執行結果：

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

四、其餘用法

其餘用法請參考官網：PHPUnit中國官網

---

參考文章：
PHPUnit中國官網文檔