Laravel - 编写一个测试用例以检查服务类触发的自定义异常是否通过render方法生成日志

Question

在我的Laravel项目中，我有一个服务类：

use GuzzleHttp\Client;
use App\Services\ApiService\Exceptions\ServiceException

class ApiService {
    __construct(
        protected Client $client
    ) {
    }

    public function request() {

        try {
            $response = $this->client->get('/test');
        } catch (Exception $e) {
            throw new ServiceException($e->getMessage(), $e->getCode(), $e);
        }

        return response;
    }
}

我的自定义异常类ServiceException如下所示：

class ServiceException extends Exception {
    public function __construct($message, $code, $previous) {
        parent::__construct($message, $code, $previous);
    }

    public function report() {
        Log::error($this->getMessage());
    }
}

并且我已经编写了一个测试用例，尝试验证当ApiService::request抛出ServiceException时，是否调用了Log::error方法：

test_api_service_logs_error_when_request_fails() {
    $clientMock = new Client([
        'handler' => HandlerStack::create(
            new MockHandler([
                new Response(500, [], 'Internal Server Error')
            ])
        )
    ]);

    Log::shouldReceive('error')
        ->once()

    $service = new ApiService($clientMock);
    $service->request();
}

当我运行测试时，我得到了如下错误：

Method error() from Mockery_0_Illuminate_Log_LogManager should be called

据我理解，Laravel应该能够检测到ServiceException::report方法并触发Log::error调用，但目前看来并未如此。显然，在测试执行过程中和实际运行时Laravel的行为存在差异。如果有谁能帮我解答这个问题，将不胜感激！

gsm2009 · Answer

问题并不在于Laravel本身，而在于您对测试和异常处理的理解上。

根据Laravel文档（https://laravel.com/docs/10.x/http-tests#exception-handling）：

assertThrows方法可用于断言给定闭包内的代码抛出指定类型的异常：

$this->assertThrows(
    function () {
        (new ProcessOrder)->execute();
    },
    OrderInvalid::class
);

同时，请阅读关于withoutExceptionHandling()的说明，它指出：

有时你可能想要测试应用程序是否抛出了特定的异常。为了确保该异常不会被Laravel的异常处理器捕获并作为HTTP响应返回，你可以在发起请求之前调用withoutExceptionHandling方法：

$this->withoutExceptionHandling();

此外，由于您的异常已经处理了日志记录功能，因此无需测试Laravel的核心功能，这样做是有些冗余的。

你应该测试的是是否正确抛出了异常。

test_api_service_logs_error_when_request_fails() {
    $clientMock = new Client([
        'handler' => HandlerStack::create(
            new MockHandler([
                new Response(500, [], 'Internal Server Error')
            ])
        )
    ]);

    // 断言在请求失败时会抛出ServiceException
    $this->assertThrows(
        fn () => (new ApiService($clientMock))->request(),
        ServiceException::class
    );
}