以 Orchestra Testbench 測試 Laravel 套件

什麼是 Orchestra Testbench

Orchestra Testbench 是為套件開發準備的 Laravel 測試 helper。繼承 Orchestra\Testbench\TestCase 後，即便單獨的套件也能以彷彿身處 Laravel 應用程式的方式進行測試。 Laravel 官方文件套件開發中也指引套件測試使用 Testbench。

設定

安裝 Testbench

composer require --dev orchestra/testbench

建立基底 TestCase

<?php

namespace Vendor\Package\Tests;

use Orchestra\Testbench\TestCase as BaseTestCase;
use Vendor\Package\PackageServiceProvider;

abstract class TestCase extends BaseTestCase
{
    /**
     * $app 為 Testbench 啟動的 Laravel 應用程式實例。
     */
    protected function getPackageProviders($app): array
    {
        return [
            PackageServiceProvider::class,
        ];
    }
}

需要時新增設定或 alias

於 getPackageAliases() 可與 config/app.php 的 aliases 相同方式，註冊測試中使用的 Facade alias。

protected function getPackageAliases($app): array
{
    return [
        'Package' => \Vendor\Package\Facades\Package::class,
    ];
}

protected function defineEnvironment($app): void
{
    // 於此處覆寫測試用設定
    $app['config']->set('package.enabled', true);
}

基本的測試撰寫方式

先確認服務提供者是否已載入、Facade 是否如預期運作、設定是否已生效。

<?php

namespace Vendor\Package\Tests\Feature;

use Vendor\Package\Facades\Package;
use Vendor\Package\PackageServiceProvider;
use Vendor\Package\Tests\TestCase;

class PackageBootstrapTest extends TestCase
{
    public function test_service_provider_is_registered(): void
    {
        $this->assertTrue($this->app->providerIsLoaded(PackageServiceProvider::class));
    }

    public function test_facade_returns_expected_value(): void
    {
        // 透過 Facade 驗證功能
        $this->assertSame('ok', Package::status());
    }

    public function test_package_config_is_available(): void
    {
        // 確認於 defineEnvironment() 設定的值
        $this->assertTrue(config('package.enabled'));
    }
}

檔案系統與資料庫的測試

在使用 DB 的測試中，於 defineEnvironment() 設定 SQLite 記憶體資料庫，並載入測試對象的 migration。

<?php

namespace Vendor\Package\Tests;

use Orchestra\Testbench\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    protected function defineEnvironment($app): void
    {
        // 使用 SQLite 記憶體 DB
        $app['config']->set('database.default', 'testing');
        $app['config']->set('database.connections.testing', [
            'driver' => 'sqlite',
            'database' => ':memory:',
            'prefix' => '',
        ]);
    }

    protected function setUp(): void
    {
        parent::setUp();

        // 載入套件的 migration
        $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
    }
}

public function test_it_persists_data(): void
{
    \DB::table('widgets')->insert(['name' => 'test']);

    $this->assertDatabaseHas('widgets', ['name' => 'test']);
}

於多個 Laravel 版本測試

Testbench 的主版本對應 Laravel 的主版本。詳情請確認官方的 Version Compatibility。

Laravel	Testbench
12.x	10.x
13.x	11.x

若要持續驗證多個版本，可與 GitHub Actions 的 matrix 組合。設計思路請參考套件的版本相容性管理。

strategy:
  fail-fast: false
  matrix:
    php: [8.3, 8.4]
    laravel: ["^12.0", "^13.0"]
    include:
      - laravel: "^13.0"
        testbench: "^11.0"
      - laravel: "^12.0"
        testbench: "^10.0"

總結

使用 Testbench 即便未手動準備 Laravel 應用程式，也能以近似正式運行的形式驗證套件行為。將服務提供者註冊、設定、Facade、DB 都納入測試對象，可大幅減少發布後的問題。

Laravel 套件開發

確認以服務提供者為中心的套件實作基礎。

套件的版本相容性管理

確認 Laravel 與 Testbench 的版本策略與 CI matrix 運行方式。

AI 開發

設計模式

套件開發

應用程式結構

Laravel 13 新功能

Eloquent 深入探索

驗證擴充

認證擴充

安全性

佇列

測試

以 Orchestra Testbench 測試 Laravel 套件

什麼是 Orchestra Testbench

設定

基本的測試撰寫方式

檔案系統與資料庫的測試

於多個 Laravel 版本測試

總結

相關頁面

Laravel 套件開發

套件的版本相容性管理

​什麼是 Orchestra Testbench

​設定

​基本的測試撰寫方式

​檔案系統與資料庫的測試

​於多個 Laravel 版本測試

​總結

​相關頁面

Laravel 套件開發

套件的版本相容性管理

什麼是 Orchestra Testbench

設定

基本的測試撰寫方式

檔案系統與資料庫的測試

於多個 Laravel 版本測試

總結

相關頁面