테스팅: 시작하기

• 소개
• 환경
• 테스트 생성
• 테스트 실행
  • 병렬 테스트 실행
  • 테스트 커버리지 보고
  • 테스트 프로파일링

소개

Laravel은 테스팅을 염두에 두고 만들어졌습니다. 실제로 Pest 및 PHPUnit을 사용한 테스팅 지원이 기본적으로 포함되어 있으며, phpunit.xml 파일이 이미 애플리케이션에 설정되어 있습니다. 프레임워크는 또한 애플리케이션을 표현적으로 테스트할 수 있는 편리한 헬퍼 메서드를 제공합니다.

기본적으로 애플리케이션의 tests 디렉토리에는 Feature 및 Unit의 두 디렉토리가 포함되어 있습니다. 단위 테스트는 코드의 매우 작고 격리된 부분에 초점을 맞춘 테스트입니다. 실제로 대부분의 단위 테스트는 단일 메서드에 초점을 맞춥니다. "Unit" 테스트 디렉토리 내의 테스트는 Laravel 애플리케이션을 부팅하지 않으므로 애플리케이션의 데이터베이스나 다른 프레임워크 서비스에 액세스할 수 없습니다.

기능 테스트는 여러 객체가 서로 상호 작용하는 방식 또는 JSON 엔드포인트에 대한 전체 HTTP 요청을 포함하여 코드의 더 큰 부분을 테스트할 수 있습니다. 일반적으로 대부분의 테스트는 기능 테스트여야 합니다. 이러한 유형의 테스트는 시스템 전체가 의도한 대로 작동하고 있다는 가장 큰 확신을 제공합니다.

ExampleTest.php 파일은 Feature 및 Unit 테스트 디렉토리 모두에 제공됩니다. 새 Laravel 애플리케이션을 설치한 후 vendor/bin/pest, vendor/bin/phpunit 또는 php artisan test 명령을 실행하여 테스트를 실행합니다.

환경

테스트를 실행할 때 Laravel은 phpunit.xml 파일에 정의된 환경 변수 때문에 구성 환경을 자동으로 testing으로 설정합니다. 또한 Laravel은 테스트 중에 세션 또는 캐시 데이터가 지속되지 않도록 세션 및 캐시를 array 드라이버로 자동 구성합니다.

필요에 따라 다른 테스트 환경 구성 값을 자유롭게 정의할 수 있습니다. testing 환경 변수는 애플리케이션의 phpunit.xml 파일에서 구성할 수 있지만 테스트를 실행하기 전에 config:clear Artisan 명령을 사용하여 구성 캐시를 지워야 합니다!

.env.testing 환경 파일

또한 프로젝트 루트에 .env.testing 파일을 만들 수 있습니다. 이 파일은 Pest 및 PHPUnit 테스트를 실행하거나 --env=testing 옵션으로 Artisan 명령을 실행할 때 .env 파일 대신 사용됩니다.

테스트 생성

새 테스트 케이스를 생성하려면 make:test Artisan 명령을 사용합니다. 기본적으로 테스트는 tests/Feature 디렉토리에 배치됩니다.

php artisan make:test UserTest

tests/Unit 디렉토리 내에 테스트를 생성하고 싶다면 make:test 명령어를 실행할 때 --unit 옵션을 사용할 수 있습니다:

php artisan make:test UserTest --unit

테스트가 생성되면 Pest 또는 PHPUnit을 사용하여 평소처럼 테스트를 정의할 수 있습니다. 테스트를 실행하려면 터미널에서 vendor/bin/pest, vendor/bin/phpunit 또는 php artisan test 명령어를 실행하세요:

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

<?php
 
namespace Tests\Unit;
 
use PHPUnit\Framework\TestCase;
 
class ExampleTest extends TestCase
{
    /**
     * 기본적인 테스트 예시.
     */
    public function test_basic_test(): void
    {
        $this->assertTrue(true);
    }
}

테스트 실행하기

앞서 언급했듯이, 테스트를 작성한 후에는 pest 또는 phpunit를 사용하여 실행할 수 있습니다:

./vendor/bin/pest

./vendor/bin/phpunit

pest 또는 phpunit 명령어 외에도 test Artisan 명령어를 사용하여 테스트를 실행할 수 있습니다. Artisan 테스트 실행기는 개발 및 디버깅을 용이하게 하기 위해 자세한 테스트 보고서를 제공합니다:

php artisan test

pest 또는 phpunit 명령어에 전달할 수 있는 모든 인수는 Artisan test 명령어에도 전달할 수 있습니다:

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

