HTTP 테스트 (HTTP Tests)

• 소개
• 요청 보내기
  • 요청 헤더 커스터마이징
  • 쿠키
  • 세션 / 인증
  • 응답 디버깅
  • 예외 처리
• JSON API 테스트
  • 유창한(Fluent) JSON 테스트
• 파일 업로드 테스트
• 뷰 테스트
  • Blade & 컴포넌트 렌더링
• 사용 가능한 assertion
  • 응답 assertion
  • 인증 assertion
  • 유효성 검증 assertion

소개

라라벨은 애플리케이션에 HTTP 요청을 보내고, 그 응답을 검사할 수 있는 매우 유창한(Fluent) API를 제공합니다. 예를 들어, 아래에 정의된 기능 테스트를 살펴보십시오.

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function test_a_basic_request()
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

get 메서드는 애플리케이션 내에서 GET 요청을 수행하며, assertStatus 메서드는 반환된 응답의 HTTP 상태 코드가 지정한 값과 일치하는지 확인합니다. 이 외에도 라라벨은 응답 헤더, 내용, JSON 구조 등을 검사할 수 있는 다양한 assertion 메서드를 제공합니다.

요청 보내기

테스트 내에서 애플리케이션에 요청하려면 get, post, put, patch, delete 메서드를 사용할 수 있습니다. 이 메서드들은 실제 "HTTP" 요청을 발생시키는 것이 아니라, 내부적으로 네트워크 요청을 시뮬레이션합니다.

이러한 테스트 요청 메서드는 Illuminate\Http\Response 인스턴스를 반환하지 않고, 대신 Illuminate\Testing\TestResponse 인스턴스를 반환합니다. 이 객체는 애플리케이션의 응답을 검사할 수 있는 다양한 유용한 assertion 기능을 제공합니다.

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function test_a_basic_request()
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

일반적으로, 각 테스트는 애플리케이션에 한 번의 요청만을 보내는 것이 좋습니다. 하나의 테스트 메서드에서 여러 요청을 실행하면 예기치 않은 동작이 발생할 수 있습니다.

[!NOTE] 편의를 위해, 테스트를 실행할 때 CSRF 미들웨어는 자동으로 비활성화됩니다.

요청 헤더 커스터마이징

요청을 애플리케이션에 보내기 전에 withHeaders 메서드를 사용해서 요청의 헤더를 커스터마이즈할 수 있습니다. 이 메서드를 이용해 원하는 어떤 커스텀 헤더도 쉽게 추가할 수 있습니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function test_interacting_with_headers()
    {
        $response = $this->withHeaders([
            'X-Header' => 'Value',
        ])->post('/user', ['name' => 'Sally']);

        $response->assertStatus(201);
    }
}

쿠키

요청을 보내기 전에 쿠키 값을 설정하려면 withCookie 또는 withCookies 메서드를 사용할 수 있습니다. withCookie는 쿠키의 이름과 값을 인수로 받아 하나의 쿠키를 추가하고, withCookies는 이름/값 쌍의 배열을 받아 여러 개의 쿠키를 한 번에 추가할 수 있습니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_interacting_with_cookies()
    {
        $response = $this->withCookie('color', 'blue')->get('/');

        $response = $this->withCookies([
            'color' => 'blue',
            'name' => 'Taylor',
        ])->get('/');
    }
}

세션 / 인증

HTTP 테스트를 진행할 때 세션을 다루기 위한 여러 가지 헬퍼가 제공됩니다. 먼저, withSession 메서드를 사용하면 세션에 특정 데이터를 미리 저장할 수 있습니다. 이 방법은 요청 전에 세션에 데이터를 로드할 때 유용합니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_interacting_with_the_session()
    {
        $response = $this->withSession(['banned' => false])->get('/');
    }
}

라라벨의 세션은 일반적으로 현재 인증된 사용자의 상태를 유지하는 데 사용됩니다. 이에 따라, actingAs 헬퍼 메서드를 사용하면 지정한 사용자를 현재 사용자로 쉽게 인증할 수 있습니다. 예를 들어, 모델 팩토리를 사용하여 사용자를 생성하고 인증할 수 있습니다.

<?php

namespace Tests\Feature;

use App\Models\User;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_an_action_that_requires_authentication()
    {
        $user = User::factory()->create();

        $response = $this->actingAs($user)
                         ->withSession(['banned' => false])
                         ->get('/');
    }
}

또한, 두 번째 인수로 guard 이름을 actingAs 메서드에 전달하여 사용할 guard를 지정할 수 있습니다. 테스트가 진행되는 동안 이 메서드에 지정한 guard가 기본 guard로 사용됩니다.

$this->actingAs($user, 'web')

응답 디버깅

테스트 요청을 보낸 후, dump, dumpHeaders, dumpSession 메서드를 이용해 응답 내용을 확인하고 디버깅할 수 있습니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function test_basic_test()
    {
        $response = $this->get('/');

        $response->dumpHeaders();

        $response->dumpSession();

        $response->dump();
    }
}

