laravel-tdd

Laravel-Tests mit TDD

Testgetriebene Entwicklung für Laravel-Anwendungen mit PHPUnit, Pest, Laravel-Factories und Test-Helfern.

Wann aktivieren

• Beim Schreiben neuer Laravel-Anwendungen oder -Funktionen
• Beim Implementieren von API-Endpunkten mit Sanctum oder Passport-Authentifizierung
• Beim Testen von Eloquent-Modellen, Beziehungen, Scopes und Accessoren
• Beim Einrichten der Testinfrastruktur für Laravel-Projekte
• Beim Schreiben von Feature-Tests für HTTP-Controller und Formular-Requests
• Beim Mocken externer Dienste (Queues, Mail, Benachrichtigungen, HTTP)

TDD-Workflow für Laravel

Rot-Grün-Refaktor-Zyklus

// Schritt 1: ROT — Einen fehlschlagenden Test schreiben
public function test_a_product_can_be_created(): void
{
    $product = Product::factory()->create(['name' => 'Test Product']);
    $this->assertDatabaseHas('products', ['name' => 'Test Product']);
}

// Schritt 2: GRÜN — Migration, Modell und Factory schreiben
// Schritt 3: REFAKTOR — Verbessern, während die Tests grün bleiben

Einrichtung

PHPUnit-Konfiguration

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
         bootstrap="vendor/autoload.php"
         colors="true">
    <testsuites>
        <testsuite name="Unit">
            <directory suffix="Test.php">tests/Unit</directory>
        </testsuite>
        <testsuite name="Feature">
            <directory suffix="Test.php">tests/Feature</directory>
        </testsuite>
    </testsuites>
    <php>
        <env name="APP_ENV" value="testing"/>
        <env name="BCRYPT_ROUNDS" value="4"/>
        <env name="CACHE_STORE" value="array"/>
        <env name="DB_CONNECTION" value="sqlite"/>
        <env name="DB_DATABASE" value=":memory:"/>
        <env name="MAIL_MAILER" value="array"/>
        <env name="QUEUE_CONNECTION" value="sync"/>
        <env name="SESSION_DRIVER" value="array"/>
    </php>
</phpunit>

Basis-Testcase-Setup

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    protected function setUp(): void
    {
        parent::setUp();
        // Rufen Sie $this->withoutExceptionHandling() nur in Tests auf, die
        // Nicht-HTTP-Ausnahmen testen; es unterdrückt assertStatus() usw.
    }

    // Helfer: Authentifizieren und Benutzer zurückgeben
    protected function actingAsUser(): mixed
    {
        $user = \App\Models\User::factory()->create();
        $this->actingAs($user);
        return $user;
    }

    protected function actingAsAdmin(): mixed
    {
        $admin = \App\Models\User::factory()->admin()->create();
        $this->actingAs($admin);
        return $admin;
    }
}

Modell-Factories

// database/factories/UserFactory.php
class UserFactory extends Factory
{
    protected static ?string $password = null;

    public function definition(): array
    {
        return [
            'name' => fake()->name(),
            'email' => fake()->unique()->safeEmail(),
            'email_verified_at' => now(),
            'password' => static::$password ??= Hash::make('password'),
            'remember_token' => Str::random(10),
            'role' => 'user',
        ];
    }

    public function admin(): static
    {
        return $this->state(fn (array $attributes) => ['role' => 'admin']);
    }

    public function unverified(): static
    {
        return $this->state(fn (array $attributes) => ['email_verified_at' => null]);
    }
}

// database/factories/ProductFactory.php
class ProductFactory extends Factory
{
    public function definition(): array
    {
        return [
            'name' => fake()->unique()->words(3, true),
            'slug' => fn (array $attrs) => Str::slug($attrs['name']),
            'description' => fake()->paragraph(),
            'price' => fake()->numberBetween(100, 100000),
            'stock' => fake()->numberBetween(0, 100),
            'is_active' => true,
            'user_id' => UserFactory::new(),
        ];
    }

    public function outOfStock(): static
    {
        return $this->state(fn (array $attributes) => ['stock' => 0]);
    }
}

Factories verwenden

$user = User::factory()->create();
$admin = User::factory()->admin()->create();
$product = Product::factory()->create(['user_id' => $user->id]);
$products = Product::factory()->count(10)->create();
$draft = Product::factory()->make(); // Nicht persistiert

