Laradoc

Appearance

HTTP 測試 ​

簡介 ​

Laravel 提供了非常流暢的 API，用於向您的應用程式發出 HTTP 請求並檢查回應。例如，請查看下方定義的功能測試：

php
<?php

test('the application returns a successful response', function () {
    $response = $this->get('/');

    $response->assertStatus(200);
});
php
<?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 結構等等。

發出請求 ​

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

測試請求方法不會回傳 Illuminate\Http\Response 實例，而是回傳 Illuminate\Testing\TestResponse 實例，它提供了多種有用的斷言，讓您可以檢查應用程式的回應：

php
<?php

test('basic request', function () {
    $response = $this->get('/');

    $response->assertStatus(200);
});
php
<?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);
    }
}

一般來說，您的每個測試都應該只向應用程式發出一個請求。如果在單個測試方法中執行多個請求，可能會發生意外行為。

📌 備註

為了方便，在執行測試時，CSRF 中介層會自動被禁用。

自訂請求標頭 ​

您可以使用 withHeaders 方法在請求發送至應用程式之前自訂其標頭。此方法允許您向請求中添加任何您想要的自訂標頭：

php
<?php

test('interacting with headers', function () {
    $response = $this->withHeaders([
        'X-Header' => 'Value',
    ])->post('/user', ['name' => 'Sally']);

    $response->assertStatus(201);
});
php
<?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
<?php

test('interacting with cookies', function () {
    $response = $this->withCookie('color', 'blue')->get('/');

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

    //
});
php
<?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 / 認證 ​

Laravel 提供了多個輔助方法，用於在 HTTP 測試期間與 Session 互動。首先，您可以使用 withSession 方法將 Session 資料設定為給定的陣列。這對於在向應用程式發出請求之前將資料載入到 Session 中非常有用：

php
<?php

test('interacting with the session', function () {
    $response = $this->withSession(['banned' => false])->get('/');

    //
});
php
<?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 輔助方法提供了一種簡單的方式來將指定使用者認證為目前使用者。例如，我們可以使用模型工廠來生成並認證使用者：

php
<?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
<?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')

除錯回應 ​

向您的應用程式發出測試請求後，可以使用 dump、dumpHeaders 和 dumpSession 方法來檢查和除錯回應內容：

php
<?php

test('basic test', function () {
    $response = $this->get('/');

    $response->dumpHeaders();

    $response->dumpSession();

    $response->dump();
});
php
<?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->dumpHeaders();

        $response->dumpSession();

        $response->dump();
    }
}

或者，您可以使用 dd、ddHeaders、ddSession 和 ddJson 方法來傾印回應相關資訊，然後停止執行：

php
<?php

test('basic test', function () {
    $response = $this->get('/');

    $response->ddHeaders();
    $response->ddSession();
    $response->ddJson();
    $response->dd();
});
php
<?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->ddHeaders();

        $response->ddSession();

        $response->dd();
    }
}

異常處理 ​

有時候您可能需要測試應用程式是否拋出特定異常。要實現此目的，您可以透過 Exceptions facade 「模擬」異常處理器。一旦異常處理器被模擬，您可以使用 assertReported 和 assertNotReported 方法對請求期間拋出的異常進行斷言：

php
<?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
<?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 方法可用於斷言在請求期間沒有拋出給定異常或根本沒有拋出任何異常：

php
Exceptions::assertNotReported(InvalidOrderException::class);

Exceptions::assertNothingReported();

您可以在發出請求之前，呼叫 withoutExceptionHandling 方法，完全停用給定請求的異常處理：

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

此外，如果您想確保您的應用程式沒有利用 PHP 語言或應用程式所使用的函式庫已棄用的功能，您可以在發出請求之前呼叫 withoutDeprecationHandling 方法。當棄用處理被停用時，棄用警告將被轉換為異常，從而導致您的測試失敗：

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

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

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

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

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

測試 JSON API ​

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

php
<?php

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

    $response
        ->assertStatus(201)
        ->assertJson([
            'created' => true,
        ]);
});
php
<?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 回應中回傳的個別值：

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

📌 備註

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

斷言精確的 JSON 匹配 ​