또는, dd, ddHeaders, ddSession 메서드를 사용하면 응답 정보를 출력하고 바로 실행을 중단할 수 있습니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function test_basic_test()
    {
        $response = $this->get('/');

        $response->ddHeaders();

        $response->ddSession();

        $response->dd();
    }
}

예외 처리

때로는 애플리케이션이 특정 예외를 던지는지 테스트하고 싶을 수 있습니다. 라라벨의 예외 핸들러에서 예외가 잡혀서 HTTP 응답으로 반환되는 것을 막으려면, 요청 전에 withoutExceptionHandling 메서드를 호출할 수 있습니다.

$response = $this->withoutExceptionHandling()->get('/');

또한, PHP 언어나 애플리케이션에서 사용하는 라이브러리에서 더 이상 권장되지 않는(deprecated) 기능이 사용되는지 테스트하고 싶다면, 요청 전에 withoutDeprecationHandling 메서드를 호출할 수 있습니다. 이렇게 하면 deprecated 경고가 예외로 전환되어, 테스트가 실패하게 됩니다.

$response = $this->withoutDeprecationHandling()->get('/');

JSON API 테스트

라라벨은 JSON API 및 그 응답을 테스트할 수 있는 여러 헬퍼를 제공합니다. 예를 들어, json, getJson, postJson, putJson, patchJson, deleteJson, optionsJson 메서드를 통해 다양한 HTTP 메서드로 JSON 요청을 손쉽게 보낼 수 있습니다. 또한 데이터와 헤더도 간편하게 전달할 수 있습니다. 간단하게, /api/user로 POST 요청을 보내고 예상한 JSON 데이터가 반환되는지 확인하는 테스트 코드를 작성해보겠습니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function test_making_an_api_request()
    {
        $response = $this->postJson('/api/user', ['name' => 'Sally']);

        $response
            ->assertStatus(201)
            ->assertJson([
                'created' => true,
            ]);
    }
}

또한, JSON 응답 데이터는 배열 변수처럼 접근할 수 있으므로, 각 값이 맞게 반환되었는지 쉽게 검사할 수 있습니다.

$this->assertTrue($response['created']);

[!NOTE] assertJson 메서드는 응답을 배열로 변환한 뒤 PHPUnit::assertArraySubset을 활용하여 지정한 배열이 응답 JSON에 포함되어 있는지 확인합니다. 즉, 응답 JSON에 다른 프로퍼티가 존재해도 지정한 부분이 포함되어 있으면 이 테스트는 통과합니다.

정확히 일치하는 JSON 확인

앞서 설명했듯이, assertJson 메서드는 JSON 응답에 일부만 포함되어 있는지 검사합니다. 응답 JSON과 지정한 배열이 정확히 일치하는지 확인하고 싶다면 assertExactJson 메서드를 사용해야 합니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function test_asserting_an_exact_json_match()
    {
        $response = $this->postJson('/user', ['name' => 'Sally']);

        $response
            ->assertStatus(201)
            ->assertExactJson([
                'created' => true,
            ]);
    }
}

JSON 경로값 검사

JSON 응답에서 특정 경로의 데이터가 올바른지 확인하고 싶다면, assertJsonPath 메서드를 사용할 수 있습니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function test_asserting_a_json_paths_value()
    {
        $response = $this->postJson('/user', ['name' => 'Sally']);

        $response
            ->assertStatus(201)
            ->assertJsonPath('team.owner.name', 'Darian');
    }
}

assertJsonPath 메서드는 클로저도 받을 수 있으므로, 동적으로 assertion이 통과해야 할 조건을 지정할 수 있습니다.

$response->assertJsonPath('team.owner.name', fn ($name) => strlen($name) >= 3);

유창한(Fluent) JSON 테스트

라라벨은 애플리케이션의 JSON 응답을 유창하게 테스트할 수 있는 기능도 제공합니다. 먼저, assertJson 메서드에 클로저를 전달합니다. 이 클로저는 Illuminate\Testing\Fluent\AssertableJson 인스턴스를 받아, 반환된 JSON에 대해 assertion을 할 수 있습니다. where 메서드는 JSON의 특정 속성에 대한 assertion을, missing 메서드는 특정 속성이 JSON에서 누락되었는지 확인합니다.

use Illuminate\Testing\Fluent\AssertableJson;

/**
 * A basic functional test example.
 *
 * @return void
 */
public function test_fluent_json()
{
    $response = $this->getJson('/users/1');

    $response
        ->assertJson(fn (AssertableJson $json) =>
            $json->where('id', 1)
                 ->where('name', 'Victoria Faith')
                 ->where('email', fn ($email) => str($email)->is('[email protected]'))
                 ->whereNot('status', 'pending')
                 ->missing('password')
                 ->etc()
        );
}

etc 메서드 이해하기