병렬로 테스트 실행하기

기본적으로 Laravel과 Pest / PHPUnit은 단일 프로세스 내에서 테스트를 순차적으로 실행합니다. 하지만 여러 프로세스에서 동시에 테스트를 실행하면 테스트 실행 시간을 크게 줄일 수 있습니다. 시작하려면 brianium/paratest Composer 패키지를 "dev" 종속성으로 설치해야 합니다. 그런 다음 test Artisan 명령을 실행할 때 --parallel 옵션을 포함합니다.

composer require brianium/paratest --dev
 
php artisan test --parallel

기본적으로 Laravel은 시스템에 사용 가능한 CPU 코어 수만큼 프로세스를 생성합니다. 그러나 --processes 옵션을 사용하여 프로세스 수를 조정할 수 있습니다.

php artisan test --parallel --processes=4

병렬 테스트 및 데이터베이스

기본 데이터베이스 연결을 구성한 경우 Laravel은 테스트를 실행하는 각 병렬 프로세스에 대한 테스트 데이터베이스 생성 및 마이그레이션을 자동으로 처리합니다. 테스트 데이터베이스에는 프로세스별로 고유한 프로세스 토큰이 접미사로 추가됩니다. 예를 들어, 두 개의 병렬 테스트 프로세스가 있는 경우 Laravel은 your_db_test_1 및 your_db_test_2 테스트 데이터베이스를 생성하여 사용합니다.

기본적으로 테스트 데이터베이스는 test Artisan 명령 호출 사이에 유지되므로 후속 test 호출에서 다시 사용할 수 있습니다. 그러나 --recreate-databases 옵션을 사용하여 다시 생성할 수 있습니다.

php artisan test --parallel --recreate-databases

병렬 테스트 후크

애플리케이션 테스트에서 사용되는 특정 리소스를 여러 테스트 프로세스에서 안전하게 사용할 수 있도록 준비해야 할 수 있습니다.

ParallelTesting 파사드를 사용하면 프로세스 또는 테스트 케이스의 setUp 및 tearDown에서 실행될 코드를 지정할 수 있습니다. 주어진 클로저는 각각 프로세스 토큰과 현재 테스트 케이스를 포함하는 $token 및 $testCase 변수를 받습니다.

<?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) {
            // ...
        });
 
        // 테스트 데이터베이스가 생성될 때 실행됩니다...
        ParallelTesting::setUpTestDatabase(function (string $database, int $token) {
            Artisan::call('db:seed');
        });
 
        ParallelTesting::tearDownTestCase(function (int $token, TestCase $testCase) {
            // ...
        });
 
        ParallelTesting::tearDownProcess(function (int $token) {
            // ...
        });
    }
}

병렬 테스트 토큰 접근

애플리케이션 테스트 코드의 다른 위치에서 현재 병렬 프로세스 "토큰"에 접근하려면 token 메서드를 사용할 수 있습니다. 이 토큰은 개별 테스트 프로세스의 고유한 문자열 식별자이며 병렬 테스트 프로세스 간에 리소스를 분할하는 데 사용할 수 있습니다. 예를 들어, Laravel은 각 병렬 테스트 프로세스에서 생성된 테스트 데이터베이스의 끝에 이 토큰을 자동으로 추가합니다.

$token = ParallelTesting::token();

테스트 커버리지 보고

애플리케이션 테스트를 실행할 때 테스트 케이스가 실제로 애플리케이션 코드를 커버하는지, 테스트를 실행할 때 얼마나 많은 애플리케이션 코드가 사용되는지 확인하고 싶을 수 있습니다. 이를 위해 test 명령을 호출할 때 --coverage 옵션을 제공할 수 있습니다.

php artisan test --coverage

최소 커버리지 임계값 강제

애플리케이션에 대한 최소 테스트 커버리지 임계값을 정의하기 위해 --min 옵션을 사용할 수 있습니다. 이 임계값이 충족되지 않으면 테스트 스위트가 실패합니다.

php artisan test --coverage --min=80.3

테스트 프로파일링

Artisan 테스트 러너에는 애플리케이션에서 가장 느린 테스트를 나열하는 편리한 메커니즘도 포함되어 있습니다. --profile 옵션과 함께 test 명령을 호출하여 가장 느린 테스트 10개 목록을 표시하여 테스트 스위트 속도를 높이기 위해 개선할 수 있는 테스트를 쉽게 조사할 수 있습니다.

php artisan test --profile