如前所述，assertJson 方法可用於斷言 JSON 回應中存在一個 JSON 片段。如果您想驗證給定的陣列與您的應用程式回傳的 JSON 精確匹配，您應該使用 assertExactJson 方法：

php
<?php

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

    $response
        ->assertStatus(201)
        ->assertExactJson([
            'created' => true,
        ]);
});
php
<?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 路徑 ​

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

php
<?php

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

    $response
        ->assertStatus(201)
        ->assertJsonPath('team.owner.name', 'Darian');
});
php
<?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 測試 ​

Laravel 也提供了一種優雅的方式來流暢地測試您的應用程式的 JSON 回應。要開始使用，請將一個閉包傳遞給 assertJson 方法。此閉包將會被一個 Illuminate\Testing\Fluent\AssertableJson 實例調用，該實例可用於對應用程式返回的 JSON 進行斷言。where 方法可用於對 JSON 的特定屬性進行斷言，而 missing 方法可用於斷言 JSON 中缺少特定屬性：

php
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('[email protected]'))
                ->whereNot('status', 'pending')
                ->missing('password')
                ->etc()
        );
});
php
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('[email protected]'))
                ->whereNot('status', 'pending')
                ->missing('password')
                ->etc()
        );
}

理解 etc 方法 ​

在上述範例中，您可能已經注意到我們在斷言鏈的末尾調用了 etc 方法。此方法會告知 Laravel JSON 物件上可能存在其他屬性。如果沒有使用 etc 方法，當 JSON 物件上存在您未進行斷言的其他屬性時，測試將會失敗。

這種行為的目的是為了保護您，避免在 JSON 回應中無意間暴露敏感資訊，它會強制您要麼明確地對該屬性進行斷言，要麼透過 etc 方法明確允許額外屬性。

然而，您應該注意，在斷言鏈中不包含 etc 方法，並不能確保額外屬性不會被添加到您的 JSON 物件中嵌套的陣列中。etc 方法只確保在調用 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 集合 ​

通常，您的路由會返回一個包含多個項目 (例如多個 users) 的 JSON 回應：

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

在這些情況下，我們可以使用流暢的 JSON 物件的 has 方法來對回應中包含的 users 進行斷言。舉例來說，讓我們斷言 JSON 回應包含三個 users。接下來，我們將使用 first 方法對集合中的第一個 user 進行斷言。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('[email protected]'))
                    ->missing('password')
                    ->etc()
            )
    );

範圍化 JSON 集合斷言 ​

有時，您的應用程式路由會返回被賦予具名鍵的 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('[email protected]'))
                    ->missing('password')
                    ->etc()
            )
    );

然而，與其對 users 集合進行兩次單獨的 has 方法呼叫來進行斷言，您可以只進行一次呼叫，並提供一個閉包作為其第三個參數。這樣做時，該閉包將會自動被調用並將範圍設定為集合中的第一個項目：

$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('[email protected]'))
                    ->missing('password')
                    ->etc()
            )
    );

斷言 JSON 類型 ​

您可能只想斷言 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。

測試檔案上傳 ​

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

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

假檔案自訂義 ​

在使用 UploadedFile 類別提供的 fake 方法創建檔案時，您可以指定圖片的寬度、高度和大小 (以 Kilobytes 為單位)，以便更好地測試應用程式的驗證規則：

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'
);

測試視圖 ​

Laravel 也允許您在無需發出模擬 HTTP 請求到應用程式的情況下渲染視圖。若要實現此目的，您可以在測試中呼叫 view 方法。view 方法接受視圖名稱和可選的資料陣列。該方法會回傳一個 Illuminate\Testing\TestView 實例，它提供了多種方法以方便地對視圖內容進行斷言：

php
<?php

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

    $view->assertSee('Taylor');
});
php
<?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');

共享錯誤 ​

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

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

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

渲染 Blade 與 Components ​

如果有必要，您可以使用 blade 方法來評估並渲染原始的 Blade 字串。與 view 方法一樣，blade 方法也會回傳一個 Illuminate\Testing\TestView 實例：

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

$view->assertSee('Taylor');

