테스트: 시작하기 (Testing: Getting Started)

• 소개
• 환경
• 테스트 생성하기
• 테스트 실행하기
  • 테스트 병렬 실행

소개

라라벨은 처음부터 테스트를 염두에 두고 설계되었습니다. 실제로, PHPUnit을 활용한 테스트 지원이 기본적으로 포함되어 있으며, 애플리케이션에는 이미 설정이 완료된 phpunit.xml 파일이 제공됩니다. 또한, 프레임워크는 애플리케이션 테스트를 더 간편하고 명확하게 작성할 수 있도록 다양한 헬퍼 메서드도 함께 제공합니다.

기본적으로 애플리케이션의 tests 디렉터리에는 Feature와 Unit 두 개의 하위 디렉터리가 있습니다. 유닛 테스트(Unit test)는 코드 내 아주 작은, 독립적인 부분만을 집중적으로 테스트합니다. 실제로 대부분의 유닛 테스트는 하나의 메서드만을 다루는 경우가 많습니다. Unit 테스트 디렉터리 내의 테스트는 라라벨 애플리케이션을 부팅하지 않으므로, 데이터베이스나 다른 프레임워크 서비스에 접근할 수 없습니다.

기능 테스트(Feature test)는 여러 객체 간의 상호작용이나, JSON 엔드포인트에 대한 전체 HTTP 요청 등 더 넓은 범위의 코드를 테스트할 수 있습니다. 일반적으로 대부분의 테스트는 기능 테스트로 작성하는 것이 좋습니다. 이런 유형의 테스트가 시스템 전체가 의도한 대로 동작하는지 가장 높은 신뢰를 제공합니다.

각 테스트 디렉터리(Feature, Unit) 모두에 ExampleTest.php 파일이 기본 제공됩니다. 새로운 라라벨 애플리케이션을 설치한 후에는 vendor/bin/phpunit 또는 php artisan test 명령어를 실행하여 테스트를 수행할 수 있습니다.

환경

테스트 실행 시 라라벨은 phpunit.xml 파일에 정의된 환경 변수 덕분에 설정 환경을 자동으로 testing으로 변경합니다. 또한, 테스트 중에는 세션과 캐시 드라이버가 자동으로 array로 설정되어, 세션이나 캐시 데이터가 실제로 저장되지 않습니다.

필요하다면 추가적인 테스트 환경 구성 값을 자유롭게 정의할 수 있습니다. testing 환경용 변수들은 애플리케이션의 phpunit.xml 파일에서 설정할 수 있지만, 테스트 실행 전에는 반드시 config:clear 아티즌 명령어로 설정 캐시를 삭제해야 합니다.

.env.testing 환경 파일

추가로, 프로젝트 루트에 .env.testing 파일을 생성할 수도 있습니다. 이 파일은 PHPUnit 테스트를 실행하거나 --env=testing 옵션을 사용하는 아티즌 명령어 실행 시 .env 파일 대신 사용됩니다.

CreatesApplication 트레이트

라라벨은 애플리케이션의 기본 TestCase 클래스에 CreatesApplication 트레이트(trait)를 포함합니다. 이 트레이트에는 테스트 실행 전에 라라벨 애플리케이션을 부트스트랩하는 createApplication 메서드가 담겨 있습니다. 이 트레이트는 해당 위치에 그대로 두어야 하며, 라라벨의 병렬 테스트 등 일부 기능이 이를 필요로 합니다.

테스트 생성하기

새로운 테스트 케이스를 생성하려면 make:test 아티즌 명령어를 사용합니다. 기본적으로 테스트는 tests/Feature 디렉터리에 생성됩니다:

php artisan make:test UserTest

만약 tests/Unit 디렉터리 내에 테스트를 생성하고 싶다면, make:test 명령어 실행 시 --unit 옵션을 추가하면 됩니다:

php artisan make:test UserTest --unit

Pest PHP 방식의 테스트를 생성하고자 한다면, make:test 명령어에 --pest 옵션을 사용할 수 있습니다:

php artisan make:test UserTest --pest
php artisan make:test UserTest --unit --pest

