HTTP Tests

• 簡介
• 發送請求
  • 自訂請求標頭
  • Cookies
  • Session / 認證
  • 除錯回應
  • 例外處理
• 測試 JSON API
  • 流暢 JSON 測試
• 測試檔案上傳
• 測試視圖
  • 渲染 Blade 和組件
• 快取路由
• 可用斷言
  • 回應斷言
  • 認證斷言
  • 驗證斷言

簡介 (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 狀態碼。除了這個簡單的斷言之外，Laravel 還包含各種斷言，用於檢查回應標頭、內容、JSON 結構等。

發送請求 (Making Requests)

要向應用程式發送請求，你可以在測試中呼叫 get、post、put、patch 或 delete 方法。這些方法實際上不會向你的應用程式發出「真正的」HTTP 請求。相反，整個網路請求是在內部模擬的。

測試請求方法回傳 Illuminate\Testing\TestResponse 的實例，而不是回傳 Illuminate\Http\Response 實例，該實例提供 各種有用的斷言，允許你檢查應用程式的回應：

<?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 中介軟體。

自訂請求標頭 (Customizing Request Headers)

你可以使用 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);
    }
}

Cookies

你可以使用 withCookie 或 withCookies 方法在發送請求之前設定 cookie 值。withCookie 方法接受 cookie 名稱和值作為其兩個參數，而 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('/');

        //
    }
}

Session / 認證 (Session / Authentication)

Laravel 提供了幾個 helper 來在 HTTP 測試期間與 session 互動。首先，你可以使用 withSession 方法將 session 資料設定為給定的陣列。這對於在向應用程式發送請求之前載入 session 資料非常有用：

<?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 的 session 通常用於維護當前認證使用者的狀態。因此，actingAs helper 方法提供了一種簡單的方法來將給定使用者認證為當前使用者。例如，我們可以使用 模型工廠 來生成和認證使用者：

<?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('/');

        //
    }
}

你還可以通過將 guard 名稱作為第二個參數傳遞給 actingAs 方法來指定應用於認證給定使用者的 guard。提供給 actingAs 方法的 guard 也將成為測試期間的預設 guard：

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

如果你想確保請求未經認證，可以使用 actingAsGuest 方法：

$this->actingAsGuest();

除錯回應 (Debugging Responses)

在向應用程式發送測試請求後，可以使用 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();
    }
}

例外處理 (Exception Handling)

有時你可能需要測試你的應用程式是否拋出了特定的異常。為了實現這一點，你可以通過 Exceptions facade「偽造」異常處理程序。一旦偽造了異常處理程序，你就可以利用 assertReported 和 assertNotReported 方法對請求期間拋出的異常進行斷言：

<?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 語言或你的應用程式使用的函式庫已棄用的功能，你可以在發送請求之前呼叫 withoutDeprecationHandling 方法。當禁用棄用處理時，棄用警告將轉換為異常，從而導致你的測試失敗：

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

assertThrows 方法可用於斷言給定閉包中的程式碼拋出指定類型的異常：

$this->assertThrows(
    fn () => (new ProcessOrder)->execute(),
    OrderInvalid::class
);

如果你想檢查並對拋出的異常進行斷言，你可以提供一個閉包作為 assertThrows 方法的第二個參數：

$this->assertThrows(
    fn () => (new ProcessOrder)->execute(),
    fn (OrderInvalid $e) => $e->orderId() === 123;
);

assertDoesntThrow 方法可用於斷言給定閉包中的程式碼不拋出任何異常：

$this->assertDoesntThrow(fn () => (new ProcessOrder)->execute());

測試 JSON API (Testing JSON APIs)

Laravel 還提供了幾個 helper 來測試 JSON API 及其回應。例如，json、getJson、postJson、putJson、patchJson、deleteJson 和 optionsJson 方法可用於發送帶有各種 HTTP 動詞的 JSON 請求。你還可以輕鬆地將資料和標頭傳遞給這些方法。首先，讓我們編寫一個測試來向 /api/user 發送 POST 請求，並斷言回傳了預期的 JSON 資料：