您可以使用 component 方法來評估並渲染一個 Blade component。component 方法會回傳一個 Illuminate\Testing\TestComponent 實例：

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

$view->assertSee('Taylor');

可用斷言 ​

回應斷言 ​

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

assertAcceptedassertBadRequestassertConflictassertCookieassertCookieExpiredassertCookieNotExpiredassertCookieMissingassertCreatedassertDontSeeassertDontSeeTextassertDownloadassertExactJsonassertExactJsonStructureassertForbiddenassertFoundassertGoneassertHeaderassertHeaderMissingassertInternalServerErrorassertJsonassertJsonCountassertJsonFragmentassertJsonIsArrayassertJsonIsObjectassertJsonMissingassertJsonMissingExactassertJsonMissingValidationErrorsassertJsonPathassertJsonMissingPathassertJsonStructureassertJsonValidationErrorsassertJsonValidationErrorForassertLocationassertMethodNotAllowedassertMovedPermanentlyassertContentassertNoContentassertStreamedassertStreamedContentassertNotFoundassertOkassertPaymentRequiredassertPlainCookieassertRedirectassertRedirectContainsassertRedirectToRouteassertRedirectToSignedRouteassertRequestTimeoutassertSeeassertSeeInOrderassertSeeTextassertSeeTextInOrderassertServerErrorassertServiceUnavailableassertSessionHasassertSessionHasInputassertSessionHasAllassertSessionHasErrorsassertSessionHasErrorsInassertSessionHasNoErrorsassertSessionDoesntHaveErrorsassertSessionMissingassertStatusassertSuccessfulassertTooManyRequestsassertUnauthorizedassertUnprocessableassertUnsupportedMediaTypeassertValidassertInvalidassertViewHasassertViewHasAllassertViewIsassertViewMissing

assertBadRequest ​

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

$response->assertBadRequest();

assertAccepted ​

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

$response->assertAccepted();

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, $escaped = true);

assertDontSeeText ​

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

$response->assertDontSeeText($value, $escaped = 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);

📌 備註

更通用的 assertValid 方法可用於斷言回應沒有以 JSON 形式回傳的驗證錯誤 並且 沒有快閃到 Session 儲存的錯誤。

assertJsonPath ​

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

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

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

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

您可以斷言 user 物件的 name 屬性與給定值匹配，如下所示：

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

assertJsonMissingPath ​

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

$response->assertJsonMissingPath($path);

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

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

您可以斷言它不包含 user 物件的 email 屬性：

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

assertJsonStructure ​

斷言回應具有給定的 JSON 結構：

$response->assertJsonStructure(array $structure);

例如，如果您的應用程式回傳的 JSON 回應包含以下資料：

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

您可以斷言 JSON 結構符合您的預期，如下所示：

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

有時，應用程式回傳的 JSON 回應可能包含物件陣列：

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');

📌 備註

更通用的 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);

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, $escaped = true);

assertSeeInOrder ​

斷言給定的字串依序包含在回應中。除非您傳遞第二個參數為 false，否則此斷言將自動逸出給定的字串：

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

assertSeeText ​

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

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

assertSeeTextInOrder ​

斷言給定的字串依序包含在回應文字中。除非您傳遞第二個參數為 false，否則此斷言將自動逸出給定的字串。在進行斷言前，回應內容將會傳遞給 strip_tags PHP 函式：

$response->assertSeeTextInOrder(array $values, $escaped = 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.'
]);

📌 備註

更通用的 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');

📌 備註

更通用的 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',
]);

assertViewHas ​

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

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

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

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

此外，視圖資料可以作為回應上的陣列變數存取，方便您檢查：

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

assertViewHasAll ​

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

$response->assertViewHasAll(array $data);

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

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

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

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

assertViewIs ​

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

$response->assertViewIs($value);

assertViewMissing ​

斷言給定資料鍵未提供給應用程式回應中回傳的視圖：

$response->assertViewMissing($key);

認證斷言 ​

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

assertAuthenticated ​

斷言使用者已認證：

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

assertGuest ​

斷言使用者未認證：

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

assertAuthenticatedAs ​

斷言特定使用者已認證：

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

驗證斷言 ​

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',
]);