위 예제에서 assertion 메서드 체인의 마지막에 etc 메서드를 사용한 것을 볼 수 있습니다. 이 메서드는 해당 JSON 객체에 다른 속성이 추가적으로 존재할 수 있음을 라라벨에 알리는 역할을 합니다. 만약 etc 메서드를 사용하지 않으면, assertion을 하지 않은 속성이 JSON 객체에 존재하면 테스트가 실패하게 됩니다.

이러한 동작의 의도는, JSON 응답에 민감한 정보가 실수로 노출되는 것을 막기 위해, 해당 속성에 대해 명시적으로 assertion을 하거나 etc를 통해 추가 속성을 허용하도록 강제하기 위함입니다.

단, assertion 체인에 etc를 포함하지 않는다고 해서, JSON 객체 내부에 있는 배열의 추가 요소까지 통제할 수 있다는 의미는 아닙니다. etc는 오직 그 메서드가 호출된 깊이의 객체에만 적용됩니다.

속성의 존재/부재 확인

속성이 존재하는지/존재하지 않는지 검증하려면, has와 missing 메서드를 사용할 수 있습니다.

$response->assertJson(fn (AssertableJson $json) =>
    $json->has('data')
         ->missing('message')
);

또한, hasAll과 missingAll 메서드를 통해 여러 속성의 존재 유무를 한 번에 검증할 수 있습니다.

$response->assertJson(fn (AssertableJson $json) =>
    $json->hasAll(['status', 'data'])
         ->missingAll(['message', 'code'])
);

hasAny 메서드를 이용하면, 지정한 속성 목록 중 하나라도 존재하는지 확인할 수 있습니다.

$response->assertJson(fn (AssertableJson $json) =>
    $json->has('status')
         ->hasAny('data', 'message', 'code')
);

JSON 컬렉션에 대한 assertion

종종, 라우트가 여러 항목이 포함된 JSON 응답(예: 여러 사용자)을 반환할 수 있습니다.

Route::get('/users', function () {
    return User::all();
});

이 경우, 유창한 JSON 객체의 has 메서드를 사용해 응답에 포함된 사용자 수를 assertion 할 수 있습니다. 예를 들어, JSON 응답에 3명의 사용자가 포함되었는지 assertion 하고, 이어 first 메서드를 사용해 컬렉션의 첫 번째 사용자에 대해 추가 검증을 할 수 있습니다. first 메서드는 클로저를 받아, 해당 JSON 컬렉션의 첫 번째 객체에 대한 assertion을 할 수 있습니다.

$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has(3)
             ->first(fn ($json) =>
                $json->where('id', 1)
                     ->where('name', 'Victoria Faith')
                     ->where('email', fn ($email) => str($email)->is('[email protected]'))
                     ->missing('password')
                     ->etc()
             )
    );

JSON 컬렉션 assertion의 범위 지정

때때로, 여러분의 애플리케이션 라우트는 키가 지정된(named) JSON 컬렉션을 반환할 수 있습니다.

Route::get('/users', function () {
    return [
        'meta' => [...],
        'users' => User::all(),
    ];
})

이러한 라우트를 테스트할 때에는, has 메서드로 컬렉션의 항목 개수를 assertion 할 수 있습니다. 또한, has 메서드를 통해 assertion의 범위를 지정해서 체이닝할 수 있습니다.

$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has('meta')
             ->has('users', 3)
             ->has('users.0', fn ($json) =>
                $json->where('id', 1)
                     ->where('name', 'Victoria Faith')
                     ->where('email', fn ($email) => str($email)->is('[email protected]'))
                     ->missing('password')
                     ->etc()
             )
    );

하지만, users 컬렉션에 대한 assertion을 위해 has 메서드를 두 번 호출하는 대신, 세 번째 인수에 클로저를 전달하여 한 번에 처리할 수 있습니다. 이 경우, 클로저는 컬렉션의 첫 번째 항목에 자동으로 적용됩니다.

$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has('meta')
             ->has('users', 3, fn ($json) =>
                $json->where('id', 1)
                     ->where('name', 'Victoria Faith')
                     ->where('email', fn ($email) => str($email)->is('[email protected]'))
                     ->missing('password')
                     ->etc()
             )
    );

JSON 타입 assertion

JSON 응답의 속성이 특정 타입인지 assertion 하고 싶을 때가 있습니다. Illuminate\Testing\Fluent\AssertableJson 클래스는 이를 위해 whereType, whereAllType 메서드를 제공합니다.

$response->assertJson(fn (AssertableJson $json) =>
    $json->whereType('id', 'integer')
         ->whereAllType([
            'users.0.name' => 'string',
            'meta' => 'array'
        ])
);

| 문자를 사용하거나, 타입 배열을 두 번째 인수로 전달하여 여러 타입을 지정할 수도 있습니다. 값이 지정한 타입 중 하나라도 일치하면 assertion은 통과합니다.

$response->assertJson(fn (AssertableJson $json) =>
    $json->whereType('name', 'string|null')
         ->whereType('id', ['string', 'integer'])
);

whereType 및 whereAllType 메서드는 다음 타입을 인식합니다: string, integer, double, boolean, array, null.

파일 업로드 테스트

