PHP 單元測試與資料庫測試

黃總發表於2019-02-16

我總感覺 PHP 的開發者們並沒有對 PHP 的質量有所追求,可能是因為 PHP 的機制問題吧,讓大部分的開發者總以為瀏覽器訪問就沒有問題,所以很多時候,做 PHP 開發的,就沒有單元測試的這些概念了。能不能有點追求?

我個人也是 PHP,但同時我也比較討厭那些完事就算了的開發者,作為一個開發者,或者說是一個產品的經手人,就應該用心地去做好每個細節,一次比一次要更好。

但是做單元測試,質量檢查,是需要一定的時間和人力投入的,但我敢保證地說,你花時間投入的,絕對不會是沒用的,一定對你,對專案來說,是一個質的提升,只要你肯投入時間用心去做。

屁話說太多了,那接下來簡單講講 phpunit 吧,官網

因為我們習慣用 composer,所以我們也使用 composer 安裝吧。

安裝與配置

$ composer require phpunit/phpunit -vvv 

安裝完 phpunit,bin 執行指令碼會建立在 vendor/bin 目錄下,命名為 phpunit, 執行 php vendor/bin/phpunit 執行測試指令碼

配置 bin 目錄:

{
  "config": {
    "bin": "bin"
  }
}

配置 bin 目錄產生的目錄,執行 php bin/phpunit 指令碼開始測試。

phpunit 可以配置在當前執行路徑新增一個配置檔案 phpunit.xml.dist 或者 phpunit.xml,內容如下:

<phpunit
         colors="true"
         bootstrap="./vendor/autoload.php"
        >
    <testsuites>
        <testsuite>
            <directory>dir1</directory>
        </testsuite>
        <testsuite>
            <directory>dir2</directory>
        </testsuite>
    </testsuites>
</phpunit>

可以通過配置目錄和初始化資訊,讓指令碼自動執行對應的測試用例。

基礎使用

使用 PHPUnit 建立我們的測試用例:

<?php

class DemoTest extends PHPUnit_Framework_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));
        }
}

類名需要以 *Test 結尾,繼承 PHPUnit_Framework_TestCase。需要測試的方法需要一 test 開頭,表明是一個測試方法。

一般常用測試無非就是 “斷言”,說白了,就是看看產生的結果是不是符合預期,如果是,那就證明,已經測試通過,否則,失敗,說明邏輯處理,存在一定的差異,導致不符合預期。

更多的測試使用方法請看官網用例: PHPUnit

初始化

當我們的測試物件繼承了 PHPUnit 後,初始化方法就需要使用它本身提供的 setUp 方法,代表類初始化,可以在初始化方法中初始化一些資源,或者載入。

資料庫測試

除了以上基礎的測試之外,關鍵一點應該在動態的資料,需要去測試嗎,如果需要,那應該怎麼去測試? 生產環境,也需要這樣測試? 這個曾經困惑這我的問題,已經解開。

解答:

  1. composer 中,有 –no-dev 選項,用來部署生產環境,避免測試環境的資料或者程式碼跑在了生產環境下。並且生產環境上資料庫操作是沒有很高許可權的操作,要是有的話,你得回去面壁思考一下了。

  2. dbunit 每次測試都重置資料,其實在生產環境下,就重置不了了,第一個是composer –no-dev 已經沒有執行權利了,要是有,資料庫已經不允許清空操作了。

  3. 要是生產環境不需要這些東西,那麼應該怎麼測試。其實需要有一個模擬生產環境的測試環境,去模擬生產環境測試,當所有測試都OK沒有問題,那麼就可以釋出到生產環境上,要是嚴格一些,生產環境也是需要一輪測試。

$ composer require phpunit/dbunit -vvv 

更多測試可看: 資料庫測試

<?php
class DBTest extends PHPUnit_Extensions_Database_TestCase
{
    /**
     * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
     */
    public function getConnection()
    {
        $pdo = new PDO(`mysql::dbname=test;host=127.0.0.1`, `user`, `pass`);
        return $this->createDefaultDBConnection($pdo, `:memory:`);
    }

    /**
     * @return PHPUnit_Extensions_Database_DataSet_IDataSet
     */
    public function getDataSet()
    {
        return $this->createFlatXMLDataSet(dirname(__FILE__).`/_files/guestbook-seed.xml`);
    }
}

getConnection 方法是獲取資料庫連線,繼承資料庫測試後,必須實現的一個方法,並且需要返回 PHPUnit_Extensions_Database_DB_IDatabaseConnection 物件,可以仿照上述寫法即可。

getDataSet 方法是資料集,在建立資料庫測試的時候,自動填充,測試,和刪除。他執行的流程是,每個測試用例,都會填充一次,以保證不會被其他測試用例影響。噹噹前測試用例測試完成後,會 truncate 掉填充的資料。

資料集支援挺多種方法,可以自定義陣列,yml,xml,可以根據自己的使用習慣,自定義填充資料。資料集可看: 點我

執行指令碼 php vendor/bin/phpunit

然後去對應檢視自己的資料表,是否多了一些填充的資料呢?

抽象自己的資料庫測試類

在很多情況下,我們的業務可謂是各種各樣吧,倘若 phpunit 提供的資料庫測試還不能滿足或者不夠方便的時候,就需要擴充套件自己的資料庫測試,來達到自己想要的效果。

幸好,phpunit 提供了靈活的擴充套件操作(肯定啦,別人肯定不會像你這麼傻,寫死吧。哈哈),我們可以很容易地去實現自己的資料庫測試類。

<?php

abstract class MyApp_Tests_DatabaseTestCase extends PHPUnit_Extensions_Database_TestCase
{
    // 只例項化 pdo 一次,供測試的清理和裝載基境使用
    static private $pdo = null;

    // 對於每個測試,只例項化 PHPUnit_Extensions_Database_DB_IDatabaseConnection 一次
    private $conn = null;

    final public function getConnection()
    {
        if ($this->conn === null) {
            if (self::$pdo == null) {
                self::$pdo = new PDO(`mysql::dbname=test;host=127.0.0.1`, `user`, `pass`);
            }
            $this->conn = $this->createDefaultDBConnection(self::$pdo, `:memory:`);
        }

        return $this->conn;
    }
}

至今為止,完成了最基礎和入門的單元測試和資料庫測試,最終資料庫無非就是檢視資料增刪改查是否和預期一樣。所以,配置完資料庫測試後,就可以走回第一步,編寫你的測試用例,斷言測試了。

恭喜你,你已經構建完自己的單元測試環境了。接下來需要做的是,提高易用性,測試覆蓋率。我只能幫你到這裡了,接下來的路,自己走吧。

相關文章