PHPUnit 數(shù)據(jù)庫測試用例的配置

PHPUnit 數(shù)據(jù)庫測試用例的配置

一般而言，使用 PHPUnit 時(shí)，測試用例都是按如下方式擴(kuò)展自 PHPUnit_Framework_TestCase 類：

<?php
class MyTest extends PHPUnit_Framework_TestCase
{
    public function testCalculate()
    {
        $this->assertEquals(2, 1 + 1);
    }
}
?>

如果測試代碼用到了數(shù)據(jù)庫擴(kuò)展模塊，那么建立的過程就會更復(fù)雜一些，需要擴(kuò)展另一個(gè)抽象 TestCase 類，它要求實(shí)現(xiàn)兩個(gè)抽象方法，getConnection() 和 getDataSet()：

<?php
class MyGuestbookTest extends PHPUnit_Extensions_Database_TestCase
{
    /**
     * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
     */
    public function getConnection()
    {
        $pdo = new PDO('sqlite::memory:');
        return $this->createDefaultDBConnection($pdo, ':memory:');
    }

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

實(shí)現(xiàn) getConnection()

為了讓清理與載入基境的功能正常運(yùn)作，PHPUnit 數(shù)據(jù)庫擴(kuò)展模塊需要用 PDO 庫來實(shí)現(xiàn)跨供應(yīng)商抽象訪問數(shù)據(jù)庫連接。重要的是要注意到，使用 PHPUnit 的數(shù)據(jù)庫擴(kuò)展模塊并不要求應(yīng)用程序本身基于PDO，PDO連接僅僅用于清理和建立基境。

在之前的例子里，我們在內(nèi)存中創(chuàng)建 Sqlite 數(shù)據(jù)庫并建立了連接，將此連接傳遞給 createDefaultDBConnection 方法，這個(gè)方法將 PDO 實(shí)例和第二參數(shù)（數(shù)據(jù)庫名）包裝在一個(gè)非常簡單的數(shù)據(jù)庫連接抽象層中，這個(gè)抽象層的類型是 PHPUnit_Extensions_Database_DB_IDatabaseConnection。

“使用數(shù)據(jù)庫連接”一節(jié)解說了這個(gè)接口的API以及如何充分利用它們。

實(shí)現(xiàn) getDataSet()

getDataSet() 方法定義了在每個(gè)測試執(zhí)行之前的數(shù)據(jù)庫初始狀態(tài)應(yīng)該是什么樣。數(shù)據(jù)庫的狀態(tài)通過由 PHPUnit_Extensions_Database_DataSet_IDataSet 所代表的 DataSet（數(shù)據(jù)集）和由 PHPUnit_Extensions_Database_DataSet_IDataTable所代表的 DataTable（數(shù)據(jù)表）這兩個(gè)概念進(jìn)行抽象。下一節(jié)將詳細(xì)講述這些概念是如何運(yùn)作的以及在數(shù)據(jù)庫測試中使用它們有什么好處。

對于具體實(shí)現(xiàn)，只需要知道 setUp() 中會調(diào)用一次 getDataSet() 方法來接收基境數(shù)據(jù)集并將其插入數(shù)據(jù)庫。在范例中使用了工廠方法 createFlatXMLDataSet($filename)，它代表一個(gè)用 XML 表示的數(shù)據(jù)集。

數(shù)據(jù)庫構(gòu)架(DDL)怎么辦？

PHPUnit 假設(shè)在測試運(yùn)行之前數(shù)據(jù)庫以及其中的所有表(table)、觸發(fā)器(trigger)、序列(Sequence)和視圖(view)都已經(jīng)創(chuàng)建好。這意味著開發(fā)者必須在運(yùn)行測試套件之前確保數(shù)據(jù)庫已經(jīng)正確建立。

有幾種方法來達(dá)成這個(gè)數(shù)據(jù)庫測試的先決條件。

1. 如果使用的是持久化數(shù)據(jù)庫(不是 Sqlite Memory)，可以很輕松地用 phpMyAdmin（針對MySQL）之類的工具來一次性建立數(shù)據(jù)庫，并在每個(gè)測試中復(fù)用這個(gè)數(shù)據(jù)庫。

2. 如果使用的是諸如 Doctrine 2 或 Propel 這樣的庫，可以用它們的API來在測試運(yùn)行前一次性建立所需的數(shù)據(jù)庫?？梢岳?PHPUnit 的引導(dǎo)和配置 功能來在每次測試運(yùn)行時(shí)執(zhí)行這些代碼。

小建議：使用你自己的抽象數(shù)據(jù)庫 TestCase 類

從前面的實(shí)現(xiàn)范例中容易發(fā)現(xiàn) getConnection() 方法是相當(dāng)穩(wěn)定的，可以在不同的數(shù)據(jù)庫測試用例中重用。另外，為了保持測試的性能良好和數(shù)據(jù)庫的開銷較低，可以對代碼進(jìn)行一點(diǎn)重構(gòu)，來為應(yīng)用程序形成一個(gè)通用的抽象測試用例，同時(shí)依然可以為每個(gè)具體測試用例指定不同的數(shù)據(jù)基境：

<?php
abstract class MyApp_Tests_DatabaseTestCase extends PHPUnit_Extensions_Database_TestCase
{
    // 只實(shí)例化 pdo 一次，供測試的清理和裝載基境使用
    static private $pdo = null;