Illuminate\Http\UploadedFile 클래스의 fake 메서드를 사용하면 테스트용 더미 파일이나 이미지를 쉽게 만들 수 있습니다. 이를 Storage 파사드의 fake 메서드와 함께 사용하면 파일 업로드 테스트가 매우 간단해집니다. 예를 들어, 이 두 기능을 조합하여 아바타 업로드 폼에 대한 테스트를 쉽게 작성할 수 있습니다.

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_avatars_can_be_uploaded()
    {
        Storage::fake('avatars');

        $file = UploadedFile::fake()->image('avatar.jpg');

        $response = $this->post('/avatar', [
            'avatar' => $file,
        ]);

        Storage::disk('avatars')->assertExists($file->hashName());
    }
}

특정 파일이 존재하지 않는지 assertion 하고 싶을 때는 Storage 파사드가 제공하는 assertMissing 메서드를 사용할 수 있습니다.

Storage::fake('avatars');

// ...

Storage::disk('avatars')->assertMissing('missing.jpg');

가짜 파일 커스터마이징

UploadedFile 클래스에서 제공하는 fake 메서드를 사용하여 파일을 생성할 때, 이미지의 너비, 높이, 그리고 용량(킬로바이트 단위)을 지정하여 애플리케이션의 유효성 검증 규칙을 더 효과적으로 테스트할 수 있습니다.

UploadedFile::fake()->image('avatar.jpg', $width, $height)->size(100);

이미지 생성뿐 아니라, create 메서드를 사용하면 다른 모든 종류의 파일도 생성할 수 있습니다.

UploadedFile::fake()->create('document.pdf', $sizeInKilobytes);

필요하다면, 메서드에 $mimeType 인수를 추가로 전달해 파일의 MIME 타입을 명시적으로 지정할 수 있습니다.

UploadedFile::fake()->create(
    'document.pdf', $sizeInKilobytes, 'application/pdf'
);

뷰 테스트하기

라라벨에서는 애플리케이션에 대한 실제 HTTP 요청을 시뮬레이션하지 않고도 뷰를 렌더링할 수 있습니다. 이를 위해 테스트 내에서 view 메서드를 호출하면 됩니다. view 메서드는 뷰의 이름과 선택적으로 데이터를 담은 배열을 받습니다. 이 메서드는 Illuminate\Testing\TestView 인스턴스를 반환하는데, 이 인스턴스는 뷰 내용에 대해 편리하게 assertion(확인)을 할 수 있는 여러 메서드를 제공합니다.

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_a_welcome_view_can_be_rendered()
    {
        $view = $this->view('welcome', ['name' => 'Taylor']);

        $view->assertSee('Taylor');
    }
}

TestView 클래스는 다음과 같은 assertion 메서드들을 제공합니다: assertSee, assertSeeInOrder, assertSeeText, assertSeeTextInOrder, assertDontSee, assertDontSeeText.

필요하다면, TestView 인스턴스를 문자열로 캐스팅하여 실제 렌더링된 뷰의 원본 내용을 가져올 수 있습니다.

$contents = (string) $this->view('welcome');

에러 공유하기

일부 뷰는 라라벨이 제공하는 글로벌 에러 백에 공유된 오류에 의존할 수 있습니다. 에러 메시지로 에러 백을 채우려면 withViewErrors 메서드를 사용할 수 있습니다.

$view = $this->withViewErrors([
    'name' => ['Please provide a valid name.']
])->view('form');

$view->assertSee('Please provide a valid name.');

Blade 및 컴포넌트 렌더링

필요하다면, blade 메서드를 사용해 Blade 원본 문자열을 평가하고 렌더링할 수 있습니다. view 메서드와 마찬가지로, blade 메서드는 Illuminate\Testing\TestView 인스턴스를 반환합니다.

$view = $this->blade(
    '<x-component :name="$name" />',
    ['name' => 'Taylor']
);

$view->assertSee('Taylor');

Blade 컴포넌트를 평가해 렌더링하려면 component 메서드를 사용할 수 있습니다. 이 메서드는 Illuminate\Testing\TestComponent 인스턴스를 반환합니다.

$view = $this->component(Profile::class, ['name' => 'Taylor']);

$view->assertSee('Taylor');

사용 가능한 Assertion 메서드

응답 관련 Assertion

라라벨의 Illuminate\Testing\TestResponse 클래스는 애플리케이션을 테스트할 때 활용할 수 있는 다양한 커스텀 assertion(검증) 메서드를 제공합니다. 이 assertion들은 json, get, post, put, delete 테스트 메서드로 반환된 응답에서 사용할 수 있습니다.

