標籤: PHPUnit

PHPUnit 9 以及之前測試是否有 throw exception 的方法，是在 test case 前加上 annotation：

/**
 * @expectedException \Exception
 */
public function testFailed() { }

在 PHPUnit 10 則直接在 test case 中呼叫 assertion 即可：

public function testFailed()
{
    $this->expectException(\Exception::class);
}

但要注意，必須在測試開始之前。若 exception 比 expectedException() 還要早出現仍會視為 test failed。

假設有個 class：

class Woker
{
    protected Queue $queue;

    public function run()
    {
        while (!$this->queue->isEmpty()) {
            $job = $this->queue->pop();
            // do something
        }
    }
}

用 PHPUnit 建立 stub 以後，必須使用 reflection 來自訂 $queue property：

$worker = $this->getMockBuilder(Worker::class)
    ->disableOriginalConstructor()
    ->getMock();

$queue = $this->createMock(Queue::class);
$queue->expected($this->atLeast(1))
    ->method('isEmpty')
    ->willReturn(true);

// PHP Reflection on $worker
$refProperty = new \ReflectionProperty($worker, 'queue');
$refProperty->setAccessible(true);
$refProperty->setValue($crawler, $queue);

這樣寫 test case 蠻髒的，有點想要換 test framework ….

通常都是在 console 底下執行 PHPUnit 跑測試：

$ phpunit Test.php 
... Run by vendor/bin/phpunit ...
PHPUnit 7.1.5 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 30 ms, Memory: 4.00MB

OK (1 test, 1 assertion)

但若開發環境無法使用 console 的話，只能靠寫 PHP script 來 require PHPUnit library 來執行。在這邊發現其實 PHPUnit 有保留 interface 讓使用者可以不透過 console 來操作 PHPUnit，可以在 PHP script 裡面 require library 來使用。

先使用 composer 把 library 拉下來：

composer require 'phpunit/phpunit'

在 PHPUnut/TextUI 底下，有實作幾個 controller 來模擬 console 的操作。以下使用 Command 來執行 PHPUnit：

<?php

require __DIR__ . '/vendor/autoload.php';

use PHPUnitTextUICommand;

$cmd = new Command();

$cmd->run([
    'phpunit',  // 1st arg
    'Test.php', // 2nd arg
]);

如果執行上面這段 PHP script，會得到與在 console 執行 PHPUnit 一樣的結果。
不過要注意的是測試結果會直接輸出到 std out，若另外處理的話，記得用 output buffer 把資料拉回來，直接在瀏覽器看的話會破版。

備註：PHPUnit 不同版本的路徑不同，類別名稱也會不同。

複習 PHPUnit 順手寫了小程式做實驗。

PHPUnit 為了讓各個不同的 test case 不會因為 super globals 變數而互相影響，設計了 「backupGlobals」這個功能。先來看範例程式：

class MyTest extends TestCase
{
    public function testOne()
    {
        $GLOBALS['test'] = 123;

        $this->assertArrayHasKey('test', $GLOBALS);
    }

    public function testTwo()
    {
        $this->assertArrayHasKey('test', $GLOBALS);
    }
}

範例中 testOne() 修改了 $GLOBALS 變數的內容，如果在不使用「backupGlobals」的情況下，在 testTwo() 中的 $GLOBALS 也會保留 testOne() 修改過的內容，使 testTow() 抓得到「test」這個 key：

$ phpunit MyTest.php 
PHPUnit 7.0.2 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 40 ms, Memory: 4.00MB

OK (2 tests, 2 assertions)

也就表示 testOne() 影響到了 testTwo() 的測試結果，這在測試時是不樂見的，各個測試應該有獨立的測試環境，不應該互相影響。

使用「backupGlobals」功能，PHPUnit 會在 test case 執行之前，使用 serialize() 對 super globals 做備份，並在測試結束以後 unserialize() 復原，所以 testOne() 中做的修改就不會影響到 testTwo() 了：

$ phpunit --globals-backup MyTest.php 
PHPUnit 7.0.2 by Sebastian Bergmann and contributors.

.F                                                                  2 / 2 (100%)

Time: 52 ms, Memory: 4.00MB

There was 1 failure:

1) MyTest::testTwo
Failed asserting that an array has the key 'test'.

/home/johnroyer/tmp/MyTest.php:16

FAILURES!
Tests: 2, Assertions: 2, Failures: 1.

重點來了，因為是使用 serialize() 和 unserialize()，所以只能針對 primitive type 進行備份和還原，如果使用了 object 或是 singleton 時，「backupGlobals」就派不上用場了。這個時候要使用殺手鐧「runTestsInSeparateProcesses」：

/**
 * @runTestsInSeparateProcesses
 */
class MyTest extends TestCase
{
    ....
}

使用這個 annotation 會讓 PHPUnit 為每個 test case 分別 fork 出新的 proccess 進行測試，因此不同 test case 就可以在完全獨立的環境下執行不受影響：

$ phpunit MyTest.php 
PHPUnit 7.0.2 by Sebastian Bergmann and contributors.

.F                                                                  2 / 2 (100%)

Time: 303 ms, Memory: 4.00MB

There was 1 failure:

1) MyTest::testTwo
Failed asserting that an array has the key 'test'.

/home/johnroyer/tmp/MyTest.php:19

FAILURES!
Tests: 2, Assertions: 2, Failures: 1.

但使用這個殺手鐧也是要付出一點代價：時間。最前二次執行 PHPUnit 時，跑完二個 test case 只花費了 50ms 左右，而開 proccess 來進行測試則花了 300ms。