Packageontwikkeling met Testbench Workbench

Wat is Testbench Workbench?

Orchestra Testbench is bedoeld voor tests, maar in combinatie met Workbench kun je binnen je package-repository een kleine Laravel-app bouwen en lokaal draaien. Je gebruikt het als aanvulling op de tests uit package-testing, wanneer je UI-controles, routebereikbaarheid en verificatie met seeders wilt uitvoeren.

Setup

Installeer Testbench

composer require --dev orchestra/testbench

Maak de Workbench aan

vendor/bin/testbench workbench:install

Dit commando doet het volgende in één keer:

De directorystructuur van workbench/ aanmaken
De Workbench-namespace toevoegen aan autoload-dev in composer.json
Buildcommando’s toevoegen aan de scripts van composer.json

Extra opties:

--force : bestaande bestanden overschrijven
--basic : een eenvoudige opzet zonder routes en package-discovery-configuratie
--devtool : DevTool-ondersteuning inschakelen

Bouwen en starten

composer clear
composer prepare
composer build
vendor/bin/testbench serve

workbench:install richt de map workbench/, autoload-dev en de bijbehorende scripts in één keer in.

Na de installatie zijn de volgende scripts toegevoegd aan composer.json.

{
    "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"
        ]
    }
}

De ontwikkelomgeving definiëren met testbench.yaml

Het gedrag van Workbench beheer je met een testbench.yaml in de root.

Omdat testbench.yaml per omgeving verschillende instellingen kan bevatten, wordt aanbevolen het toe te voegen aan .gitignore en buiten de commits te houden. Neem in plaats daarvan een testbench.yaml.example als template op in de repository.

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

De belangrijkste configuratieopties:

Sleutel	Toelichting
`providers`	Lijst van service providers die in de Workbench-omgeving worden geladen
`migrations`	De migrationmappen die worden uitgevoerd
`workbench.start`	De standaard-URL bij het starten van `composer serve`
`workbench.discovers`	Bepaalt wat de automatische package discovery van Laravel meeneemt
`workbench.build`	Lijst van commando’s die tijdens de build worden uitgevoerd

Ook environment variables kun je in testbench.yaml beheren.

env:
  - APP_ENV=testing
  - APP_KEY=base64:your-app-key
  - DB_CONNECTION=sqlite
  - DB_DATABASE=:memory:

De directorystructuur van workbench

workbench

app

Http

Models

Providers

bootstrap

config

database

factories

migrations

seeders

public

resources

routes

storage

De belangrijkste functies van Workbench

WorkbenchServiceProvider

Maak een Workbench-specifieke service provider voor de demoregistraties.

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

Routes en controllers

In workbench/routes/web.php en workbench/routes/api.php kun je verificatieroutes plaatsen.

use Illuminate\Support\Facades\Route;
use Vendor\Package\Facades\Package;

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

Migrations en seeders

Met workbench/database/migrations en workbench/database/seeders verifieer je met een datastructuur die dicht bij productie ligt.

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

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

Met een seeder genereer je testdata.

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

De service starten en CLI-controles

Via vendor/bin/testbench kun je Artisan-commando’s uitvoeren.

vendor/bin/testbench list
vendor/bin/testbench route:list
vendor/bin/testbench migrate:fresh --seed

Testen met de WithWorkbench-trait

Met de WithWorkbench-trait wordt de configuratie uit testbench.yaml ook op je geautomatiseerde tests toegepast.

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

Samenwerking met je tests

Het werkt het prettigst als je de rollen verdeelt: Workbench als “app voor handmatige controle en demo’s” en de Testbench-testcode als “geautomatiseerde verificatie”.

Automatisering: regressies voorkomen in tests/
Handmatige controle: schermen, flows en integratiegedrag controleren in workbench/

Probleemoplossing

# Wissen en volledig herbouwen
composer clear && composer prepare && composer build

# De automatische package discovery controleren
vendor/bin/testbench package:discover --ansi

# De configuratie controleren
vendor/bin/testbench about

# De routelijst controleren
vendor/bin/testbench route:list

De Workbench bouwt niet

Controleer de syntaxis van testbench.yaml en de providerconfiguratie. Een YAML-indentatiefout is een veelvoorkomende oorzaak.

Routes worden niet geladen

Controleer het pad van het routebestand en de registratie in de WorkbenchServiceProvider. Kijk of discovers.web in testbench.yaml op true staat.

Er treedt een databasefout op

Controleer of het pad naar de migrations klopt. Gebruik je SQLite, kijk dan of de buildstap create-sqlite-db is opgenomen.

Gerelateerde pagina’s

Laravel-packages testen met Orchestra Testbench

Bekijk eerst hoe je een testinfrastructuur voor packages opzet.

Versiecompatibiliteit van packages beheren

Bekijk de compatibiliteitstabel van Laravel en Testbench en het beheer van de CI-matrix.

Source: invokable/laravel-bluesky docs/workbench.md, Orchestra Testbench

AI-ontwikkeling

Design patterns