<?php

test('making an api request', function () {
    $response = $this->postJson('/api/user', ['name' => 'Sally']);

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

<?php

namespace Tests\Feature;

use Tests\TestCase;

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

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

此外，可以作為回應上的陣列變數存取 JSON 回應資料，這使得檢查 JSON 回應中回傳的單個值變得很方便：

expect($response['created'])->toBeTrue();

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

[!NOTE] > assertJson 方法將回應轉換為陣列，以驗證給定陣列是否存在於應用程式回傳的 JSON 回應中。因此，如果 JSON 回應中有其他屬性，只要給定片段存在，此測試仍將通過。

斷言完全 JSON 匹配 (Asserting Exact JSON Matches)

如前所述，assertJson 方法可用於斷言 JSON 片段是否存在於 JSON 回應中。如果你想驗證給定陣列是否 完全匹配 應用程式回傳的 JSON，你應該使用 assertExactJson 方法：

<?php

test('asserting an exact json match', function () {
    $response = $this->postJson('/user', ['name' => 'Sally']);

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

<?php

namespace Tests\Feature;

use Tests\TestCase;

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

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

斷言 JSON 路徑 (Asserting on JSON Paths)

如果你想驗證 JSON 回應是否在指定路徑包含給定資料，你應該使用 assertJsonPath 方法：

<?php

test('asserting a json path value', function () {
    $response = $this->postJson('/user', ['name' => 'Sally']);

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

<?php

namespace Tests\Feature;

use Tests\TestCase;

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

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

assertJsonPath 方法也接受一個閉包，可用於動態確定斷言是否應該通過：

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

流暢 JSON 測試 (Fluent JSON Testing)

Laravel 還提供了一種漂亮的方式來流暢地測試你的應用程式的 JSON 回應。首先，將閉包傳遞給 assertJson 方法。此閉包將使用 Illuminate\Testing\Fluent\AssertableJson 的實例呼叫，該實例可用於對應用程式回傳的 JSON 進行斷言。where 方法可用於對 JSON 的特定屬性進行斷言，而 missing 方法可用於斷言 JSON 中缺少特定屬性：

use Illuminate\Testing\Fluent\AssertableJson;

test('fluent json', function () {
    $response = $this->getJson('/users/1');

    $response
        ->assertJson(fn (AssertableJson $json) =>
            $json->where('id', 1)
                ->where('name', 'Victoria Faith')
                ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                ->whereNot('status', 'pending')
                ->missing('password')
                ->etc()
        );
});

use Illuminate\Testing\Fluent\AssertableJson;

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

    $response
        ->assertJson(fn (AssertableJson $json) =>
            $json->where('id', 1)
                ->where('name', 'Victoria Faith')
                ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                ->whereNot('status', 'pending')
                ->missing('password')
                ->etc()
        );
}

理解 etc 方法 (Understanding the etc Method)

在上面的範例中，你可能已經注意到我們在斷言鏈的末尾呼叫了 etc 方法。此方法通知 Laravel JSON 物件上可能存在其他屬性。如果不使用 etc 方法，如果 JSON 物件上存在你沒有進行斷言的其他屬性，測試將失敗。

此行為背後的意圖是通過強制你顯式對屬性進行斷言或通過 etc 方法顯式允許其他屬性，來保護你免受無意中在 JSON 回應中暴露敏感資訊的影響。

但是，你應該注意，在斷言鏈中不包含 etc 方法並不能確保不會將其他屬性新增到嵌套在 JSON 物件中的陣列中。etc 方法僅確保在呼叫 etc 方法的嵌套級別上不存在其他屬性。

斷言屬性存在 / 缺失 (Asserting Attribute Presence / Absence)

要斷言屬性存在或缺失，你可以使用 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 集合進行斷言 (Asserting Against JSON Collections)

通常，你的路由將回傳包含多個項目的 JSON 回應，例如多個使用者：

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

在這些情況下，我們可以使用流暢 JSON 物件的 has 方法對回應中包含的使用者進行斷言。例如，讓我們斷言 JSON 回應包含三個使用者。接下來，我們將使用 first 方法對集合中的第一個使用者進行一些斷言。first 方法接受一個閉包，該閉包接收另一個可斷言的 JSON 字串，我們可以使用它來對 JSON 集合中的第一個物件進行斷言：

$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has(3)
            ->first(fn (AssertableJson $json) =>
                $json->where('id', 1)
                    ->where('name', 'Victoria Faith')
                    ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                    ->missing('password')
                    ->etc()
            )
    );

範圍 JSON 集合斷言 (Scoping JSON Collection Assertions)

有時，你的應用程式的路由將回傳分配了命名鍵的 JSON 集合：

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

在測試這些路由時，你可以使用 has 方法來斷言集合中的項目數量。此外，你可以使用 has 方法來限定斷言鏈的範圍：

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

但是，你可以進行單個呼叫，提供閉包作為其第三個參數，而不是對 has 方法進行兩次單獨的呼叫來對 users 集合進行斷言。這樣做時，閉包將自動被呼叫並限定為集合中的第一個項目：

$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has('meta')
            ->has('users', 3, fn (AssertableJson $json) =>
                $json->where('id', 1)
                    ->where('name', 'Victoria Faith')
                    ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                    ->missing('password')
                    ->etc()
            )
    );

斷言 JSON 類型 (Asserting JSON Types)

你可能只想斷言 JSON 回應中的屬性是某種類型。Illuminate\Testing\Fluent\AssertableJson 類別提供了 whereType 和 whereAllType 方法來實現這一點：

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

你可以使用 | 字元指定多種類型，或將類型陣列作為第二個參數傳遞給 whereType 方法。如果回應值是列出的任何類型，斷言將成功：

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

whereType 和 whereAllType 方法識別以下類型：string、integer、double、boolean、array 和 null。

測試檔案上傳 (Testing File Uploads)

Illuminate\Http\UploadedFile 類別提供了一個 fake 方法，可用於生成用於測試的虛擬檔案或圖片。這與 Storage facade 的 fake 方法相結合，大大簡化了檔案上傳的測試。例如，你可以結合這兩個功能來輕鬆測試頭像上傳表單：

<?php

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;

test('avatars can be uploaded', function () {
    Storage::fake('avatars');

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

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

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

<?php

namespace Tests\Feature;

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;
use Tests\TestCase;

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

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

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

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

如果你想斷言給定檔案不存在，可以使用 Storage facade 提供的 assertMissing 方法：

Storage::fake('avatars');

// ...

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

虛擬檔案自訂 (Fake File Customization)

在使用 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'
);

測試視圖 (Testing Views)

Laravel 還允許你在不向應用程式發出模擬 HTTP 請求的情況下渲染視圖。為了實現這一點，你可以在測試中呼叫 view 方法。view 方法接受視圖名稱和可選的資料陣列。該方法回傳 Illuminate\Testing\TestView 的實例，該實例提供了幾種方法來方便地對視圖內容進行斷言：

<?php

test('a welcome view can be rendered', function () {
    $view = $this->view('welcome', ['name' => 'Taylor']);

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

<?php

namespace Tests\Feature;

use Tests\TestCase;

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

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

TestView 類別提供以下斷言方法：assertSee、assertSeeInOrder、assertSeeText、assertSeeTextInOrder、assertDontSee 和 assertDontSeeText。

如果需要，你可以通過將 TestView 實例轉換為字串來獲取原始的渲染視圖內容：

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

共用錯誤 (Sharing Errors)

某些視圖可能依賴於 Laravel 提供的全域錯誤包 中共用的錯誤。要使用錯誤訊息填充錯誤包，你可以使用 withViewErrors 方法：

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

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

渲染 Blade 和組件 (Rendering Blade and Components)

如果需要，你可以使用 blade 方法來評估和渲染原始 Blade 字串。與 view 方法一樣，blade 方法回傳 Illuminate\Testing\TestView 的實例：

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

$view->assertSee('Taylor');

你可以使用 component 方法來評估和渲染 Blade 組件。component 方法回傳 Illuminate\Testing\TestComponent 的實例：

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

$view->assertSee('Taylor');

快取路由 (Caching Routes)

在測試執行之前，Laravel 會啟動應用程式的新實例，包括收集所有定義的路由。如果你的應用程式有許多路由檔案，你可能希望將 Illuminate\Foundation\Testing\WithCachedRoutes trait 新增到你的測試案例中。在使用此 trait 的測試中，路由將被構建一次並儲存在記憶體中，這意味著路由收集過程僅對套件中的所有測試執行一次：

<?php

use App\Http\Controllers\UserController;
use Illuminate\Foundation\Testing\WithCachedRoutes;

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

test('basic example', function () {
    $this->get(action([UserController::class, 'index']));

    // ...
});

<?php

namespace Tests\Feature;

use App\Http\Controllers\UserController;
use Illuminate\Foundation\Testing\WithCachedRoutes;
use Tests\TestCase;

class BasicTest extends TestCase
{
    use WithCachedRoutes;

    /**
     * A basic functional test example.
     */
    public function test_basic_example(): void
    {
        $response = $this->get(action([UserController::class, 'index']));

        // ...
    }
}

可用斷言 (Available Assertions)

回應斷言 (Response Assertions)

Laravel 的 Illuminate\Testing\TestResponse 類別提供了各種自訂斷言方法，你可以在測試應用程式時使用這些方法。這些斷言可以在 json、get、post、put 和 delete 測試方法回傳的回應上存取：

assertAccepted

斷言回應具有已接受 (202) HTTP 狀態碼：

$response->assertAccepted();

assertBadRequest

斷言回應具有錯誤請求 (400) HTTP 狀態碼：

$response->assertBadRequest();

assertClientError

斷言回應具有客戶端錯誤 (>= 400, < 500) HTTP 狀態碼：

$response->assertClientError();

assertConflict

斷言回應具有衝突 (409) HTTP 狀態碼：

$response->assertConflict();

assertCookie

斷言回應包含給定的 cookie：

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

assertCookieExpired

斷言回應包含給定的 cookie 且已過期：

$response->assertCookieExpired($cookieName);

assertCookieNotExpired

斷言回應包含給定的 cookie 且未過期：

$response->assertCookieNotExpired($cookieName);

assertCookieMissing

斷言回應不包含給定的 cookie：

$response->assertCookieMissing($cookieName);

assertCreated

斷言回應具有 201 HTTP 狀態碼：

$response->assertCreated();

assertDontSee

斷言應用程式回傳的回應中不包含給定的字串。除非你傳遞第二個參數 false，否則此斷言將自動轉義給定的字串：

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

assertDontSeeText

斷言回應文字中不包含給定的字串。除非你傳遞第二個參數 false，否則此斷言將自動轉義給定的字串。此方法將在進行斷言之前將回應內容傳遞給 strip_tags PHP 函數：

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

assertDownload

斷言回應是「下載」。通常，這意味著回傳回應的被呼叫路由回傳了 Response::download 回應、BinaryFileResponse 或 Storage::download 回應：

$response->assertDownload();

如果你願意，你可以斷言下載的檔案被分配了給定的檔案名稱：

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

assertExactJson

斷言回應包含與給定 JSON 資料完全匹配的內容：

$response->assertExactJson(array $data);

assertExactJsonStructure

斷言回應包含與給定 JSON 結構完全匹配的內容：

$response->assertExactJsonStructure(array $data);

此方法是 assertJsonStructure 的更嚴格變體。與 assertJsonStructure 相反，如果回應包含未明確包含在預期 JSON 結構中的任何鍵，此方法將失敗。

assertForbidden

斷言回應具有禁止 (403) HTTP 狀態碼：

$response->assertForbidden();

assertFound

斷言回應具有已找到 (302) HTTP 狀態碼：

$response->assertFound();

assertGone

斷言回應具有已消失 (410) HTTP 狀態碼：

$response->assertGone();

assertHeader

斷言回應中存在給定的標頭和值：

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

assertHeaderMissing

斷言回應中不存在給定的標頭：

$response->assertHeaderMissing($headerName);

assertInternalServerError

斷言回應具有「內部伺服器錯誤」(500) HTTP 狀態碼：

$response->assertInternalServerError();

assertJson

斷言回應包含給定的 JSON 資料：

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

assertJson 方法將回應轉換為陣列，以驗證給定陣列是否存在於應用程式回傳的 JSON 回應中。因此，如果 JSON 回應中有其他屬性，只要給定片段存在，此測試仍將通過。

assertJsonCount

斷言回應 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

斷言回應對於給定的鍵沒有 JSON 驗證錯誤：

$response->assertJsonMissingValidationErrors($keys);

[!NOTE] 可以使用更通用的 assertValid 方法來斷言回應沒有作為 JSON 回傳的驗證錯誤 並且 沒有錯誤被快閃到 session 儲存中。

assertJsonPath

斷言回應在指定路徑包含給定資料：

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

例如，如果你的應用程式回傳以下 JSON 回應：

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

你可以像這樣斷言 user 物件的 name 屬性與給定值匹配：

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

assertJsonMissingPath

斷言回應不包含給定路徑：

$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

斷言回應對於給定的鍵具有給定的 JSON 驗證錯誤。當斷言驗證錯誤作為 JSON 結構回傳而不是快閃到 session 時，應使用此方法：

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

[!NOTE] 可以使用更通用的 assertInvalid 方法來斷言回應具有作為 JSON 回傳的驗證錯誤 或 錯誤被快閃到 session 儲存中。

assertJsonValidationErrorFor

斷言回應對於給定的鍵具有任何 JSON 驗證錯誤：

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

assertMethodNotAllowed

斷言回應具有方法不允許 (405) HTTP 狀態碼：

$response->assertMethodNotAllowed();

assertMovedPermanently

斷言回應具有永久移動 (301) HTTP 狀態碼：

$response->assertMovedPermanently();

assertLocation

斷言回應在 Location 標頭中具有給定的 URI 值：

$response->assertLocation($uri);

assertContent

斷言給定字串與回應內容匹配：

$response->assertContent($value);

assertNoContent

斷言回應具有給定的 HTTP 狀態碼且沒有內容：

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

assertStreamed

斷言回應是串流回應：

$response->assertStreamed();

assertStreamedContent

斷言給定字串與串流回應內容匹配：

$response->assertStreamedContent($value);

assertNotFound

斷言回應具有未找到 (404) HTTP 狀態碼：

$response->assertNotFound();

assertOk

斷言回應具有 200 HTTP 狀態碼：

$response->assertOk();

assertPaymentRequired

斷言回應具有需要付款 (402) HTTP 狀態碼：

$response->assertPaymentRequired();

assertPlainCookie

斷言回應包含給定的未加密 cookie：

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

assertRedirect

斷言回應是重定向到給定 URI：

$response->assertRedirect($uri = null);

assertRedirectBack

斷言回應是否重定向回上一頁：

$response->assertRedirectBack();

assertRedirectBackWithErrors

斷言回應是否重定向回上一頁並且 session 具有給定錯誤：

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

assertRedirectBackWithoutErrors

斷言回應是否重定向回上一頁並且 session 不包含任何錯誤訊息：

$response->assertRedirectBackWithoutErrors();

assertRedirectContains

斷言回應是否重定向到包含給定字串的 URI：

$response->assertRedirectContains($string);

assertRedirectToRoute

斷言回應是重定向到給定的 命名路由：

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

assertRedirectToSignedRoute

斷言回應是重定向到給定的 簽名路由：

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

assertRequestTimeout

斷言回應具有請求超時 (408) HTTP 狀態碼：

$response->assertRequestTimeout();

assertSee

斷言回應中包含給定的字串。除非你傳遞第二個參數 false，否則此斷言將自動轉義給定的字串：

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

assertSeeInOrder

斷言回應中按順序包含給定的字串。除非你傳遞第二個參數 false，否則此斷言將自動轉義給定的字串：

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

assertSeeText

斷言回應文字中包含給定的字串。除非你傳遞第二個參數 false，否則此斷言將自動轉義給定的字串。在進行斷言之前，回應內容將傳遞給 strip_tags PHP 函數：

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

assertSeeTextInOrder

斷言回應文字中按順序包含給定的字串。除非你傳遞第二個參數 false，否則此斷言將自動轉義給定的字串。在進行斷言之前，回應內容將傳遞給 strip_tags PHP 函數：

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

assertServerError

斷言回應具有伺服器錯誤 (>= 500 , < 600) HTTP 狀態碼：

$response->assertServerError();

assertServiceUnavailable

斷言回應具有「服務不可用」(503) HTTP 狀態碼：

$response->assertServiceUnavailable();

assertSessionHas

斷言 session 包含給定的資料：

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

如果需要，可以將閉包作為第二個參數傳遞給 assertSessionHas 方法。如果閉包回傳 true，則斷言將通過：

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

assertSessionHasInput

斷言 session 在 快閃輸入陣列 中具有給定值：

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

如果需要，可以將閉包作為第二個參數傳遞給 assertSessionHasInput 方法。如果閉包回傳 true，則斷言將通過：

use Illuminate\Support\Facades\Crypt;

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

assertSessionHasAll

斷言 session 包含給定的鍵 / 值對陣列：

$response->assertSessionHasAll(array $data);

例如，如果你的應用程式的 session 包含 name 和 status 鍵，你可以像這樣斷言兩者都存在並具有指定的值：

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

assertSessionHasErrors

斷言 session 包含給定 $keys 的錯誤。如果 $keys 是關聯陣列，則斷言 session 包含每個欄位（鍵）的特定錯誤訊息（值）。當測試將驗證錯誤快閃到 session 而不是作為 JSON 結構回傳的路由時，應使用此方法：

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

例如，要斷言 name 和 email 欄位具有快閃到 session 的驗證錯誤訊息，你可以像這樣呼叫 assertSessionHasErrors 方法：

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

或者，你可以斷言給定欄位具有特定的驗證錯誤訊息：

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

[!NOTE] 可以使用更通用的 assertInvalid 方法來斷言回應具有作為 JSON 回傳的驗證錯誤 或 錯誤被快閃到 session 儲存中。

assertSessionHasErrorsIn

斷言 session 在特定的 錯誤包 中包含給定 $keys 的錯誤。如果 $keys 是關聯陣列，則斷言 session 在錯誤包中包含每個欄位（鍵）的特定錯誤訊息（值）：

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

assertSessionHasNoErrors

斷言 session 沒有驗證錯誤：

$response->assertSessionHasNoErrors();

assertSessionDoesntHaveErrors

斷言 session 對於給定的鍵沒有驗證錯誤：

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

[!NOTE] 可以使用更通用的 assertValid 方法來斷言回應沒有作為 JSON 回傳的驗證錯誤 並且 沒有錯誤被快閃到 session 儲存中。

assertSessionMissing

斷言 session 不包含給定的鍵：

$response->assertSessionMissing($key);

assertStatus

斷言回應具有給定的 HTTP 狀態碼：

$response->assertStatus($code);

assertSuccessful

斷言回應具有成功 (>= 200 和 < 300) HTTP 狀態碼：

$response->assertSuccessful();

assertTooManyRequests

斷言回應具有請求過多 (429) HTTP 狀態碼：

$response->assertTooManyRequests();

assertUnauthorized

斷言回應具有未授權 (401) HTTP 狀態碼：

$response->assertUnauthorized();

assertUnprocessable

斷言回應具有無法處理的實體 (422) HTTP 狀態碼：

$response->assertUnprocessable();

assertUnsupportedMediaType

斷言回應具有不支援的媒體類型 (415) HTTP 狀態碼：

$response->assertUnsupportedMediaType();

assertValid

斷言回應對於給定的鍵沒有驗證錯誤。此方法可用於對驗證錯誤作為 JSON 結構回傳或驗證錯誤已快閃到 session 的回應進行斷言：

// Assert that no validation errors are present...
$response->assertValid();

// Assert that the given keys do not have validation errors...
$response->assertValid(['name', 'email']);

assertInvalid

斷言回應對於給定的鍵具有驗證錯誤。此方法可用於對驗證錯誤作為 JSON 結構回傳或驗證錯誤已快閃到 session 的回應進行斷言：

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

你還可以斷言給定鍵具有特定的驗證錯誤訊息。這樣做時，你可以提供整個訊息或僅提供訊息的一小部分：

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

如果你想斷言給定欄位是唯一具有驗證錯誤的欄位，你可以使用 assertOnlyInvalid 方法：

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

assertViewHas

斷言回應視圖包含給定的資料：

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

將閉包作為第二個參數傳遞給 assertViewHas 方法將允許你檢查並對特定視圖資料進行斷言：

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

此外，可以作為回應上的陣列變數存取視圖資料，從而允許你方便地檢查它：

expect($response['name'])->toBe('Taylor');

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

assertViewHasAll

斷言回應視圖具有給定的資料列表：

$response->assertViewHasAll(array $data);

此方法可用於斷言視圖僅包含與給定鍵匹配的資料：

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

或者，你可以斷言視圖資料存在並具有特定值：

$response->assertViewHasAll([
    'name' => 'Taylor Otwell',
    'email' => 'taylor@example.com,',
]);

assertViewIs

斷言路由回傳了給定的視圖：

$response->assertViewIs($value);

assertViewMissing

斷言應用程式回應中回傳的視圖不可用給定的資料鍵：

$response->assertViewMissing($key);

認證斷言 (Authentication Assertions)

Laravel 還提供了各種與認證相關的斷言，你可以在應用程式的功能測試中使用這些斷言。請注意，這些方法是在測試類別本身上呼叫的，而不是在 get 和 post 等方法回傳的 Illuminate\Testing\TestResponse 實例上呼叫的。

assertAuthenticated

斷言使用者已認證：

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

assertGuest

斷言使用者未認證：

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

assertAuthenticatedAs

斷言特定使用者已認證：

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

驗證斷言 (Validation Assertions)

Laravel 提供了兩個主要的驗證相關斷言，你可以使用它們來確保請求中提供的資料有效或無效。

assertValid

斷言回應對於給定的鍵沒有驗證錯誤。此方法可用於對驗證錯誤作為 JSON 結構回傳或驗證錯誤已快閃到 session 的回應進行斷言：

// Assert that no validation errors are present...
$response->assertValid();

// Assert that the given keys do not have validation errors...
$response->assertValid(['name', 'email']);

assertInvalid

斷言回應對於給定的鍵具有驗證錯誤。此方法可用於對驗證錯誤作為 JSON 結構回傳或驗證錯誤已快閃到 session 的回應進行斷言：

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

你還可以斷言給定鍵具有特定的驗證錯誤訊息。這樣做時，你可以提供整個訊息或僅提供訊息的一小部分：

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