HTTP 테스트 (HTTP Tests)
소개 (Introduction)
Laravel은 애플리케이션에 HTTP 요청을 보내고 응답을 검사할 수 있는 매우 직관적인 API를 제공합니다. 예를 들어, 아래에 정의된 기능 테스트를 살펴보겠습니다.
<?php
test('the application returns a successful response', function () {
$response = $this->get('/');
$response->assertStatus(200);
});
<?php
namespace Tests\Feature;
use Tests\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic test example.
*/
public function test_the_application_returns_a_successful_response(): void
{
$response = $this->get('/');
$response->assertStatus(200);
}
}
get 메서드는 애플리케이션에 GET 요청을 보내고, assertStatus 메서드는 반환된 응답이 지정된 HTTP 상태 코드를 가져야 한다는 것을 검증합니다. 이 간단한 Assertion 외에도 Laravel은 응답 헤더, 콘텐츠, JSON 구조 등을 검사할 수 있는 다양한 Assertion을 제공합니다.
요청 만들기 (Making Requests)
애플리케이션에 요청을 보내려면 테스트 내부에서 get, post, put, patch, delete 메서드를 호출하면 됩니다. 이러한 메서드는 실제 HTTP 요청을 보내는 것이 아니라, 네트워크 요청을 내부적으로 시뮬레이션합니다.
테스트 요청 메서드는 Illuminate\Http\Response 인스턴스를 반환하는 대신 Illuminate\Testing\TestResponse 인스턴스를 반환합니다. 이 객체는 애플리케이션의 응답을 검사할 수 있도록 다양한 유용한 Assertion을 제공합니다.
<?php
test('basic request', function () {
$response = $this->get('/');
$response->assertStatus(200);
});
<?php
namespace Tests\Feature;
use Tests\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic test example.
*/
public function test_a_basic_request(): void
{
$response = $this->get('/');
$response->assertStatus(200);
}
}
일반적으로 각 테스트는 애플리케이션에 하나의 요청만 수행하는 것이 좋습니다. 하나의 테스트 메서드에서 여러 요청을 실행하면 예상치 못한 동작이 발생할 수 있습니다.
[!NOTE] 편의를 위해 테스트를 실행할 때는 CSRF 미들웨어가 자동으로 비활성화됩니다.
요청 헤더 커스터마이징
요청을 애플리케이션으로 보내기 전에 withHeaders 메서드를 사용하여 요청 헤더를 설정할 수 있습니다. 이 메서드를 사용하면 원하는 사용자 정의 헤더를 요청에 추가할 수 있습니다.
<?php
test('interacting with headers', function () {
$response = $this->withHeaders([
'X-Header' => 'Value',
])->post('/user', ['name' => 'Sally']);
$response->assertStatus(201);
});
<?php
namespace Tests\Feature;
use Tests\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic functional test example.
*/
public function test_interacting_with_headers(): void
{
$response = $this->withHeaders([
'X-Header' => 'Value',
])->post('/user', ['name' => 'Sally']);
$response->assertStatus(201);
}
}
쿠키
요청을 보내기 전에 withCookie 또는 withCookies 메서드를 사용하여 쿠키 값을 설정할 수 있습니다.
withCookie는 쿠키 이름과 값을 인수로 받습니다.withCookies는 이름 / 값 쌍의 배열을 받습니다.
<?php
test('interacting with cookies', function () {
$response = $this->withCookie('color', 'blue')->get('/');
$response = $this->withCookies([
'color' => 'blue',
'name' => 'Taylor',
])->get('/');
//
});
<?php
namespace Tests\Feature;
use Tests\TestCase;
class ExampleTest extends TestCase
{
public function test_interacting_with_cookies(): void
{
$response = $this->withCookie('color', 'blue')->get('/');
$response = $this->withCookies([
'color' => 'blue',
'name' => 'Taylor',
])->get('/');
//
}
}
세션 / 인증
Laravel은 HTTP 테스트 중 세션과 상호작용할 수 있는 여러 헬퍼를 제공합니다.
먼저 withSession 메서드를 사용하면 요청을 보내기 전에 세션 데이터를 배열 형태로 설정할 수 있습니다.
<?php
test('interacting with the session', function () {
$response = $this->withSession(['banned' => false])->get('/');
//
});
<?php
namespace Tests\Feature;
use Tests\TestCase;
class ExampleTest extends TestCase
{
public function test_interacting_with_the_session(): void
{
$response = $this->withSession(['banned' => false])->get('/');
//
}
}
Laravel의 세션은 일반적으로 현재 인증된 사용자의 상태를 유지하는 데 사용됩니다. 따라서 actingAs 헬퍼 메서드를 사용하면 특정 사용자를 현재 사용자로 쉽게 인증할 수 있습니다.
예를 들어 모델 팩토리를 사용하여 사용자를 생성하고 인증할 수 있습니다.
<?php
use App\Models\User;
test('an action that requires authentication', function () {
$user = User::factory()->create();
$response = $this->actingAs($user)
->withSession(['banned' => false])
->get('/');
//
});
<?php
namespace Tests\Feature;
use App\Models\User;
use Tests\TestCase;
class ExampleTest extends TestCase
{
public function test_an_action_that_requires_authentication(): void
{
$user = User::factory()->create();
$response = $this->actingAs($user)
->withSession(['banned' => false])
->get('/');
//
}
}
actingAs 메서드의 두 번째 인수로 guard 이름을 전달하여 사용할 guard를 지정할 수도 있습니다. actingAs에 전달된 guard는 테스트 실행 동안 기본 guard로 사용됩니다.
$this->actingAs($user, 'web');
요청이 인증되지 않은 상태임을 보장하고 싶다면 actingAsGuest 메서드를 사용할 수 있습니다.
$this->actingAsGuest();
응답 디버깅
테스트 요청을 보낸 후 dump, dumpHeaders, dumpSession 메서드를 사용하여 응답 내용을 확인하고 디버깅할 수 있습니다.
<?php
test('basic test', function () {
$response = $this->get('/');
$response->dump();
$response->dumpHeaders();
$response->dumpSession();
});
<?php
namespace Tests\Feature;
use Tests\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic test example.
*/
public function test_basic_test(): void
{
$response = $this->get('/');
$response->dump();
$response->dumpHeaders();
$response->dumpSession();
}
}
또는 dd, ddHeaders, ddBody, ddJson, ddSession 메서드를 사용하면 응답 정보를 출력한 뒤 실행을 중단할 수 있습니다.
<?php
test('basic test', function () {
$response = $this->get('/');
$response->dd();
$response->ddHeaders();
$response->ddBody();
$response->ddJson();
$response->ddSession();
});
<?php
namespace Tests\Feature;
use Tests\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic test example.
*/
public function test_basic_test(): void
{
$response = $this->get('/');
$response->dd();
$response->ddHeaders();
$response->ddBody();
$response->ddJson();
$response->ddSession();
}
}
예외 처리
때때로 애플리케이션이 특정 예외를 발생시키는지 테스트해야 할 수 있습니다. 이를 위해 Exceptions 파사드(Facade)를 사용하여 예외 핸들러를 "fake" 처리할 수 있습니다.
예외 핸들러를 fake 처리한 후 assertReported 및 assertNotReported 메서드를 사용하여 요청 중 발생한 예외에 대해 Assertion을 수행할 수 있습니다.
<?php
use App\Exceptions\InvalidOrderException;
use Illuminate\Support\Facades\Exceptions;
test('exception is thrown', function () {
Exceptions::fake();
$response = $this->get('/order/1');
// Assert an exception was thrown...
Exceptions::assertReported(InvalidOrderException::class);
// Assert against the exception...
Exceptions::assertReported(function (InvalidOrderException $e) {
return $e->getMessage() === 'The order was invalid.';
});
});
<?php
namespace Tests\Feature;
use App\Exceptions\InvalidOrderException;
use Illuminate\Support\Facades\Exceptions;
use Tests\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic test example.
*/
public function test_exception_is_thrown(): void
{
Exceptions::fake();
$response = $this->get('/');
// Assert an exception was thrown...
Exceptions::assertReported(InvalidOrderException::class);
// Assert against the exception...
Exceptions::assertReported(function (InvalidOrderException $e) {
return $e->getMessage() === 'The order was invalid.';
});
}
}
assertNotReported 및 assertNothingReported 메서드를 사용하면 특정 예외가 발생하지 않았는지, 또는 어떤 예외도 발생하지 않았는지 검증할 수 있습니다.
Exceptions::assertNotReported(InvalidOrderException::class);
Exceptions::assertNothingReported();
특정 요청에 대해 예외 처리를 완전히 비활성화하려면 요청 전에 withoutExceptionHandling 메서드를 호출하면 됩니다.
$response = $this->withoutExceptionHandling()->get('/');
또한 애플리케이션이 PHP 언어 또는 사용 중인 라이브러리에서 deprecated(사용 중단 예정) 기능을 사용하지 않는지 확인하려면 withoutDeprecationHandling 메서드를 사용할 수 있습니다.
이 기능을 비활성화하면 deprecation 경고가 예외로 변환되어 테스트가 실패하게 됩니다.
$response = $this->withoutDeprecationHandling()->get('/');
assertThrows 메서드는 주어진 클로저 내부 코드가 특정 타입의 예외를 발생시키는지 검증할 때 사용합니다.
$this->assertThrows(
fn () => (new ProcessOrder)->execute(),
OrderInvalid::class
);
발생한 예외를 검사하려면 두 번째 인수로 클로저를 전달할 수 있습니다.
$this->assertThrows(
fn () => (new ProcessOrder)->execute(),
fn (OrderInvalid $e) => $e->orderId() === 123;
);
assertDoesntThrow 메서드는 주어진 클로저 내부 코드가 어떤 예외도 발생시키지 않는지 검증할 때 사용합니다.
$this->assertDoesntThrow(fn () => (new ProcessOrder)->execute());