Laravel中如何正确测试手动标记失败的队列任务？

先修正Job代码 #

调用$this->fail()只会标记任务状态为失败，但不会中断handle方法的执行，所以必须在之后加上return终止后续代码，避免不该执行的逻辑运行：

class ExampleJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public function __construct(public Foo $foo) {} // 假设注入Foo实例

    public function handle()
    {
        // 一些初始逻辑

        if (! $this->foo->exampleMethod()) {
            event(new ExampleEvent($this->foo));
            $this->fail();
            return; // 新增：终止后续代码执行
        }

        // 若任务失败则不应执行的后续逻辑
        dd('You should not get here');
    }
}

正确的测试写法 #

你的测试用了Bus::fake()，这会直接阻止任务实际执行，导致handle方法根本没运行，自然测不出失败逻辑。下面是两种可行的测试方案：

方案1：同步执行任务（适合快速测试） #

用dispatchSync直接同步执行任务，无需启动队列工作器：

/** @test */
public function job_marks_as_failed_when_condition_not_met()
{
    Event::fake();
    
    // 模拟Foo实例的exampleMethod返回false，触发失败分支
    $foo = Mockery::mock(Foo::class);
    $foo->shouldReceive('exampleMethod')->andReturn(false);

    // 同步分发并执行任务
    $job = ExampleJob::dispatchSync($foo);

    // 断言任务被标记为失败
    $this->assertTrue($job->hasFailed());
    
    // 断言事件被正确触发
    Event::assertDispatched(ExampleEvent::class, function ($event) use ($foo) {
        return $event->foo->is($foo); // 可选：验证事件携带的实例匹配
    });
}

方案2：模拟真实队列执行 #

用队列工作器执行任务，更贴近生产环境场景：

/** @test */
public function job_marks_as_failed_when_condition_not_met()
{
    Event::fake();
    
    $foo = Mockery::mock(Foo::class);
    $foo->shouldReceive('exampleMethod')->andReturn(false);

    // 分发任务到队列
    ExampleJob::dispatch($foo);

    // 执行队列中的任务
    Queue::work();

    // 断言任务失败
    Queue::assertFailed(ExampleJob::class);
    
    // 断言事件触发
    Event::assertDispatched(ExampleEvent::class);
}

关键注意点 #

• 不要用Bus::fake()或Queue::fake()：这类fake方法会阻止任务实际执行逻辑，如果你要测试任务内部的失败分支，必须让任务真实运行。
• $this->fail()不终止方法：手动标记失败后，必须手动加return或抛出异常（用return更贴合手动标记失败的场景）来中断后续代码。

内容的提问来源于stack exchange，提问作者antimonio