> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# 使用 Testbench Workbench 进行包开发

> 讲解如何使用 Orchestra Testbench Workbench 在包中打造包含路由、迁移、服务启动等接近真实应用的验证环境。

## 什么是 Testbench Workbench

[Orchestra Testbench](https://github.com/orchestral/testbench) 面向测试，但结合 Workbench 后可以在包仓库内构建一个小型 Laravel 应用，可以在本地跑起来。

它用于补充 `package-testing` 中的测试，方便进行 UI 检查、路由联调、带 Seeder 的验证等。

```mermaid theme={null}
flowchart TD
    A["包主体<br>`src/`"] --> B["Workbench<br>`workbench/`"]
    B --> C["WorkbenchServiceProvider<br>注册演示服务"]
    B --> D["路由/Controller<br>页面验证"]
    B --> E["迁移/Seeder<br>数据验证"]
    B --> F["`composer serve`<br>本地启动"]
    C --> G["testbench.yaml<br>Provider/构建设置"]
```

## 搭建

<Steps>
  <Step title="安装 Testbench">
    ```bash theme={null}
    composer require --dev orchestra/testbench
    ```
  </Step>

  <Step title="创建 Workbench">
    ```bash theme={null}
    vendor/bin/testbench workbench:install
    ```

    该命令会一次完成：

    * 创建 `workbench/` 目录结构
    * 向 `composer.json` 的 `autoload-dev` 添加 Workbench 命名空间
    * 向 `composer.json` 的 `scripts` 添加构建用命令

    <Tip>
      附加选项：

      * `--force`：覆盖已有文件
      * `--basic`：省略路由与包 discovery 配置的简洁结构
      * `--devtool`：启用 DevTool 支持
    </Tip>
  </Step>

  <Step title="构建并启动">
    ```bash theme={null}
    composer clear
    composer prepare
    composer build
    vendor/bin/testbench serve
    ```
  </Step>
</Steps>

<Info>
  `workbench:install` 会一次性搭建 `workbench/` 目录、`autoload-dev` 与相关脚本。
</Info>

安装后，`composer.json` 会新增以下脚本。

```json theme={null}
{
    "autoload-dev": {
        "psr-4": {
            "Tests\\": "tests/",
            "Workbench\\App\\": "workbench/app/",
            "Workbench\\Database\\Factories\\": "workbench/database/factories/",
            "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
        }
    },
    "scripts": {
        "post-autoload-dump": [
            "@clear",
            "@prepare"
        ],
        "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
        "prepare": "@php vendor/bin/testbench package:discover --ansi",
        "build": "@php vendor/bin/testbench workbench:build --ansi",
        "serve": [
            "Composer\\Config::disableProcessTimeout",
            "@build",
            "@php vendor/bin/testbench serve --ansi"
        ]
    }
}
```

## 用 testbench.yaml 定义开发环境

Workbench 的行为由放在根目录的 `testbench.yaml` 控制。

<Warning>
  `testbench.yaml` 中常包含随环境不同而变的设置，建议加入 `.gitignore` 不提交。可以准备 `testbench.yaml.example` 作为模板放入仓库。
</Warning>

```yaml theme={null}
providers:
  - Vendor\Package\PackageServiceProvider
  - Workbench\App\Providers\WorkbenchServiceProvider

migrations:
  - workbench/database/migrations

workbench:
  start: '/'
  install: true
  health: false
  discovers:
    web: true
    api: false
    commands: false
    components: false
    views: false
    config: true
  build:
    - asset-publish
    - create-sqlite-db
    - db-wipe
    - migrate-fresh:
        --seed: true
        --seeder: Workbench\Database\Seeders\DatabaseSeeder
  assets:
    - laravel-assets
```

主要配置项：

| 键                     | 说明                                  |
| --------------------- | ----------------------------------- |
| `providers`           | Workbench 环境加载的 Service Provider 列表 |
| `migrations`          | 要执行的迁移目录                            |
| `workbench.start`     | `composer serve` 启动时的默认 URL         |
| `workbench.discovers` | 控制 Laravel 包自动发现的对象                 |
| `workbench.build`     | 构建时执行的命令列表                          |

环境变量也可以在 `testbench.yaml` 中管理。

```yaml theme={null}
env:
  - APP_ENV=testing
  - APP_KEY=base64:your-app-key
  - DB_CONNECTION=sqlite
  - DB_DATABASE=:memory:
```

## workbench 目录结构

<Tree>
  <Tree.Folder name="workbench" defaultOpen>
    <Tree.Folder name="app" defaultOpen>
      <Tree.Folder name="Http">
        <Tree.Folder name="Controllers" />
      </Tree.Folder>

      <Tree.Folder name="Models" />

      <Tree.Folder name="Providers">
        <Tree.File name="WorkbenchServiceProvider.php" />
      </Tree.Folder>
    </Tree.Folder>

    <Tree.Folder name="bootstrap" />

    <Tree.Folder name="config" />

    <Tree.Folder name="database" defaultOpen>
      <Tree.Folder name="factories" />

      <Tree.Folder name="migrations" />

      <Tree.Folder name="seeders">
        <Tree.File name="DatabaseSeeder.php" />
      </Tree.Folder>
    </Tree.Folder>

    <Tree.Folder name="public" />

    <Tree.Folder name="resources">
      <Tree.Folder name="views" />
    </Tree.Folder>

    <Tree.Folder name="routes">
      <Tree.File name="web.php" />

      <Tree.File name="api.php" />

      <Tree.File name="console.php" />
    </Tree.Folder>

    <Tree.Folder name="storage" />
  </Tree.Folder>
</Tree>

## Workbench 提供的主要功能

### WorkbenchServiceProvider

创建 Workbench 专用 Service Provider，用于演示相关的注册处理。

```php theme={null}
<?php

namespace Workbench\App\Providers;

use Illuminate\Support\ServiceProvider;
use Vendor\Package\SomeClass;
use Workbench\App\Services\DemoService;

class WorkbenchServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->singleton(DemoService::class);
    }

    public function boot(): void
    {
        SomeClass::register('demo', DemoService::class);
        $this->loadRoutesFrom(__DIR__.'/../../routes/web.php');
        $this->loadViewsFrom(__DIR__.'/../../resources/views', 'workbench');
    }
}
```

### 路由与 Controller

可以在 `workbench/routes/web.php` 或 `workbench/routes/api.php` 放置验证用路由。

```php theme={null}
use Illuminate\Support\Facades\Route;
use Vendor\Package\Facades\Package;

Route::get('/', function () {
    return Package::status();
});
```

### 迁移与 Seeder

`workbench/database/migrations` 与 `workbench/database/seeders` 可用于以接近生产的数据结构验证。

```php theme={null}
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::create('widgets', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->timestamps();
});
```

用 Seeder 生成测试数据。

```php theme={null}
<?php

namespace Workbench\Database\Seeders;

use Illuminate\Database\Seeder;
use Workbench\Database\Factories\UserFactory;

class DatabaseSeeder extends Seeder
{
    public function run(): void
    {
        UserFactory::new()->count(10)->create();
    }
}
```

### 启动服务与 CLI 确认

可通过 `vendor/bin/testbench` 执行 Artisan 命令。

```bash theme={null}
vendor/bin/testbench list
vendor/bin/testbench route:list
vendor/bin/testbench migrate:fresh --seed
```

## 使用 WithWorkbench trait 进行测试

使用 `WithWorkbench` trait，可以将 `testbench.yaml` 的配置自动应用到测试中。

```php theme={null}
<?php

namespace Tests;

use Orchestra\Testbench\Concerns\WithWorkbench;
use Orchestra\Testbench\TestCase as Orchestra;

abstract class TestCase extends Orchestra
{
    use WithWorkbench;

    protected function getPackageProviders($app): array
    {
        return [
            \Vendor\Package\Providers\YourServiceProvider::class,
        ];
    }

    protected function defineEnvironment($app): void
    {
        $app['config']->set('database.default', 'testing');
        $app['config']->set('your-package.key', 'test-value');
    }
}
```

## 与测试的联动

将 Workbench 用作「手动检查、演示应用」，Testbench 测试代码用作「自动验证」，可以让运营更顺畅。

* 自动化：`tests/` 防止回归
* 手动确认：`workbench/` 验证界面、动线、集成行为

## 故障排查

```bash theme={null}
# 清理并完整重建
composer clear && composer prepare && composer build

# 确认包自动发现
vendor/bin/testbench package:discover --ansi

# 查看设置
vendor/bin/testbench about

# 查看路由列表
vendor/bin/testbench route:list
```

<AccordionGroup>
  <Accordion title="Workbench 构建失败">
    请确认 `testbench.yaml` 的语法与 Provider 设置。可能是 YAML 缩进错误。
  </Accordion>

  <Accordion title="路由未加载">
    确认路由文件路径以及 WorkbenchServiceProvider 的注册。检查 `testbench.yaml` 的 `discovers.web` 是否为 `true`。
  </Accordion>

  <Accordion title="出现数据库错误">
    确认迁移路径是否正确。若使用 SQLite，检查是否包含 `create-sqlite-db` 构建步骤。
  </Accordion>
</AccordionGroup>

## 相关页面

<Columns cols={2}>
  <Card title="使用 Orchestra Testbench 测试 Laravel 包" icon="flask-conical" href="/zh/advanced/package-testing">
    先了解包测试基础设施的搭建方法。
  </Card>

  <Card title="包的版本兼容性管理" icon="git-branch" href="/zh/advanced/package-versioning">
    了解 Laravel 与 Testbench 的对应关系以及 CI 矩阵运营。
  </Card>
</Columns>

<Info>
  Source: [invokable/laravel-bluesky docs/workbench.md](https://github.com/invokable/laravel-bluesky/blob/main/docs/workbench.md), [Orchestra Testbench](https://github.com/orchestral/testbench)
</Info>


## Related topics

- [Laravel 包开发](/zh/advanced/package-development.md)
- [使用 Orchestra Testbench 测试 Laravel 包](/zh/advanced/package-testing.md)
- [Laravel Package Skeleton — 官方包开发用启动模板](/zh/blog/package-skeleton-introduction.md)
- [Laravel Boost Custom Agent for GitHub Copilot CLI](/zh/packages/laravel-boost-copilot-cli.md)
- [包的版本兼容性管理](/zh/advanced/package-versioning.md)