Doc-vn
x
Laravel

Giới thiệu

Laravel được xây dựng với mục đích để test. Thực tế là, Laravel đã mặc định hỗ trợ việc test với Pest và PHPUnit và một file phpunit.xml đã được cài đặt sẵn trong application của bạn. Framework này cũng có các phương thức trợ giúp thuận tiện cho phép bạn test application của bạn.

Mặc định, thư mục tests của application sẽ chứa hai thư mục: Feature và Unit. Các test unit là các bài test tập trung vào một phần rất nhỏ, tách biệt hoàn toàn trong code của bạn. Thực tế là, hầu hết các bài test unit có thể tập trung vào duy nhất một phương thức. Các bài test trong thư mục test "Unit" sẽ không khởi động ứng dụng Laravel của bạn và do đó sẽ không thể truy cập được vào cơ sở dữ liệu của ứng dụng hoặc các service khác của framework .

Feature test cũng có thể test được một phần lớn hơn code của bạn, chứa cả cách mà một số đối tượng tương tác với nhau hoặc thậm chí là một HTTP request được gửi tới một JSON endpoint. Nói chung, hầu hết các bài test của bạn phải là bài feature test. Loại test này sẽ mang lại sự tự tin cao nhất cho toàn bộ hệ thống của bạn đang hoạt động như dự kiến.

Một file exampleTest.php mẫu cũng đã được cung cấp sẵn ở trong hai thư mục test Feature và Unit. Sau khi bạn đã cài đặt một application Laravel mới, bạn hãy chạy vendor/bin/pest, vendor/bin/phpunit, hoặc php artisan test trên cửa sổ dòng lệnh để chạy bài test của bạn.

Environment

Khi chạy test, Laravel sẽ tự động set cấu hình môi trường là testing bởi vì các biến môi trường đã được định nghĩa trong file phpunit.xml. Laravel cũng tự động cấu hình session và cache là driver array để không có session hoặc cache nào được duy trì trong khi bạn test.

Bạn có thể tự do định nghĩa các giá trị cấu hình khác cho môi trường test nếu cần thiết. Các biến môi trường testing có thể được cấu hình trong file phpunit.xml của application của bạn, nhưng hãy đảm bảo là bạn đã xóa cấu hình cache của bạn bằng cách sử dụng lệnh Artisan config:clear trước khi chạy bài test của bạn!

The .env.testing Environment File

Ngoài ra, bạn có thể tạo file .env.testing trong thư mục gốc của project của bạn. File này sẽ được dùng để thay thế file .env khi chạy các bài test Pest và PHPUnit hoặc chạy các lệnh Artisan với tùy chọn --env=testing.

Tạo testcase

Để tạo một test case mới, hãy sử dụng lệnh Artisan make:test. Mặc định, các bài test sẽ được lưu trong thư mục tests/Feature:

php artisan make:test UserTest

Nếu bạn muốn tạo một bài test trong thư mục tests/Unit, bạn có thể sử dụng tùy chọn --unit khi chạy lệnh make:test:

php artisan make:test UserTest --unit

Nếu bạn có một test class chủ yếu dựa vào các tính năng test của Laravel, nhưng một phương thức test nhỏ lại không cần framework phải được khởi động, bạn có thể áp dụng thuộc tính #[UnitTest] lên phương thức đó để bỏ qua việc khởi động ứng dụng cho riêng bài test đó.

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\Attributes\UnitTest;
use Tests\TestCase;

class LocationServiceTest extends TestCase
{
    public function test_get_coordinates_resolves_address(): void
    {
        // This test uses Laravel's testing features...
    }

    #[UnitTest]
    public function test_get_state_returns_state_from_abbreviation(): void
    {
        // This test runs without booting the application...
    }
}

[!NOTE] Các stub của test có thể được tùy chỉnh bằng cách sử dụng export stub.

Khi file test đã được tạo xong, bạn có thể định nghĩa các bài test như khi sử dụng với Pest hoặc PHPUnit. Để chạy test của bạn, hãy chạy lệnh vendor/bin/pest, vendor/bin/phpunit, hoặc lệnh php artisan test từ terminal của bạn:

<?php

test('basic', function () {
    expect(true)->toBeTrue();
});
<?php

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     */
    public function test_basic_test(): void
    {
        $this->assertTrue(true);
    }
}

[!WARNING] Nếu bạn định nghĩa một phương thức setUp / tearDown của riêng bạn trong một test class, hãy nhớ gọi các phương thức parent::setUp() / parent::tearDown() tương ứng ở trong class parent. Thông thường, bạn nên gọi parent::setUp() khi bắt đầu phương thức setUp của riêng bạn và phương thức parent::tearDown() khi kết thúc phương thức tearDown.

Chạy testcase

Như đã đề cập trước đó, khi bạn đã viết xong bài test, bạn có thể chạy chúng bằng cách sử dụng pest hoặc phpunit:

./vendor/bin/pest
./vendor/bin/phpunit

Ngoài lệnh pest hoặc phpunit, bạn có thể sử dụng lệnh Artisan test để chạy các bài test của bạn. Artisan test runner cung cấp các báo cáo test chi tiết để dễ dàng phát triển và gỡ lỗi:

php artisan test

Bất kỳ tham số nào mà có thể được truyền vào cho lệnh pest hoặc phpunit thì cũng có thể được truyền vào cho lệnh Artisan test:

php artisan test --testsuite=Feature --stop-on-failure

Chạy testcase đồng thời