[!TIP] 테스트 스텁(stub)은 스텁 배포를 활용해 직접 커스터마이즈할 수 있습니다.

테스트가 생성되면, PHPUnit을 사용하듯이 원하는 대로 테스트 메서드를 정의하면 됩니다. 테스트를 실행하려면, 터미널에서 vendor/bin/phpunit 또는 php artisan test 명령어를 입력합니다:

<?php

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;

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

[!NOTE] 테스트 클래스에 직접 setUp 또는 tearDown 메서드를 정의하는 경우, 반드시 부모 클래스의 parent::setUp() 또는 parent::tearDown() 메서드를 호출해야 합니다.

테스트 실행하기

앞서 언급한 대로, 작성한 테스트는 phpunit 명령어로 실행할 수 있습니다:

./vendor/bin/phpunit

phpunit 명령어 외에도 아티즌의 test 명령어를 이용해 테스트를 실행할 수 있습니다. 아티즌 테스트 러너는 개발 및 디버깅에 도움이 되도록 상세한 테스트 리포트를 제공합니다:

php artisan test

phpunit 명령어에 전달할 수 있는 모든 인수는 아티즌 test 명령어에도 그대로 사용할 수 있습니다:

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

테스트 병렬 실행

기본적으로 라라벨과 PHPUnit은 단일 프로세스에서 차례대로(순차적으로) 테스트를 실행합니다. 하지만 여러 프로세스를 병렬로 활용하면 전체 테스트 소요 시간을 크게 줄일 수 있습니다. 이를 시작하려면 애플리케이션에 nunomaduro/collision 패키지의 버전 ^5.3 이상이 필요합니다. 그 후, 아티즌 test 명령어에 --parallel 옵션을 추가하면 됩니다:

php artisan test --parallel

라라벨은 기본적으로 시스템의 CPU 코어 수만큼의 프로세스를 생성하여 테스트를 병렬 수행합니다. 직접 프로세스 개수를 지정하고 싶다면 --processes 옵션을 사용하면 됩니다:

php artisan test --parallel --processes=4

[!NOTE] 테스트를 병렬로 실행하는 경우, 일부 PHPUnit 옵션(예: --do-not-cache-result)은 사용할 수 없습니다.

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

라라벨은 각 병렬 프로세스마다 테스트 데이터베이스를 자동으로 생성 및 마이그레이션합니다. 테스트 데이터베이스는 각 프로세스별로 고유한 토큰이 뒤에 붙어 생성됩니다. 예를 들어, 병렬 테스트 프로세스가 두 개라면 your_db_test_1, your_db_test_2와 같은 데이터베이스가 만들어집니다.

기본적으로 테스트 데이터베이스는 test 아티즌 명령어 실행 간에 유지되어, 이후 실행 시에도 재사용할 수 있습니다. 하지만, 데이터베이스를 새로 생성하고 싶다면 --recreate-databases 옵션을 사용할 수 있습니다:

php artisan test --parallel --recreate-databases

병렬 테스트 훅(Hook)

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

ParallelTesting 파사드(facade)를 사용하면, 프로세스 또는 테스트 케이스의 setUp과 tearDown 시점에 실행할 코드를 지정할 수 있습니다. 각 클로저에는 프로세스 토큰($token)과 현재 테스트 케이스($testCase)가 전달됩니다:

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\ParallelTesting;
use Illuminate\Support\ServiceProvider;

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

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

        // 테스트 데이터베이스가 생성될 때 실행됨...
        ParallelTesting::setUpTestDatabase(function ($database, $token) {
            Artisan::call('db:seed');
        });

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

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

병렬 테스트 토큰 접근하기

애플리케이션 테스트 코드 어디에서든 현재 병렬 프로세스의 "토큰"에 접근하고 싶다면, token 메서드를 사용할 수 있습니다. 이 토큰은 각각의 테스트 프로세스를 고유하게 식별하는 문자열로, 병렬 테스트 과정에서 리소스를 분리해서 사용할 때 활용할 수 있습니다. 예를 들어 라라벨은 각 병렬 테스트 프로세스마다 생성하는 테스트 데이터베이스 이름 끝에 이 토큰을 자동으로 붙입니다:

$token = ParallelTesting::token();