如何使用PHPUnit進行PHP單元測試

隨著軟體開發產業的發展，測試逐漸成為了不可或缺的一部分。而單元測試作為軟體測試中最基礎的一環，不僅能夠提高程式碼質量，還能夠加快開發者開發和維護程式碼的速度。在PHP領域，PHPUnit是一個非常流行的單元測試框架，它提供了各種功能來幫助我們編寫高品質的測試案例。在本文中，我們將介紹如何使用PHPUnit進行PHP單元測試。

1. 安裝PHPUnit

在使用PHPUnit之前，我們需要先安裝它。 PHPUnit是一個PHP函式庫，可以使用Composer來安裝。在專案的根目錄下，執行以下命令：

composer require --dev phpunit/phpunit

這會將PHPUnit添加到您的專案中並且將其作為開發依賴項。

2. 編寫測試案例

編寫測試案例通常是我們使用PHPUnit的第一步。測試案例是測試一個或多個函數或方法的腳本。假設我們有一個Calculator類別：

class Calculator {
    public function add($a, $b) {
        return $a + $b;
    }
}

我們可以使用一個測試用例來測試Calculator類別中的add方法：

use PHPUnitFrameworkTestCase;

class CalculatorTest extends TestCase {
    public function testAdd() {
        $calculator = new Calculator();
        $result = $calculator->add(2, 3);
        $this->assertEquals(5, $result);
    }
}

在這個測試用例中，我們建立了一個名為CalculatorTest的測試類，它繼承了PHPUnitFrameworkTestCase類別。我們也編寫了一個名為testAdd的測試方法，在其中建立了一個Calculator實例並執行了add方法，最後使用$this->assertEquals來測試add方法傳回的結果是否與預期值相同。

3. 執行測試案例

一旦我們編寫了測試案例，我們就可以使用PHPUnit來運行它們。在我們的專案的根目錄下，執行以下命令：

vendor/bin/phpunit

這將運行PHPUnit並且執行所有可用的測試案例。如果您只想執行一個特定的測試類別或測試方法，可以使用以下命令：

vendor/bin/phpunit tests/CalculatorTest.php
vendor/bin/phpunit --filter testAdd tests/CalculatorTest.php

4. 使用斷言

PHPUnit提供了各種各樣的斷言函數，可以用來測試函數或方法的回傳值是否符合我們的預期。以下是PHPUnit中最常用的一些斷言函數：

• assertTrue($value)：測試$value是否為true
• assertFalse($value)：測試$value是否為false
• assertEquals($expected, $actual)：測試$actual是否等於$expected
• assertNotEquals($expected, $actual)：測試$actual是否不等於$expected
• assertSame($expected, $actual)：測試$actual是否與$expected相同
• assertNotSame($expected, $actual)：測試$actual是否與$expected不同
• assertNull($ value)：測試$value是否為null
• assertNotNull($value)：測試$value是否為null
• assertInstanceOf($expected, $actual)：測試$actual是否為$expected的實例
• assertNotInstanceOf($expected, $actual)：測試$actual是否不為$expected的實例

5. 使用資料提供者

有時候我們需要測試一個函數或方法對於不同的輸入是否都能正確地傳回結果。這時候我們可以使用PHPUnit的資料提供器功能。資料提供器是一個方法，它提供了一組參數，每組參數都是一個可以測試的資料集合。

在下面的範例中，我們為Calculator類別的add方法編寫了一個資料提供器，它提供了不同的輸入資料和預期輸出。

class CalculatorTest extends TestCase {
    /**
     * @dataProvider additionProvider
     */
    public function testAdd($a, $b, $expected) {
        $calculator = new Calculator();
        $result = $calculator->add($a, $b);
        $this->assertEquals($expected, $result);
    }

    public function additionProvider() {
        return [
            [0, 0, 0],
            [0, 1, 1],
            [1, 0, 1],
            [1, 1, 2],
            [2, 3, 5],
            [-1, 1, 0],
            [10, -5, 5]
        ];
    }
}

在這個測試案例中，我們使用@DataProvider註解來告訴PHPUnit在哪裡找到一個資料提供者。我們編寫了一個名為additionProvider的資料提供器，其中提供了不同的輸入資料和預期輸出。在testAdd測試方法中，我們直接傳遞了這些資料並進行測試。

6. 使用Mock物件

當我們測試一個物件中的一個方法時，我們可能不想依賴其他類別或外部資源。這時候我們可以使用PHPUnit的Mock物件來模擬這些依賴。 Mock物件是一個模擬對象，它提供了相同的接口，但是它實際上並沒有被實例化。

在下面的範例中，我們為Calculator類別中的add方法編寫了一個Mock對象，用來模擬外部依賴。

class CalculatorTest extends TestCase {
    public function testAdd() {
        $mock = $this->getMockBuilder('Dependency')
                     ->getMock();
        $mock->expects($this->once())
             ->method('getValue')
             ->will($this->returnValue(5));

        $calculator = new Calculator($mock);
        $result = $calculator->add(2, 3);
        $this->assertEquals(10, $result);
    }
}

在這個測試案例中，我們使用getMockBuilder方法來建立一個名為Dependency的Mock物件。然後我們期望Mock物件的getValue方法被呼叫一次，並且傳回5。最後我們將這個Mock物件傳遞給Calculator類別的建構子。

總結

在本文中，我們學習如何使用PHPUnit進行PHP單元測試。我們安裝了PHPUnit，編寫了測試案例，運行了測試案例，使用了斷言、資料提供器和Mock物件。透過這些步驟，我們可以編寫高品質的測試案例來測試我們的程式碼，以便提高程式碼品質、加快開發和維護的速度。

以上是如何使用PHPUnit進行PHP單元測試的詳細內容。更多資訊請關注PHP中文網其他相關文章！