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

# Desarrollar paquetes con Testbench Workbench

> Aprende a crear un entorno de verificación cercano a una aplicación real, con rutas, migraciones y arranque de servicios, usando Orchestra Testbench Workbench.

## Qué es Testbench Workbench

[Orchestra Testbench](https://github.com/orchestral/testbench) está pensado para tests, pero combinándolo con Workbench puedes crear una pequeña aplicación Laravel dentro del propio repositorio del paquete y ejecutarla en local.

Se usa para complementar los tests que creaste en `package-testing` cuando quieres validar la UI, la respuesta de las rutas o hacer verificaciones con seeders.

```mermaid theme={null}
flowchart TD
    A["Paquete principal<br>`src/`"] --> B["Workbench<br>`workbench/`"]
    B --> C["WorkbenchServiceProvider<br>Registro de servicios de demo"]
    B --> D["Rutas y controladores<br>Verificación de pantallas"]
    B --> E["Migraciones y Seeders<br>Verificación de datos"]
    B --> F["`composer serve`<br>Arranque local"]
    C --> G["testbench.yaml<br>Configuración de providers/build"]
```

## Configuración

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

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

    Este comando realiza a la vez lo siguiente:

    * Crea la estructura del directorio `workbench/`.
    * Añade el namespace de Workbench a `autoload-dev` en `composer.json`.
    * Añade comandos de build a `scripts` en `composer.json`.

    <Tip>
      Opciones adicionales:

      * `--force`: sobrescribe archivos existentes.
      * `--basic`: composición simple sin la configuración de rutas ni package discovery.
      * `--devtool`: habilita el soporte de DevTool.
    </Tip>
  </Step>

  <Step title="Compila y arranca">
    ```bash theme={null}
    composer clear
    composer prepare
    composer build
    vendor/bin/testbench serve
    ```
  </Step>
</Steps>

<Info>
  `workbench:install` prepara de una vez el directorio `workbench/`, `autoload-dev` y los scripts relacionados.
</Info>

Tras la instalación, se añaden los siguientes scripts en `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"
        ]
    }
}
```

## Definir el entorno de desarrollo con testbench.yaml

El comportamiento del Workbench se gestiona en el `testbench.yaml` de la raíz.

<Warning>
  `testbench.yaml` puede contener configuración específica del entorno, así que se recomienda añadirlo a `.gitignore` y no incluirlo en los commits. En su lugar, deja en el repositorio un `testbench.yaml.example` a modo de plantilla.
</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
```

Opciones principales:

| Clave                 | Descripción                                                       |
| --------------------- | ----------------------------------------------------------------- |
| `providers`           | Lista de service providers que se cargan en el entorno Workbench. |
| `migrations`          | Directorios de migraciones que se ejecutarán.                     |
| `workbench.start`     | URL por defecto al arrancar `composer serve`.                     |
| `workbench.discovers` | Controla el package discovery automático de Laravel.              |
| `workbench.build`     | Lista de comandos que se ejecutan durante el build.               |

También puedes gestionar variables de entorno en `testbench.yaml`.

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

## Estructura del directorio 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>

## Funcionalidades principales de Workbench

### WorkbenchServiceProvider

Crea un service provider dedicado a Workbench para registrar componentes de demo.

```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');
    }
}
```

### Rutas y controladores

En `workbench/routes/web.php` o `workbench/routes/api.php` puedes colocar rutas de verificación.

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

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

### Migraciones y seeders

Usa `workbench/database/migrations` y `workbench/database/seeders` para validar con una estructura de datos cercana a la real.

```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();
});
```

Genera datos de prueba con un 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();
    }
}
```

### Arranque del servicio y verificación por CLI

Puedes ejecutar comandos Artisan a través de `vendor/bin/testbench`.

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

## Tests con el trait WithWorkbench

Con el trait `WithWorkbench`, la configuración de `testbench.yaml` se aplica también a los tests automatizados.

```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');
    }
}
```

## Coordinación con los tests

Reparte responsabilidades entre Workbench como «app de verificación manual y demo» y los tests de Testbench como «verificación automática».

* Automatización: previene regresiones en `tests/`.
* Verificación manual: valida pantalla, navegación y comportamiento integrado en `workbench/`.

## Solución de problemas

```bash theme={null}
# Limpiar y reconstruir por completo
composer clear && composer prepare && composer build

# Comprobar el package discovery
vendor/bin/testbench package:discover --ansi

# Comprobar la configuración
vendor/bin/testbench about

# Ver la lista de rutas
vendor/bin/testbench route:list
```

<AccordionGroup>
  <Accordion title="El Workbench no compila">
    Revisa la sintaxis y la configuración de providers en `testbench.yaml`. Un error de indentación de YAML puede ser la causa.
  </Accordion>

  <Accordion title="No se cargan las rutas">
    Comprueba la ruta del archivo y su registro en el WorkbenchServiceProvider. Verifica también que `discovers.web` esté en `true` en `testbench.yaml`.
  </Accordion>

  <Accordion title="Aparecen errores de base de datos">
    Comprueba que las rutas de las migraciones son correctas. Si usas SQLite, asegúrate de incluir el paso `create-sqlite-db` en el build.
  </Accordion>
</AccordionGroup>

## Páginas relacionadas

<Columns cols={2}>
  <Card title="Probar paquetes Laravel con Orchestra Testbench" icon="flask-conical" href="/es/advanced/package-testing">
    Aprende primero cómo montar la base de pruebas de tu paquete.
  </Card>

  <Card title="Gestión de la compatibilidad de versiones de paquetes" icon="git-branch" href="/es/advanced/package-versioning">
    Consulta la tabla de compatibilidad Laravel/Testbench y la operativa de la matriz de CI.
  </Card>
</Columns>

<Info>
  Fuente: [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 Boost Custom Agent for GitHub Copilot CLI](/es/packages/laravel-boost-copilot-cli.md)
- [Probar paquetes Laravel con Orchestra Testbench](/es/advanced/package-testing.md)
- [Laravel Package Skeleton — Plantilla oficial para paquetes](/es/blog/package-skeleton-introduction.md)
- [Gestión de la compatibilidad de versiones de paquetes](/es/advanced/package-versioning.md)
- [PHP Reflection API](/es/advanced/php-reflection.md)