// Mit Beziehungen
$user = User::factory()->has(Product::factory()->count(3))->create();

// Sequenzen
User::factory()->count(3)->sequence(
    ['role' => 'admin'], ['role' => 'editor'], ['role' => 'user'],
)->create();

Modell-Tests

namespace Tests\Unit\Models;

use App\Models\User;
use App\Models\Product;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class UserTest extends TestCase
{
    use RefreshDatabase;

    public function test_it_hides_sensitive_attributes(): void
    {
        $user = User::factory()->create();
        $this->assertArrayNotHasKey('password', $user->toArray());
    }

    public function test_admin_scope_returns_only_admins(): void
    {
        User::factory()->admin()->create();
        User::factory()->count(3)->create();

        $this->assertCount(1, User::admin()->get());
    }
}

class ProductTest extends TestCase
{
    use RefreshDatabase;

    public function test_active_scope_filters_correctly(): void
    {
        Product::factory()->count(3)->create(['is_active' => true]);
        Product::factory()->count(2)->create(['is_active' => false]);

        $this->assertCount(3, Product::active()->get());
    }

    public function test_it_belongs_to_a_user(): void
    {
        $user = User::factory()->create();
        $product = Product::factory()->create(['user_id' => $user->id]);

        $this->assertTrue($product->user->is($user));
    }
}

Feature-/HTTP-Tests

namespace Tests\Feature\Http\Controllers;

use App\Models\Product;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class ProductControllerTest extends TestCase
{
    use RefreshDatabase;

    public function test_guests_are_redirected_to_login(): void
    {
        $this->get(route('products.create'))->assertRedirect(route('login'));
    }

    public function test_it_stores_a_new_product(): void
    {
        $user = User::factory()->create();
        $this->actingAs($user);

        $response = $this->post(route('products.store'), [
            'name' => 'New Product',
            'description' => 'Description',
            'price' => 2999,
            'stock' => 10,
        ]);

        $response->assertRedirect(route('products.index'));
        $this->assertDatabaseHas('products', [
            'name' => 'New Product',
            'user_id' => $user->id,
        ]);
    }

    public function test_it_validates_required_fields(): void
    {
        $this->actingAs(User::factory()->create());
        $this->post(route('products.store'), [])
            ->assertSessionHasErrors(['name', 'price']);
    }

    public function test_users_cannot_modify_others_products(): void
    {
        $owner = User::factory()->create();
        $attacker = User::factory()->create();
        $product = Product::factory()->create(['user_id' => $owner->id]);

        $this->actingAs($attacker)
            ->delete(route('products.destroy', $product))
            ->assertForbidden();
    }
}

JSON-API-Tests

namespace Tests\Feature\Http\Controllers\Api;

use App\Models\Product;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class ProductApiTest extends TestCase
{
    use RefreshDatabase;

    public function test_unauthenticated_requests_are_rejected(): void
    {
        $this->getJson('/api/products')->assertUnauthorized();
    }

    public function test_it_lists_paginated_products(): void
    {
        $user = User::factory()->create();
        Product::factory()->count(5)->create(['user_id' => $user->id]);

        $response = $this->actingAs($user)->getJson('/api/products');

        $response->assertOk();
        $response->assertJsonCount(5, 'data');
        $response->assertJsonStructure([
            'data' => [['id', 'name', 'price']],
            'meta' => ['current_page', 'last_page', 'total'],
        ]);
    }

    public function test_it_creates_a_product(): void
    {
        $user = User::factory()->create();

        $response = $this->actingAs($user)->postJson('/api/products', [
            'name' => 'API Product',
            'price' => 4999,
        ]);

        $response->assertCreated();
        $response->assertJsonPath('data.name', 'API Product');
    }

    public function test_users_cannot_delete_others_products(): void
    {
        $owner = User::factory()->create();
        $attacker = User::factory()->create();
        $product = Product::factory()->create(['user_id' => $owner->id]);

        $this->actingAs($attacker)
            ->deleteJson("/api/products/{$product->id}")
            ->assertForbidden();
    }
}

Sanctum-API-Auth-Tests

namespace Tests\Feature\Http\Controllers\Api;

use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Hash;
use Tests\TestCase;

class AuthControllerTest extends TestCase
{
    use RefreshDatabase;

