使用PHPUnit進行單元測試

1. 一、說明
2. 二、環境
3. 三、安裝
   1. 3.1 PHP 檔案包(PHAR) - 全域安裝
   2. 3.2 Composer安裝
4. 四、Xdebug安裝
5. 五、產生設定檔
   1. 5.1 指令：
   2. 5.2 設定目標：
   3. 5.3 修改設定-程式碼覆蓋率
6. 六、編寫PHPUnit 測試
7. 七、執行測試
8. 八、程式碼覆蓋率分析
9. 九、常用測試函式
10. 十、參考

一、說明

• 使用PHPUnit進行單元測試，並產生測試報告

二、環境

• Ubuntu 16.04
• Nginx
• PHP 7

三、安裝

3.1 PHP 檔案包(PHAR) - 全域安裝

將PHPUnit安裝到Linux開發環境中，以免在各專案中重複安裝

$ # 抓取phar檔案包
$ wget https://phar.phpunit.de/phpunit-6.5.phar

$ # 加入可執行屬性
$ chmod +x phpunit-6.5.phar

$ # 搬移至命令路徑 /usr/local/bin/ 下，並更名為 phpunit
$ sudo mv phpunit-6.5.phar /usr/local/bin/phpunit

$ # 查看版本
$ phpunit --version
PHPUnit x.y.z by Sebastian Bergmann and contributors.

PHPUnit 6.x 支援 PHP7.0 以上； PHPUnit 7.X 需 PHP7.1 以上

3.2 Composer安裝

$ composer require --dev phpunit/phpunit phpunit/php-invoker phpunit/dbunit

四、Xdebug安裝

如果要做程式碼覆蓋率報告，需安裝xdebug

$ sudo apt-get install php-xdebug

五、產生設定檔

5.1 指令：

$ phpunit --generate-configuration

5.2 設定目標：

PHPUnit 6.5.14 by Sebastian Bergmann and contributors.

Generating phpunit.xml in /var/www/html/my/TimePeriodHelper

Bootstrap script (relative to path shown above; default: vendor/autoload.php): 
Tests directory (relative to path shown above; default: tests): 
Source directory (relative to path shown above; default: src): 

Generated phpunit.xml in /var/www/html/my/TimePeriodHelper

• autoload檔案：vendor/autoload.php
• 測試目錄：tests
• 來源目錄：src

5.3 修改設定-程式碼覆蓋率

$ vi phpunit.xml

• 全部統計覆蓋率，不使用@covers標籤聲明統計範圍

  forceCoversAnnotation="false"

• 增加程式碼覆蓋率報告參數

  <logging>
      <log type="coverage-html"
          target="./report"
          charset="UTF-8"
          highlight="false"
          lowUpperBound="35"
          highLowerBound="70" />
  </logging>
  <filter>
      <blacklist>
          <directory>/path/to/.composer</directory>
      </blacklist>
  </filter>

  logging 與 log 表示要使用的報告格式； filter 是過濾覆蓋的範圍，可以用 blacklist 子標籤 來去掉不想覆蓋的目錄或檔案。

六、編寫PHPUnit 測試

要點：

• 針對類別Class的測試寫在類別ClassTest中。
• ClassTest（通常）繼承自 PHPUnit\Framework\TestCase。
• 測試都是命名為test*的公開(public)方法。
    也可以在方法的文檔註釋塊(docblock)中使用@test標註將其標記為測試方法。
• 在測試方法內，類似於assertSame()(參見appendixes.assertions )這樣的斷言方法用來對實際值與預期值的匹配做出斷言。

Example 2.1:

<?php
use PHPUnit\Framework\TestCase;

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

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

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

七、執行測試

# 有設定好phpunit.xml檔案，直接執行phpunit即可
$ phpunit

# 使用參數執行
$ phpunit -c phpunit.xml --coverage-html reportPatch/

執行結果

PHPUnit 6.5.14 by Sebastian Bergmann and contributors.

Runtime:       PHP 7.0.33-0ubuntu0.16.04.4
Configuration: /var/www/html/my/TimePeriodHelper/phpunit.xml

.                                                                   1 / 1 (100%)

Time: 71 ms, Memory: 8.00MB

OK (1 test, 1 assertion)

八、程式碼覆蓋率分析

覆蓋率分析產生後，存放於 reportPatch/ 中，畫面如下圖

• 總覽

  

• 覆蓋率報告-程式檔總覽

  

• 覆蓋率報告-覆蓋狀況

  

• 覆蓋率報告-圖例

  

九、常用測試函式

• assertEquals()
• assertNotEquals()
• assertEmpty()
• assertInstanceOf()

十、參考

• PHPUnit Manual
• PHPUnit.de
• PHPUnit in Action