setUp()、tearDown()、Data Provider

2022 iThome 鐵人賽

DAY 14

DevOps

自動化測試大作戰系列第 14 篇

14th鐵人賽 php phpunit laravel 自動化測試

woeichern

2022-09-28 21:14:19

935 瀏覽

分享至

Medium 清新閱讀版：連結

今天要來為大家介紹幾個，在撰寫測試程式碼時可以利用的特殊函數。

setUp() & tearDown()

setUp()：我們可以在這個函數中，撰寫想要在每個測試案例函數執行前預執行的邏輯。
tearDown()：我們可以在這個函數中，撰寫想要在每個測試案例函數執行後預執行的邏輯。

範例：

<?php

namespace Tests\Unit;

use App\Services\TestService;
use PHPUnit\Framework\TestCase;

class TestServiceTest extends TestCase
{
    private $service;

    public function setUp(): void
    {
        $this->service = app(TestService::class);
        parent::setUp();
    }

    public function testCanCalcuateBmi()
    {
        $bmiActual = $this->service->calculateBmi(1.6, 64.0);
        $bmiExpected = 64.0/(1.6*1.6);

        $this->assertEquals($bmiExpected, $bmiActual);
    }

		public function tearDown(): void
    {
        parent::tearDown();
        $this->service = null;
    }
}

在以上程式碼中， setUp()會在每個測試案例函數執行前，先初始化 $this→service；tearDown() 則會在每個測試案例函數執行後，清空 $this→service。

setUpBeforeClass() & tearDownAfterClass()

setUpBeforeClass()：與 setUp() 類似，但只會在每個測試類別的第1個測試案例函數執行前執行。
tearDownAfterClass()：與 tearDonw() 類似，但只會在每個測試類別的第1個測試案例函數執行前執行。

範例：

<?php

namespace Tests\Unit;

use App\Services\TestService;
use PHPUnit\Framework\TestCase;

class TestServiceTest extends TestCase
{
    private $service;
    private static $flag;

    public static function setUpBeforeClass(): void
    {
        self::$flag = true;
        parent::setUpBeforeClass();
    }

    public function setUp(): void
    {
        $this->service = app(TestService::class);
        parent::setUp();
    }

    public function testCanThrowExceptionWhenInvaliHeight()
    {
        $this->expectException(Exception::class);
        $this->service->calculateBmi(0.0, 1.0);
    }

    public function testCanThrowExceptionWhenInvaliWeight()
    {
        $this->expectException(Exception::class);
        $this->service->calculateBmi(1.0, 0.0);
    }

    public function testCanThrowExceptionWithMessageWhenInvaliData()
    {
        $this->expectExceptionMessage('Invalid');
        $this->service->calculateBmi(0.0, 1.0);
    }

    public function testCanThrowExceptionWithMessageRegexMatcchWhenInvaliData()
    {
        $this->expectExceptionMessageMatches('/Invalid/');
        $this->service->calculateBmi(0.0, 1.0);
    }

    public function testCanThrowExceptionWithCodeWhenInvaliData()
    {
        $this->expectExceptionCode(1);
        $this->service->calculateBmi(0.0, 1.0);
    }

    public function tearDown(): void
    {
        parent::tearDownAfterClass();
        $this->service = null;
    }

    public static function tearDownAfterClass(): void
    {
        self::$flag = false;
        parent::tearDownAfterClass();
    }
}

特別要注意的是，setUpBeforeClass() 及 tearDownAfterClass() 都只能宣告為靜態函數。

Data Providers

來到今天的重頭戲了，這個功能與前一天介紹的 @testWith 很像，話不多說，直接來看範例吧！

範例

<?php

namespace Tests\Unit;

use App\Services\TestService;
use Exception;
use PHPUnit\Framework\TestCase;

class TestServiceTest extends TestCase
{
    /**
     * @dataProvider bmiProvider
     */
    public function testCanThrowException(float $height, float $weight)
    {
        $service = app(TestService::class);
        $this->expectException(Exception::class);
        $service->calculateBmi($height, $weight);
    }

    public function bmiProvider()
    {
        return [
            [1.0, 0.0],
            [0.0, 1.0],
            [0.0, 0.0],
        ];
    }
}

在以上程式碼中，我們建立了， 1個 Data Provider 函數 bmiProvider()，以及1個測試案例函數 testCanThrowException()，並且註記使用 Data Provider 函數 bmiProvider()。在此測試類別中，testCanThrowException()實際上會執行3次，分別是：