Laravel Tutorials

Test Job Failures Precisely with Laravel's assertFailedWith Method

Published
Test Job Failures Precisely with Laravel's assertFailedWith Method image

Laravel introduces the assertFailedWith method for more precise testing of queued job failures, enabling developers to verify exactly how and why jobs fail rather than just confirming failure occurred.

The assertFailedWith method supports multiple assertion types for comprehensive job failure testing:

use App\Jobs\ProcessDocument;
use App\Exceptions\ProcessingException;
 
$job = (new ProcessDocument)->withFakeQueueInteractions();
 
// Test with message
$job->assertFailedWith('processing failed');
 
// Test with exception class
$job->assertFailedWith(ProcessingException::class);
 
// Test with exception instance
$job->assertFailedWith(new ProcessingException);
 
// Test with specific message
$job->assertFailedWith(new ProcessingException(message: 'invalid format'));
 
// Test with message and code
$job->assertFailedWith(new ProcessingException(message: 'timeout error', code: 408));

It could also be used for integration testing with external services:

class ExternalServiceJobTest extends TestCase
{
public function test_api_sync_handles_rate_limiting()
{
Http::fake(['*' => Http::response([], 429)]);
 
$job = new SyncExternalDataJob($apiEndpoint)
->withFakeQueueInteractions();
 
$job->handle();
 
$job->assertFailedWith(
new RateLimitException('API rate limit exceeded', 429)
);
}
 
public function test_webhook_delivery_handles_invalid_endpoint()
{
$job = new DeliverWebhookJob('invalid-url', $payload)
->withFakeQueueInteractions();
 
$job->handle();
 
$job->assertFailedWith(
new InvalidEndpointException('Invalid webhook URL format')
);
}
}

The assertFailedWith method enables comprehensive job failure testing by verifying specific failure conditions, making test suites more reliable and helping developers ensure proper error handling in their queue workers.

Harris Raftopoulos photo

Senior Software Engineer • Staff & Educator @ Laravel News • Co-organizer @ Laravel Greece Meetup

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
CPX: The Composer Package Executor for PHP image

CPX: The Composer Package Executor for PHP

Read article
Laravel AI SDK Adds Human-in-the-Loop Tool Approval image

Laravel AI SDK Adds Human-in-the-Loop Tool Approval

Read article
Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals image

Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals

Read article
Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs image

Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs

Read article
Blade Formatting in Laravel Pint image

Blade Formatting in Laravel Pint

Read article
Inertia DevTools Is Now on the Chrome Web Store image

Inertia DevTools Is Now on the Chrome Web Store

Read article