    // 對于每個(gè)測試，只實(shí)例化 PHPUnit_Extensions_Database_DB_IDatabaseConnection 一次
    private $conn = null;

    final public function getConnection()
    {
        if ($this->conn === null) {
            if (self::$pdo == null) {
                self::$pdo = new PDO('sqlite::memory:');
            }
            $this->conn = $this->createDefaultDBConnection(self::$pdo, ':memory:');
        }

        return $this->conn;
    }
}
?>

這個(gè)例子里，數(shù)據(jù)庫連接信息硬編碼在 PDO 連接里了。PHPUnit 有另外一個(gè)絕妙的特性，可以讓這個(gè) TestCase 類更加通用。通過 XML 配置 可以為每個(gè)測試單獨(dú)配置數(shù)據(jù)庫連接信息。首先，在應(yīng)用程序的 tests/ 目錄下創(chuàng)建 “phpunit.xml” 文件，內(nèi)容大體是這樣：

<?xml version="1.0" encoding="UTF-8" ?>
<phpunit>
    <php>
        <var name="DB_DSN" value="mysql:dbname=myguestbook;host=localhost" />
        <var name="DB_USER" value="user" />
        <var name="DB_PASSWD" value="passwd" />
        <var name="DB_DBNAME" value="myguestbook" />
    </php>
</phpunit>

現(xiàn)在可以修改 TestCase 類了，像這樣：

<?php
abstract class Generic_Tests_DatabaseTestCase extends PHPUnit_Extensions_Database_TestCase
{
    // 只實(shí)例化 pdo 一次，供測試的清理和裝載基境使用
    static private $pdo = null;

    // 對于每個(gè)測試，只實(shí)例化 PHPUnit_Extensions_Database_DB_IDatabaseConnection 一次
    private $conn = null;

    final public function getConnection()
    {
        if ($this->conn === null) {
            if (self::$pdo == null) {
                self::$pdo = new PDO( $GLOBALS['DB_DSN'], $GLOBALS['DB_USER'], $GLOBALS['DB_PASSWD'] );
            }
            $this->conn = $this->createDefaultDBConnection(self::$pdo, $GLOBALS['DB_DBNAME']);
        }

        return $this->conn;
    }
}
?>

現(xiàn)在可以從命令行界面以不同的配置來運(yùn)行數(shù)據(jù)庫測試套件了：

user@desktop> phpunit --configuration developer-a.xml MyTests/

user@desktop> phpunit --configuration developer-b.xml MyTests/

在開發(fā)機(jī)上進(jìn)行開發(fā)時(shí)能夠輕松的針對不同的目標(biāo)數(shù)據(jù)庫來運(yùn)行數(shù)據(jù)庫測試顯得非常重要。如果多個(gè)開發(fā)人員在同一個(gè)數(shù)據(jù)庫連接上運(yùn)行數(shù)據(jù)庫測試，很容易因?yàn)楦倯B(tài)而導(dǎo)致測試失敗。