Cách giả lập (mock) một phương thức static của Facade trong Laravel?

Question

Lê Bảo · Accepted Answer

Trong Laravel, Facades cung cấp một cách đơn giản để truy cập các dịch vụ trong container của ứng dụng. Tuy nhiên, trong quá trình kiểm thử (testing), bạn có thể muốn giả lập (mock) một phương thức static của một Facade để kiểm tra hành vi của mã mà không cần thực thi mã thực tế của phương thức đó. Điều này giúp bạn kiểm soát môi trường kiểm thử tốt hơn và thực hiện các kiểm tra chính xác hơn.
Dưới đây là hướng dẫn chi tiết về cách giả lập một phương thức static của Facade trong Laravel.
Bước 1: Tạo Facade
Trước hết, giả sử bạn có một Facade mà bạn muốn giả lập. Ví dụ, giả sử bạn có một Facade MyFacade mà có một phương thức static doSomething().
namespace AppFacades;
use IlluminateSupportFacadesFacade;
class MyFacade extends Facade
{
    protected static function getFacadeAccessor()
    {
        return 'my.service'; // Định nghĩa tên của service
    }
}
Bước 2: Tạo Service
Tiếp theo, bạn có một service mà bạn muốn Facade gọi.
namespace AppServices;
class MyService
{
    public function doSomething()
    {
        return 'Doing something!';
    }
}
Bước 3: Đăng ký Service Provider
Để sử dụng Facade, bạn cần đăng ký service trong một service provider, chẳng hạn như AppServiceProvider.
namespace AppProviders;
use AppServicesMyService;
use IlluminateSupportServiceProvider;
class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->singleton('my.service', function () {
            return new MyService();
        });
    }
}
Bước 4: Giả lập phương thức static trong kiểm thử
Bây giờ, bạn đã sẵn sàng để giả lập phương thức static của Facade trong quá trình kiểm thử. Bạn có thể sử dụng phương thức shouldReceive() từ Mockery để giả lập phương thức static doSomething().
Ví dụ kiểm thử:
namespace TestsUnit;
use TestsTestCase;
use AppFacadesMyFacade;
use Mockery;
class MyFacadeTest extends TestCase
{
    public function tearDown(): void
    {
        Mockery::close();
    }
    public function testDoSomething()
    {
        // Giả lập phương thức static doSomething()
        MyFacade::shouldReceive('doSomething')
            ->once() // Số lần mong đợi gọi
            ->andReturn('Mocked response'); // Phản hồi giả lập
        // Gọi phương thức thông qua Facade
        $response = MyFacade::doSomething();
        // Kiểm tra phản hồi
        $this->assertEquals('Mocked response', $response);
    }
}
Giải thích đoạn kiểm thử:
tearDown(): Đảm bảo rằng tất cả các mock được giải phóng sau khi mỗi bài kiểm thử hoàn thành.
shouldReceive(): Giả lập phương thức static doSomething() của Facade. Bạn có thể chỉ định số lần mong đợi phương thức được gọi và trả về giá trị giả lập.
assertEquals(): Kiểm tra xem phản hồi từ phương thức có bằng giá trị giả lập hay không.
Kết luận
Giả lập một phương thức static của Facade trong Laravel là một kỹ thuật hữu ích trong kiểm thử, giúp bạn kiểm soát hành vi của mã mà không cần thực thi mã thực tế. Bằng cách sử dụng Mockery, bạn có thể dễ dàng kiểm tra các hành vi và xác thực kết quả một cách hiệu quả. Điều này không chỉ giúp nâng cao chất lượng mã mà còn cải thiện khả năng duy trì và phát triển ứng dụng của bạn.