assertCookie assertCookieExpired assertCookieNotExpired assertCookieMissing assertCreated assertDontSee assertDontSeeText assertDownload assertExactJson assertForbidden assertHeader assertHeaderMissing assertJson assertJsonCount assertJsonFragment assertJsonIsArray assertJsonIsObject assertJsonMissing assertJsonMissingExact assertJsonMissingValidationErrors assertJsonPath assertJsonMissingPath assertJsonStructure assertJsonValidationErrors assertJsonValidationErrorFor assertLocation assertContent assertNoContent assertStreamedContent assertNotFound assertOk assertPlainCookie assertRedirect assertRedirectContains assertRedirectToRoute assertRedirectToSignedRoute assertSee assertSeeInOrder assertSeeText assertSeeTextInOrder assertSessionHas assertSessionHasInput assertSessionHasAll assertSessionHasErrors assertSessionHasErrorsIn assertSessionHasNoErrors assertSessionDoesntHaveErrors assertSessionMissing assertStatus assertSuccessful assertUnauthorized assertUnprocessable assertValid assertInvalid assertViewHas assertViewHasAll assertViewIs assertViewMissing

assertCookie

응답에 지정한 쿠키가 포함되어 있는지 확인합니다.

$response->assertCookie($cookieName, $value = null);

assertCookieExpired

응답에 지정한 쿠키가 포함되어 있으며, 해당 쿠키가 만료된 상태인지 확인합니다.

$response->assertCookieExpired($cookieName);

assertCookieNotExpired

응답에 지정한 쿠키가 포함되어 있고, 해당 쿠키가 만료되지 않은 상태인지 확인합니다.

$response->assertCookieNotExpired($cookieName);

assertCookieMissing

응답에 지정한 쿠키가 포함되어 있지 않은지 확인합니다.

$response->assertCookieMissing($cookieName);

assertCreated

응답이 201 HTTP 상태 코드를 가지는지 확인합니다.

$response->assertCreated();

assertDontSee

애플리케이션이 반환한 응답 내용에 지정한 문자열이 포함되어 있지 않은지 확인합니다. 두 번째 인자에 false를 전달하지 않는 한, 기본적으로 지정한 문자열이 자동으로 이스케이프 처리됩니다.

$response->assertDontSee($value, $escaped = true);

assertDontSeeText

응답 텍스트에 지정한 문자열이 포함되어 있지 않은지 확인합니다. 두 번째 인자에 false를 전달하지 않는 한, 기본적으로 지정한 문자열이 자동으로 이스케이프 처리됩니다. 이 메서드는 assert 시 PHP의 strip_tags 함수로 응답 내용을 처리한 후 비교를 수행합니다.

$response->assertDontSeeText($value, $escaped = true);

assertDownload

응답이 "다운로드" 타입인지를 확인합니다. 일반적으로 라우트가 반환한 응답이 Response::download, BinaryFileResponse, 혹은 Storage::download 형태인 경우입니다.

$response->assertDownload();

원한다면, 다운로드 파일에 지정한 파일명이 할당되었는지도 함께 확인할 수 있습니다.

$response->assertDownload('image.jpg');

assertExactJson

응답이 지정한 JSON 데이터와 정확히 일치하는지 확인합니다.

$response->assertExactJson(array $data);

assertForbidden

응답이 금지(403) HTTP 상태 코드를 가지는지 확인합니다.

$response->assertForbidden();

assertHeader

응답에 지정한 헤더와 값이 포함되어 있는지 확인합니다.

$response->assertHeader($headerName, $value = null);

assertHeaderMissing

응답에 지정한 헤더가 포함되어 있지 않은지 확인합니다.

$response->assertHeaderMissing($headerName);

assertJson

응답에 지정한 JSON 데이터가 포함되어 있는지 확인합니다.

$response->assertJson(array $data, $strict = false);

assertJson 메서드는 응답을 배열로 변환한 뒤, PHPUnit::assertArraySubset을 활용해 지정한 배열이 응답 JSON 내에 존재하는지 검증합니다. 즉, JSON 응답에 다른 속성이 있더라도, 지정한 데이터 일부만 존재한다면 이 테스트는 통과합니다.

assertJsonCount

지정한 key에 해당하는 응답 JSON 배열의 요소 개수가 기대한 값과 일치하는지 확인합니다.

$response->assertJsonCount($count, $key = null);

assertJsonFragment

응답 전체에서 지정한 JSON 데이터가 어느 곳에든 포함되어 있는지 확인합니다.

Route::get('/users', function () {
    return [
        'users' => [
            [
                'name' => 'Taylor Otwell',
            ],
        ],
    ];
});

$response->assertJsonFragment(['name' => 'Taylor Otwell']);

assertJsonIsArray

응답의 JSON이 배열인지 확인합니다.

$response->assertJsonIsArray();

assertJsonIsObject

응답의 JSON이 객체인지 확인합니다.

$response->assertJsonIsObject();

assertJsonMissing

응답에 지정한 JSON 데이터가 포함되어 있지 않은지 확인합니다.

$response->assertJsonMissing(array $data);

assertJsonMissingExact

응답에 지정한 JSON 데이터가 정확하게 일치하여 포함되어 있지 않은지 확인합니다.

$response->assertJsonMissingExact(array $data);

assertJsonMissingValidationErrors

응답에서 지정한 key들에 대한 JSON 유효성 검증 오류가 없는지 확인합니다.