Mặc định, Laravel và Pest / PHPUnit thực hiện các bài test của bạn theo thứ tự trong một process duy nhất. Tuy nhiên, bạn có thể giảm đáng kể lượng thời gian cần thiết để chạy các bài test bằng cách chạy các bài test đó đồng thời trên nhiều process. Để bắt đầu, bạn nên cài đặt package Composer brianium/paratest dưới dạng library của "dev". Sau đó, thêm tùy chọn --parallel khi chạy lệnh Artisan test:

composer require brianium/paratest --dev

php artisan test --parallel

Mặc định, Laravel sẽ tạo số process bằng với số lõi CPU có sẵn trên máy của bạn. Tuy nhiên, bạn có thể điều chỉnh số lượng process này bằng tùy chọn --processes:

php artisan test --parallel --processes=4

[!WARNING] Khi chạy test đồng thời, một số tùy chọn Pest / PHPUnit (chẳng hạn như --do-not-cache-result) có thể không khả dụng.

Parallel Testing và Databases

Miễn là bạn đã cấu hình kết nối cơ sở dữ liệu của bạn, laravel sẽ tự động xử lý việc tạo và migration cơ sở dữ liệu test cho từng process song song đang chạy test của bạn. Cơ sở dữ liệu test sẽ được gắn với một process token duy nhất cho mỗi process. Ví dụ: nếu bạn có hai process test song song, Laravel sẽ tạo và sử dụng cơ sở dữ liệu test là your_db_test_1 và your_db_test_2.

Mặc định, cơ sở dữ liệu test vẫn tồn tại giữa các lần gọi lệnh Artisan test để chúng có thể được sử dụng lại cho các lần gọi test tiếp theo. Tuy nhiên, bạn có thể tạo lại chúng bằng tùy chọn --recreate-databases:

php artisan test --parallel --recreate-databases

Parallel Testing Hooks

Đôi khi, bạn có thể cần chuẩn bị một số resource nhất định được dùng bởi các bài test của ứng dụng để chúng có thể được sử dụng một cách an toàn trong nhiều process test.

Bằng cách sử dụng facade ParallelTesting, bạn có thể chỉ định code nào sẽ được chạy trên setUp và tearDown của một process hoặc một test case. Các closure đã cho sẽ nhận các biến $token và $testCase lần lượt là process token và test case hiện tại:

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\ParallelTesting;
use Illuminate\Support\ServiceProvider;
use PHPUnit\Framework\TestCase;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        ParallelTesting::setUpProcess(function (int $token) {
            // ...
        });

        ParallelTesting::setUpTestCase(function (int $token, TestCase $testCase) {
            // ...
        });

        // Executed when a test database is created...
        ParallelTesting::setUpTestDatabase(function (string $database, int $token) {
            Artisan::call('db:seed');
        });

        ParallelTesting::tearDownTestCase(function (int $token, TestCase $testCase) {
            // ...
        });

        ParallelTesting::tearDownProcess(function (int $token) {
            // ...
        });
    }
}

Accessing The Parallel Testing Token

Nếu bạn muốn truy cập vào "token" process song song hiện tại từ bất kỳ vị trí nào trong code kiểm tra của ứng dụng, bạn có thể sử dụng phương thức token. token này là một chuỗi nhận dạng, và duy nhất cho một process test riêng biệt và có thể được sử dụng để phân chia resource trên các process test song song. Ví dụ: Laravel tự động thêm token này vào cuối của tên cơ sở dữ liệu test được tạo bởi process test song song:

$token = ParallelTesting::token();

Báo cáo phạm vi chạy testcase

[!WARNING] Tính năng này yêu cầu Xdebug hoặc PCOV.

Khi chạy test ứng dụng, bạn có thể muốn xác định xem các test case của bạn có thực sự bao phủ code ứng dụng của bạn hay không và có bao nhiêu code trong ứng dụng của bạn được sử dụng khi chạy test. Để thực hiện điều này, bạn có thể cung cấp tùy chọn --coverage khi gọi lệnh test:

php artisan test --coverage

Enforcing A Minimum Coverage Threshold

Bạn có thể sử dụng tùy chọn --min để định nghĩa ngưỡng phạm vi kiểm tra tối thiểu cho ứng dụng của bạn. Bộ testcase sẽ không thành công nếu ngưỡng này không được đáp ứng:

php artisan test --coverage --min=80.3

Profiling Tests

Artisan test runner cũng chứa một cơ chế tiện lợi để liệt kê các bài test chậm nhất trong ứng dụng của bạn. Gọi lệnh test với tùy chọn --profile để nó cung cấp danh sách mười bài test chậm nhất của bạn, cho phép bạn dễ dàng điều tra những bài test nào có thể được cải tiến để tăng tốc bài kiểm tra của bạn:

php artisan test --profile

Configuration Caching

Khi chạy các bài test, Laravel sẽ khởi động ứng dụng cho từng phương thức test riêng lẻ. Nếu không có file cấu hình được cache, mỗi file cấu hình trong ứng dụng của bạn phải được load lại khi bắt đầu một bài test. Để build cấu hình một lần và sử dụng lại cấu hình đó cho tất cả các bài test đó trong các lần chạy còn lại, bạn có thể sử dụng trait Illuminate\Foundation\Testing\WithCachedConfig:

<?php

use Illuminate\Foundation\Testing\WithCachedConfig;

pest()->use(WithCachedConfig::class);

// ...
<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\WithCachedConfig;
use Tests\TestCase;

class ConfigTest extends TestCase
{
    use WithCachedConfig;

    // ...
}
Boost HTTP Tests
© 2023 by Logo page doc-vn