    public function test_users_can_register(): void
    {
        $response = $this->postJson('/api/register', [
            'name' => 'Test User',
            'email' => '[email protected]',
            'password' => 'Password123!',
            'password_confirmation' => 'Password123!',
        ]);

        $response->assertCreated();
        $response->assertJsonStructure(['data' => ['user', 'token']]);
    }

    public function test_users_can_login(): void
    {
        User::factory()->create([
            'email' => '[email protected]',
            'password' => Hash::make('Password123!'),
        ]);

        $response = $this->postJson('/api/login', [
            'email' => '[email protected]',
            'password' => 'Password123!',
        ]);

        $response->assertOk();
        $response->assertJsonStructure(['data' => ['token']]);
    }

    public function test_users_cannot_login_with_wrong_password(): void
    {
        User::factory()->create(['email' => '[email protected]']);

        $this->postJson('/api/login', [
            'email' => '[email protected]',
            'password' => 'wrong',
        ])->assertUnprocessable();
    }

    public function test_token_bearer_authenticates_requests(): void
    {
        $user = User::factory()->create();
        $token = $user->createToken('test')->plainTextToken;

        $this->withToken($token)
            ->getJson('/api/user')
            ->assertOk()
            ->assertJsonPath('data.email', $user->email);
    }
}

Mocken und Fakes

HTTP-Fake

use Illuminate\Support\Facades\Http;

public function test_it_handles_successful_payment(): void
{
    Http::fake([
        'api.stripe.com/*' => Http::response(['id' => 'pi_123', 'status' => 'succeeded'], 200),
    ]);

    $result = (new PaymentService())->charge(2999);
    $this->assertTrue($result->success);
}

public function test_it_handles_gateway_failure(): void
{
    Http::fake([
        'api.stripe.com/*' => Http::response(['error' => 'card_declined'], 402),
    ]);

    $this->expectException(PaymentFailedException::class);
    (new PaymentService())->charge(2999);
}

public function test_it_retries_on_timeout(): void
{
    Http::fake([
        'api.stripe.com/*' => Http::sequence()
            ->pushStatus(408)
            ->pushStatus(200),
    ]);

    $this->assertTrue((new PaymentService())->charge(2999)->success);
}

Mail-Fake

Mail::fake();

$order->sendConfirmation();

Mail::assertSent(OrderConfirmation::class, function ($mail) use ($order) {
    return $mail->hasTo($order->user->email);
});

Benachrichtigungs-Fake

Notification::fake();

$user->notify(new WelcomeUser());

Notification::assertSentTo($user, WelcomeUser::class);

Queue-Fake

Queue::fake();

ProcessImage::dispatch($product);

Queue::assertPushed(ProcessImage::class, function ($job) use ($product) {
    return $job->product->id === $product->id;
});

Storage-Fake

Storage::fake('public');

$file = UploadedFile::fake()->image('photo.jpg', 200, 200);

$response = $this->actingAs($user)->post('/avatar', [
    'avatar' => $file,
]);

$response->assertSessionHasNoErrors();
Storage::disk('public')->assertExists('avatars/' . $file->hashName());

Event-Fake

Event::fake();

$order->markAsShipped();

Event::assertDispatched(OrderShipped::class, function ($event) use ($order) {
    return $event->order->id === $order->id;
});

Artisan-Befehls-Tests

public function test_it_sends_newsletters(): void
{
    Mail::fake();
    User::factory()->count(5)->create(['subscribed' => true]);

    $this->artisan('newsletter:send')
        ->expectsOutput('Sending newsletter to 5 subscribers...')
        ->assertExitCode(0);

    Mail::assertSent(NewsletterMail::class, 5);
}

public function test_it_handles_no_subscribers(): void
{
    $this->artisan('newsletter:send')
        ->expectsOutput('No subscribers found.')
        ->assertExitCode(0);
}

Autorisierungstests

public function test_users_can_update_own_posts(): void
{
    $user = User::factory()->create();
    $post = Post::factory()->create(['user_id' => $user->id]);

    $this->actingAs($user)
        ->put(route('posts.update', $post), ['title' => 'Updated'])
        ->assertRedirect();
}