$response->assertJsonMissingValidationErrors($keys);

[!NOTE] 보다 일반적인 assertValid 메서드를 사용하면, 응답에 JSON 형태로 반환된 검증 오류가 없고 세션 저장소에도 오류가 플래시되지 않았는지 함께 확인할 수 있습니다.

assertJsonPath

지정한 경로(path)에 해당하는 응답 데이터가 기대한 값과 일치하는지 확인합니다.

$response->assertJsonPath($path, $expectedValue);

예를 들어, 애플리케이션에서 다음과 같은 JSON 응답이 반환된다면:

{
    "user": {
        "name": "Steve Schoger"
    }
}

user 객체의 name 속성이 특정 값과 일치하는지 다음과 같이 검증할 수 있습니다.

$response->assertJsonPath('user.name', 'Steve Schoger');

assertJsonMissingPath

응답에 지정한 경로(path)가 존재하지 않는지 확인합니다.

$response->assertJsonMissingPath($path);

예를 들어, 애플리케이션에서 다음과 같은 JSON 응답이 반환된다면:

{
    "user": {
        "name": "Steve Schoger"
    }
}

user 객체의 email 속성이 없는지 다음과 같이 확인할 수 있습니다.

$response->assertJsonMissingPath('user.email');

assertJsonStructure

응답이 기대하는 구조의 JSON을 가지고 있는지 확인합니다.

$response->assertJsonStructure(array $structure);

예를 들어, 애플리케이션이 반환하는 JSON 응답이 다음 데이터를 담고 있다면:

{
    "user": {
        "name": "Steve Schoger"
    }
}

아래와 같이 JSON 구조가 기대에 부합하는지 검증할 수 있습니다.

$response->assertJsonStructure([
    'user' => [
        'name',
    ]
]);

때로는 애플리케이션에서 반환되는 JSON 응답에 여러 객체로 이루어진 배열이 포함될 수 있습니다.

{
    "user": [
        {
            "name": "Steve Schoger",
            "age": 55,
            "location": "Earth"
        },
        {
            "name": "Mary Schoger",
            "age": 60,
            "location": "Earth"
        }
    ]
}

이런 경우에는 * 문자를 사용해 배열 내 모든 객체의 구조를 검증할 수 있습니다.

$response->assertJsonStructure([
    'user' => [
        '*' => [
             'name',
             'age',
             'location'
        ]
    ]
]);

assertJsonValidationErrors

응답에서 지정한 key들에 대해 JSON 기반의 유효성 검증 오류가 존재하는지 확인합니다. 이 메서드는 유효성 검증 오류가 세션에 플래시되는 대신 JSON 구조로 반환되는 응답을 대상으로 합니다.

$response->assertJsonValidationErrors(array $data, $responseKey = 'errors');

[!NOTE] 보다 일반적인 assertInvalid 메서드는, 오류가 JSON으로 반환되든 세션 저장소로 플래시되든 검증 오류가 존재하는지를 확인할 수 있습니다.

assertJsonValidationErrorFor

응답에서 지정한 key에 대해 어떠한 JSON 검증 오류가 존재하는지 확인합니다.

$response->assertJsonValidationErrorFor(string $key, $responseKey = 'errors');

assertLocation

응답의 Location 헤더에 기대하는 URI 값이 있는지 확인합니다.

$response->assertLocation($uri);

assertContent

응답 내용이 지정한 문자열과 정확히 일치하는지 확인합니다.

$response->assertContent($value);

assertNoContent

응답이 지정한 HTTP 상태 코드와 함께 콘텐츠가 없는지 확인합니다.

$response->assertNoContent($status = 204);

assertStreamedContent

스트림 형식의 응답 내용이 지정한 문자열과 일치하는지 확인합니다.

$response->assertStreamedContent($value);

assertNotFound

응답이 찾을 수 없음(404) HTTP 상태 코드를 가지는지 확인합니다.

$response->assertNotFound();

assertOk

응답이 200 HTTP 상태 코드를 가지는지 확인합니다.

$response->assertOk();

assertPlainCookie

응답에 지정한 암호화되지 않은 쿠키가 포함되어 있는지 확인합니다.

$response->assertPlainCookie($cookieName, $value = null);

assertRedirect

응답이 지정한 URI로 리다이렉트되는지 확인합니다.

$response->assertRedirect($uri);

assertRedirectContains

응답이 지정한 문자열을 포함하는 URI로 리디렉션되는지 확인합니다.

$response->assertRedirectContains($string);

assertRedirectToRoute

응답이 네임드 라우트로 리디렉션되는지 확인합니다.

$response->assertRedirectToRoute($name = null, $parameters = []);

assertRedirectToSignedRoute

응답이 서명된 라우트로 리디렉션되는지 확인합니다.

$response->assertRedirectToSignedRoute($name = null, $parameters = []);

assertSee

응답에 지정한 문자열이 포함되어 있는지 확인합니다. 이 assert는 두 번째 인자로 false를 전달하지 않는 한, 지정한 문자열을 자동으로 이스케이프합니다.

