Laravel任务测试无响应：如何验证Job内服务方法的执行

我搭建了一个接收客户端payload的Webhook API，接口地址为/api/v1/webhooks/received，会把收到的payload分发到Job中执行。

我的Job代码如下：

<?php
namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldBeUnique;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;

class DecisionWebhooksJob implements ShouldQueue
{
    use Dispatchable;
    use InteractsWithQueue;
    use Queueable;
    use SerializesModels;

    /**
     * Create a new job instance.
     *
     * @return void
     */
    public function __construct(private $data)
    {
        $this->data = $data;
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        (new AutoDecisionService())->prepareAutoDecision($this->data);
    }
}

我写了测试代码验证Job是否分发成功：

public function test_dynamic_decision_webhooks_job_dispatched()
{
    $payload['data'] = $this->getPayload();

    Bus::fake();
    DecisionWebhooksJob::dispatch($payload);
    $response = Bus::assertDispatched(DecisionWebhooksJob::class);

     return $response; // 无响应返回
}

现在Job能成功分发，但测试没有返回响应，我想知道怎么验证Job里的AutoDecisionService()->prepareAutoDecision()方法是否正常工作并返回响应？

解决方案 #

1. 模拟服务类，验证方法调用与参数 #

用Mockery模拟AutoDecisionService，可以精准验证目标方法是否被调用、传入参数是否正确，还能指定模拟返回值：

public function test_job_triggers_service_method()
{
    $payload['data'] = $this->getPayload();
    
    // 模拟AutoDecisionService实例
    $serviceMock = Mockery::mock(AutoDecisionService::class);
    $this->app->instance(AutoDecisionService::class, $serviceMock);
    
    // 预期prepareAutoDecision方法会被调用一次，参数为传入的payload
    $serviceMock->shouldReceive('prepareAutoDecision')
                ->once()
                ->with($payload)
                ->andReturn('模拟的返回结果'); // 可自定义返回值
    
    // 直接实例化Job并执行handle方法，跳过队列分发环节
    $job = new DecisionWebhooksJob($payload);
    $job->handle();
}

2. 修改Job获取返回值，直接断言结果 #

如果需要验证服务方法的实际返回内容，可以修改Job的handle方法，让它返回服务方法的执行结果，再在测试中调用并断言：

// 先修改Job的handle方法：
public function handle()
{
    return (new AutoDecisionService())->prepareAutoDecision($this->data);
}

// 测试代码：
public function test_service_method_returns_correct_value()
{
    $payload['data'] = $this->getPayload();
    
    $job = new DecisionWebhooksJob($payload);
    $result = $job->handle();
    
    // 断言返回结果符合预期
    $this->assertEquals('你预期的返回内容', $result);
}

3. 禁用队列模拟，测试完整执行流程 #

如果要验证端到端的完整流程（包括Job实际执行），可以去掉Bus::fake()，测试环境下队列默认同步执行，然后验证服务方法执行后的副作用（比如数据库变更、外部交互痕迹）：

public function test_full_job_execution_flow()
{
    $payload['data'] = $this->getPayload();
    
    // 直接分发Job，测试环境会同步执行
    DecisionWebhooksJob::dispatch($payload);
    
    // 验证服务方法执行后的结果，比如检查数据库是否新增对应记录
    $this->assertDatabaseHas('target_table', [
        'related_field' => $payload['data']['key']
    ]);
}

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