PHP單元測試框架PHPUnit的使用

Corwien發表於2019-02-16
PHP框架

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

一、前言

在這篇文章中，我們使用 composer 的依賴包管理工具進行phpunit包安裝和管理，composer 官方地址 https://getcomposer.org/，按照提示進行全域性安裝即可，另外，我們也會使用一個非常好用的Monolog記錄日誌元件記錄日誌，方便我們檢視。

在根目錄下建立 coomposer.json 的配置檔案,輸入以下內容:

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

上面的意思是將根目錄下的所有的類檔案都載入進來， 在命令列執行 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 檔案已經有這兩個擴充套件包了：

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

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

四、PHPUnit簡單用法

1、單個檔案測試

建立目錄tests，新建檔案 StackTest.php，編輯如下：

<?php
/**
 * 1、composer 安裝Monolog日誌擴充套件，安裝phpunit單元測試擴充套件包
 * 2、引入autoload.php檔案
 * 3、測試案例
 *
 *
 */
namespace App	ests;
require_once __DIR__ . `/../vendor/autoload.php`;
define("ROOT_PATH", dirname(__DIR__) . "/");

use MonologLogger;
use MonologHandlerStreamHandler;

use PHPUnitFrameworkTestCase;


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 繼承於 PHPUnitFrameworkTestCase
  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檔案中檢視我們列印的日誌資訊。

2、類檔案引入

Calculator.php

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

單元測試類：
CalculatorTest.php

<?php

namespace App	ests;
require_once __DIR__ . `/../vendor/autoload.php`;
require "Calculator.php";

use PHPUnitFrameworkTestCase;


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	estsCalculatorTest::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

3、高階用法

你是否已經厭煩了在每一個測試方法命名前面加一個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)

4、其他用法

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

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

相關文章