$response->assertSee($value, $escaped = true);

assertSeeInOrder

응답에 여러 문자열이 순서대로 포함되어 있는지 확인합니다. 이 assert는 두 번째 인자로 false를 전달하지 않는 한, 지정한 문자열을 자동으로 이스케이프합니다.

$response->assertSeeInOrder(array $values, $escaped = true);

assertSeeText

응답 텍스트에 지정한 문자열이 포함되어 있는지 확인합니다. 이 assert는 두 번째 인자로 false를 전달하지 않는 한, 지정한 문자열을 자동으로 이스케이프합니다. assert를 수행하기 전, 응답 본문은 strip_tags PHP 함수로 HTML 태그가 제거됩니다.

$response->assertSeeText($value, $escaped = true);

assertSeeTextInOrder

응답 텍스트에 여러 문자열이 순서대로 포함되어 있는지 확인합니다. 이 assert는 두 번째 인자로 false를 전달하지 않는 한, 지정한 문자열을 자동으로 이스케이프합니다. 응답 본문은 assert 전에 strip_tags PHP 함수로 HTML 태그가 제거됩니다.

$response->assertSeeTextInOrder(array $values, $escaped = true);

assertSessionHas

세션에 지정한 데이터를 가지고 있는지 확인합니다.

$response->assertSessionHas($key, $value = null);

필요하다면, 콜백을 두 번째 인자로 전달하여 사용자가 원하는 검증 로직을 적용할 수도 있습니다. 콜백이 true를 반환하면 assert가 통과합니다.

$response->assertSessionHas($key, function ($value) {
    return $value->name === 'Taylor Otwell';
});

assertSessionHasInput

세션의 플래시 입력 배열에 특정 값이 포함되어 있는지 확인합니다.

$response->assertSessionHasInput($key, $value = null);

마찬가지로, 두 번째 인자에 콜백을 전달해 세부적인 검증을 수행할 수 있습니다. 콜백이 true를 반환하면 assert가 통과합니다.

$response->assertSessionHasInput($key, function ($value) {
    return Crypt::decryptString($value) === 'secret';
});

assertSessionHasAll

세션에 지정한 키/값 쌍 배열을 모두 가지고 있는지 확인합니다.

$response->assertSessionHasAll(array $data);

예를 들어, 애플리케이션의 세션에 name과 status 키가 들어 있다면, 아래와 같이 두 값이 모두 존재하고 각각의 값을 가지고 있는지 assert할 수 있습니다.

$response->assertSessionHasAll([
    'name' => 'Taylor Otwell',
    'status' => 'active',
]);

assertSessionHasErrors

세션에 지정한 $keys에 대한 에러가 있는지 확인합니다. $keys가 연관 배열(associative array)이면, 각 필드(키)에 대해 각각의 에러 메시지(값)가 포함되어 있는지 확인합니다. 이 메서드는 유효성 검증 오류가 JSON이 아닌, 세션에 플래시 데이터로 저장되는 라우트를 테스트할 때 사용하면 좋습니다.

$response->assertSessionHasErrors(
    array $keys, $format = null, $errorBag = 'default'
);

예를 들어, name과 email 필드에 유효성 검사 오류 메시지가 세션에 플래시되었는지 아래와 같이 검증할 수 있습니다.

$response->assertSessionHasErrors(['name', 'email']);

또는, 특정 필드에 특정 에러 메시지가 포함되어 있는지 검증할 수도 있습니다.

$response->assertSessionHasErrors([
    'name' => 'The given name was invalid.'
]);

[!NOTE] 더 범용적으로 사용할 수 있는 assertInvalid 메서드는 유효성 검증 오류가 JSON 형태로 반환되거나 세션에 플래시된 경우 모두를 검증할 수 있습니다.

assertSessionHasErrorsIn

지정한 에러 백 내부에 $keys에 대한 에러가 있는지 확인합니다. $keys가 연관 배열일 경우, 각 필드(키)에 대해 해당 에러 메시지(값)가 에러 백에 포함되어 있는지 검증합니다.

$response->assertSessionHasErrorsIn($errorBag, $keys = [], $format = null);

assertSessionHasNoErrors

세션에 유효성 검사 오류가 전혀 없는지 확인합니다.

$response->assertSessionHasNoErrors();

assertSessionDoesntHaveErrors

세션에 지정한 키들에 대한 유효성 검증 오류가 없는지 확인합니다.

$response->assertSessionDoesntHaveErrors($keys = [], $format = null, $errorBag = 'default');

[!NOTE] 더 범용적으로 사용할 수 있는 assertValid 메서드는 유효성 검사 오류가 JSON 형태로 반환되거나, 세션에 플래시된 경우 모두 해당 키에 대한 에러가 없는지 검증할 수 있습니다.

assertSessionMissing

세션에 지정한 키가 없는지 확인합니다.

$response->assertSessionMissing($key);

assertStatus