public function test_users_cannot_update_others_posts(): void
{
    $post = Post::factory()->create();
    $this->actingAs(User::factory()->create())
        ->put(route('posts.update', $post), ['title' => 'Hacked'])
        ->assertForbidden();
}

Codeabdeckung

# Mit phpdbg (empfohlen)
phpdbg -qrr vendor/bin/phpunit --coverage-html coverage

# Mit Xdebug
php -d xdebug.mode=coverage vendor/bin/phpunit --coverage-html coverage

# Minimale Abdeckung erzwingen
php vendor/bin/phpunit --coverage-min=80

tests/Feature/CoverageTest.php

use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class CoverageTest extends TestCase
{
    use RefreshDatabase;

    public function test_all_commands_have_tests(): void
    {
        $commands = collect(Artisan::all())
            ->reject(fn ($command) => str_starts_with($command->getName(), '_'))
            ->pluck('getName');

        $testMethods = collect(get_class_methods($this))
            ->filter(fn ($method) => str_starts_with($method, 'test_'));

        $covered = $commands->every(function ($name) use ($testMethods) {
            return $testMethods->contains(fn ($method) => str_contains($method, $name));
        });

        $this->assertTrue($covered, 'Nicht alle Artisan-Befehle haben korrespondierende Tests.');
    }
}

Pest-Beispiele

// tests/Feature/ProductTest.php
uses(RefreshDatabase::class);

test('Gäste werden zur Anmeldeseite umgeleitet', function () {
    $this->get(route('products.create'))
        ->assertRedirect(route('login'));
});

test('ein Produkt kann erstellt werden', function () {
    actingAsUser()
        ->post(route('products.store'), [
            'name' => 'Test Produkt',
            'price' => 1999,
        ])
        ->assertRedirect(route('products.index'));

    $this->assertDatabaseHas('products', ['name' => 'Test Produkt']);
});

test('erforderliche Felder werden validiert', function () {
    actingAsUser()
        ->post(route('products.store'), [])
        ->assertSessionHasErrors(['name', 'price']);
});

test('Benutzer können keine Produkte anderer ändern', function () {
    $owner = User::factory()->create();
    $product = Product::factory()->create(['user_id' => $owner->id]);

    actingAsUser()
        ->delete(route('products.destroy', $product))
        ->assertForbidden();
});

test('Produktkatalog ist paginiert', function () {
    Product::factory()->count(30)->create();

    actingAsUser()
        ->get('/api/products')
        ->assertOk()
        ->assertJsonCount(15, 'data')
        ->assertJsonStructure(['data', 'meta']);
});

test('Admin kann Produkte löschen', function () {
    $admin = User::factory()->admin()->create();
    $product = Product::factory()->create();

    $this->actingAs($admin)
        ->delete(route('products.destroy', $product))
        ->assertRedirect();
});

Tipps für Laravel-Feature-Tests

• Verwenden Sie withoutExceptionHandling() nur, wenn Sie Frameworks-Meldungen für erwartete Ausnahmen testen. Andernfalls lassen Sie es aus, damit assertStatus() und andere Assertions korrekt funktionieren.
• Bevorzugen Sie assertDatabaseHas() / assertDatabaseMissing() gegenüber direkten DB-Abfragen, um die Lesbarkeit zu erhöhen.
• Testen Sie nur die Logik, die Sie besitzen. Mocken Sie Stripe, Mailgun, Slack und andere Dienste von Drittanbietern.
• Verwenden Sie RefreshDatabase für Feature-Tests, aber vermeiden Sie es bei Unit-Tests für Geschäftslogik, die keine Datenbank benötigen.
• Schreiben Sie Tests vor dem Code, um eine bessere Architektur zu erzielen und Kopplung zu reduzieren.
• Verwenden Sie Notification::fake() und Event::fake(), um Seiteneffekte in HTTP-Tests zu vermeiden.
• Lagern Sie Test-Helfer, die Factorys oder HTTP-Double verwenden, aus, um sie in mehreren Testsuiten wiederzuverwenden.
• Halten Sie Tests klein und fokussiert: Jeder Test sollte genau eine Sache überprüfen.
• Nutzen Sie assertJsonPath() für API-Tests: $response->assertJsonPath('data.email', $user->email).
• Verwenden Sie Sequenzen in Factorys, um unterschiedliche Zustände zu testen, z. B. ['role' => 'admin'] und ['role' => 'user'].