응답의 HTTP 상태 코드가 지정한 값과 일치하는지 확인합니다.

$response->assertStatus($code);

assertSuccessful

응답이 성공 상태(HTTP 코드 200 이상, 300 미만)인지 확인합니다.

$response->assertSuccessful();

assertUnauthorized

응답의 HTTP 상태 코드가 인증되지 않음(401) 코드인지 확인합니다.

$response->assertUnauthorized();

assertUnprocessable

응답의 HTTP 상태 코드가 처리할 수 없음(422) 코드인지 확인합니다.

$response->assertUnprocessable();

assertValid

응답에서 지정한 키에 대해 유효성 검사 오류가 전혀 없는지 확인합니다. 이 메서드는 유효성 검사 오류가 JSON 구조로 반환되었거나 세션에 플래시된 경우 모두에 사용할 수 있습니다.

// 유효성 검사 오류가 전혀 없는 경우...
$response->assertValid();

// 지정한 키에 대해 유효성 검사 오류가 없는 경우...
$response->assertValid(['name', 'email']);

assertInvalid

응답에서 지정한 키에 대해 유효성 검사 오류가 있는지 확인합니다. 이 메서드는 유효성 검사 오류가 JSON 구조로 반환되었거나 세션에 플래시된 경우 모두에 사용할 수 있습니다.

$response->assertInvalid(['name', 'email']);

특정 키가 특정 유효성 검사 에러 메시지를 가지고 있는지 assert할 수도 있습니다. 이때 전체 에러 메시지를 입력하거나, 메시지의 일부만 입력할 수도 있습니다.

$response->assertInvalid([
    'name' => 'The name field is required.',
    'email' => 'valid email address',
]);

assertViewHas

응답의 뷰에 특정 데이터가 포함되어 있는지 확인합니다.

$response->assertViewHas($key, $value = null);

두 번째 인자로 클로저를 전달하면, 뷰 데이터의 특정 값에 대해 세부적인 검증을 할 수 있습니다.

$response->assertViewHas('user', function (User $user) {
    return $user->name === 'Taylor';
});

또한, 응답의 뷰 데이터를 배열 변수처럼 바로 접근하여 확인할 수도 있습니다.

$this->assertEquals('Taylor', $response['name']);

assertViewHasAll

응답의 뷰에 여러 데이터를 동시에 가지고 있는지 확인합니다.

$response->assertViewHasAll(array $data);

다음과 같이 뷰가 지정한 키들을 가지고 있는지 확인하거나,

$response->assertViewHasAll([
    'name',
    'email',
]);

데이터가 존재할 뿐 아니라 특정 값을 가지고 있는지도 assert할 수 있습니다.

$response->assertViewHasAll([
    'name' => 'Taylor Otwell',
    'email' => '[email protected],',
]);

assertViewIs

지정한 뷰가 해당 라우트에서 반환되었는지 확인합니다.

$response->assertViewIs($value);

assertViewMissing

애플리케이션 응답의 뷰에 특정 데이터 키가 포함되지 않았는지 확인합니다.

$response->assertViewMissing($key);

인증 관련 Assertion

Laravel은 애플리케이션의 기능 테스트 내에서 사용할 수 있는 다양한 인증 관련 assertion 메서드도 제공합니다. 이 메서드들은 get이나 post로 반환되는 Illuminate\Testing\TestResponse 인스턴스가 아니라, 테스트 클래스 자체에서 호출해야 합니다.

assertAuthenticated

사용자가 인증되었는지 확인합니다.

$this->assertAuthenticated($guard = null);

assertGuest

사용자가 인증되지 않은 상태(게스트)인지 확인합니다.

$this->assertGuest($guard = null);

assertAuthenticatedAs

특정 사용자가 인증되었는지 확인합니다.

$this->assertAuthenticatedAs($user, $guard = null);

유효성 검증 Assertion

Laravel에서는 요청에 제공된 데이터가 유효 또는 무효인지 확인할 수 있는 두 가지 주요 유효성 검증 assertion을 제공합니다.

assertValid

응답에서 지정한 키에 대해 유효성 검증 오류가 없는지 확인합니다. 이 메서드는 유효성 오류가 JSON 구조로 반환되었거나 세션에 플래시된 경우 모두 사용할 수 있습니다.

// 유효성 검사 오류가 없는 경우...
$response->assertValid();

// 지정한 키에 대해 유효성 검사 오류가 없는 경우...
$response->assertValid(['name', 'email']);

assertInvalid

응답에서 지정한 키에 대해 유효성 검사 오류가 있는지 확인합니다. 이 메서드는 유효성 오류가 JSON 구조로 반환되었거나 세션에 플래시된 경우 모두 사용할 수 있습니다.

$response->assertInvalid(['name', 'email']);

또한, 특정 키가 특정 유효성 오류 메시지를 가지고 있는지, 전체 메시지나 일부 메시지를 기준으로 검증할 수도 있습니다.

$response->assertInvalid([
    'name' => 'The name field is required.',
    'email' => 'valid email address',
]);