HTTP 测试

简介
发起请求
测试 JSON API
- 流畅的 JSON 测试
测试文件上传
测试视图
- 渲染 Blade 和组件
缓存路由
可用的断言

简介

Laravel 提供了一个非常流畅的 API 用于向你的应用程序发起 HTTP 请求并检查响应。例如，请看下面定义的功能测试：

PestPHPUnit

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
{
    /**
     * 一个基本的测试示例。
     */
    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 的实例，它提供了各种有用的断言，允许你检查应用程序的响应：

PestPHPUnit

php

<?php

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

    $response->assertStatus(200);
});

php

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_a_basic_request(): void
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

通常，你的每个测试应该只向应用程序发起一个请求。如果在单个测试方法中执行多个请求，可能会出现意外行为。

NOTE

为方便起见，运行测试时 CSRF 中间件会自动禁用。

自定义请求头

你可以使用 withHeaders 方法在将请求发送到应用程序之前自定义请求头。此方法允许你向请求添加任何自定义头：

PestPHPUnit

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
{
    /**
     * 一个基本的功能测试示例。
     */
    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 方法接受一个名称/值对数组：

PestPHPUnit

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

        //
    }
}

会话 / 认证

Laravel 提供了几个用于在 HTTP 测试期间与会话交互的辅助函数。首先，你可以使用 withSession 方法将会话数据设置为给定的数组。这对于在向应用程序发起请求之前将数据加载到会话中很有用：

PestPHPUnit

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 的会话通常用于维护当前认证用户的状态。因此，actingAs 辅助方法提供了一种简单的方法来将给定用户认证为当前用户。例如，我们可以使用模型工厂来生成和认证一个用户：

PestPHPUnit

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

        //
    }
}

你还可以通过将守卫名称作为第二个参数传递给 actingAs 方法来指定应用来认证给定用户的守卫。传递给 actingAs 方法的守卫也将在测试期间成为默认守卫：

php

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

如果你想确保请求未经认证，可以使用 actingAsGuest 方法：

php

$this->actingAsGuest();

调试响应

在向你的应用程序发起测试请求后，可以使用 dump、dumpHeaders 和 dumpSession 方法来检查并调试响应内容：

PestPHPUnit

php

<?php

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

    $response->dump();
    $response->dumpHeaders();
    $response->dumpSession();
});

php

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_basic_test(): void
    {
        $response = $this->get('/');

        $response->dump();
        $response->dumpHeaders();
        $response->dumpSession();
    }
}

或者，你可以使用 dd、ddHeaders、ddBody、ddJson 和 ddSession 方法来转储有关响应的信息，然后停止执行：

PestPHPUnit

php

<?php

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

    $response->dd();
    $response->ddHeaders();
    $response->ddBody();
    $response->ddJson();
    $response->ddSession();
});

php

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_basic_test(): void
    {
        $response = $this->get('/');

        $response->dd();
        $response->ddHeaders();
        $response->ddBody();
        $response->ddJson();
        $response->ddSession();
    }
}

异常处理

有时你可能需要测试你的应用程序是否抛出了特定的异常。为此，你可以通过 Exceptions Facade 来“模拟”异常处理程序。一旦异常处理程序被模拟，你可以使用 assertReported 和 assertNotReported 方法对在请求期间抛出的异常进行断言：

PestPHPUnit

php

<?php

use App\Exceptions\InvalidOrderException;
use Illuminate\Support\Facades\Exceptions;

test('exception is thrown', function () {
    Exceptions::fake();

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

    // 断言抛出了一个异常...
    Exceptions::assertReported(InvalidOrderException::class);

    // 对异常进行断言...
    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
{
    /**
     * 一个基本的测试示例。
     */
    public function test_exception_is_thrown(): void
    {
        Exceptions::fake();

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

        // 断言抛出了一个异常...
        Exceptions::assertReported(InvalidOrderException::class);

        // 对异常进行断言...
        Exceptions::assertReported(function (InvalidOrderException $e) {
            return $e->getMessage() === 'The order was invalid.';
        });
    }
}

assertNotReported 和 assertNothingReported 方法可用于断言在请求期间未抛出给定异常或未抛出任何异常：

php

Exceptions::assertNotReported(InvalidOrderException::class);

Exceptions::assertNothingReported();

你可以在发起请求之前调用 withoutExceptionHandling 方法来完全禁用给定请求的异常处理：

php

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

此外，如果你想确保你的应用程序没有使用已被 PHP 语言或应用程序使用的库弃用的功能，你可以在发起请求之前调用 withoutDeprecationHandling 方法。当弃用处理被禁用时，弃用警告将被转换为异常，从而导致测试失败：

php

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

assertDoesntThrow 方法可用于断言给定闭包内的代码不会抛出任何异常：

php

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

测试 JSON API

Laravel 还提供了几个用于测试 JSON API 及其响应的辅助函数。例如，json、getJson、postJson、putJson、patchJson、deleteJson 和 optionsJson 方法可用于使用各种 HTTP 动词发起 JSON 请求。你也可以轻松地向这些方法传递数据和头信息。首先，让我们编写一个测试，向 /api/user 发起 POST 请求，并断言返回了预期的 JSON 数据：

PestPHPUnit

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
{
    /**
     * 一个基本的功能测试示例。
     */
    public function test_making_an_api_request(): void
    {
        $response = $this->postJson('/api/user', ['name' => 'Sally']);

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

此外，JSON 响应数据可以作为数组变量在响应上访问，方便你检查 JSON 响应中返回的各个值：

PestPHPUnit

php

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

php

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

NOTE

assertJson 方法将响应转换为数组，以验证给定的数组是否存在于应用程序返回的 JSON 响应中。因此，如果 JSON 响应中还有其他属性，只要存在给定的片段，此测试仍然会通过。

断言精确的 JSON 匹配

如前所述，assertJson 方法可用于断言 JSON 响应中存在一个片段。如果你想验证给定的数组 与应用程序返回的 JSON 完全匹配，则应使用 assertExactJson 方法：

PestPHPUnit

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
{
    /**
     * 一个基本的功能测试示例。
     */
    public function test_asserting_an_exact_json_match(): void
    {
        $response = $this->postJson('/user', ['name' => 'Sally']);

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

对 JSON 路径进行断言

如果你想验证 JSON 响应在指定路径包含给定数据，应使用 assertJsonPath 方法：

PestPHPUnit

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
{
    /**
     * 一个基本的功能测试示例。
     */
    public function test_asserting_a_json_paths_value(): void
    {
        $response = $this->postJson('/user', ['name' => 'Sally']);

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

assertJsonPath 方法也接受一个闭包，该闭包可用于动态确定断言是否应通过：

php

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

流畅的 JSON 测试

Laravel 还提供了一种漂亮的方式来流畅地测试应用程序的 JSON 响应。首先，将一个闭包传递给 assertJson 方法。此闭包将使用 Illuminate\Testing\Fluent\AssertableJson 实例调用，该实例可用于对应用程序返回的 JSON 进行断言。where 方法可用于对 JSON 的特定属性进行断言，而 missing 方法可用于断言特定属性在 JSON 中不存在：

PestPHPUnit

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('victoria@gmail.com'))
                ->whereNot('status', 'pending')
                ->missing('password')
                ->etc()
        );
});

php

use Illuminate\Testing\Fluent\AssertableJson;

/**
 * 一个基本的功能测试示例。
 */
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` 方法

在上面的示例中，你可能已经注意到我们在断言链的末尾调用了 etc 方法。此方法告诉 Laravel JSON 对象上可能存在其他属性。如果不使用 etc 方法，如果 JSON 对象上存在你没有对其断言的其他属性，测试将会失败。

此行为背后的意图是保护你免于无意中将敏感信息暴露在 JSON 响应中，它强制你要么显式地对属性进行断言，要么通过 etc 方法显式允许额外的属性。

但是，你应该注意，在断言链中不包含 etc 方法并不能确保嵌套在 JSON 对象中的数组中不会添加额外的属性。etc 方法仅确保在调用 etc 方法的嵌套级别上不存在额外的属性。

断言属性存在/不存在

要断言属性存在或不存在，你可以使用 has 和 missing 方法：

php

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

此外，hasAll 和 missingAll 方法允许同时断言多个属性的存在或不存在：

php

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

你可以使用 hasAny 方法来确定给定列表中的至少一个属性是否存在：

php

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

对 JSON 集合进行断言

通常，你的路由将返回包含多个项目的 JSON 响应，例如多个用户：

php

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

在这些情况下，我们可以使用流畅的 JSON 对象的 has 方法对响应中包含的用户进行断言。例如，让我们断言 JSON 响应包含三个用户。接下来，我们将使用 first 方法对集合中的第一个用户进行一些断言。first 方法接受一个闭包，该闭包接收另一个可断言的 JSON 字符串，我们可以使用它对 JSON 集合中的第一个对象进行断言：

php

$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 集合中的每个项目进行相同的断言，可以使用 each 方法：

php

$response
  ->assertJson(fn (AssertableJson $json) =>
      $json->has(3)
          ->each(fn (AssertableJson $json) =>
              $json->whereType('id', 'integer')
                  ->whereType('name', 'string')
                  ->whereType('email', 'string')
                  ->missing('password')
                  ->etc()
          )
  );

限定 JSON 集合断言的作用域

有时，应用程序的路由会返回分配了命名键的 JSON 集合：

php

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

测试这些路由时，你可以使用 has 方法来断言集合中的项目数。此外，你可以使用 has 方法来限定断言链的作用域：

php

$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 集合进行断言，你可以进行一次调用，并提供闭包作为其第三个参数。这样做时，闭包将被自动调用并限定于集合中的第一个项目：

php

$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 类型

你可能只想断言 JSON 响应中的属性是某种类型。Illuminate\Testing\Fluent\AssertableJson 类提供了 whereType 和 whereAllType 方法来实现这一点：

php

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

你可以使用 | 字符指定多种类型，或者将类型数组作为 whereType 方法的第二个参数传递。如果响应值是指定类型中的任何一种，则断言成功：

php

$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 方法相结合，极大地简化了文件上传的测试。例如，你可以结合这两个功能轻松测试头像上传表单：

PestPHPUnit

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 方法：

php

Storage::fake('avatars');

// ...

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

模拟文件自定义

使用 UploadedFile 类提供的 fake 方法创建文件时，你可以指定图像的宽度、高度和大小（以千字节为单位），以便更好地测试应用程序的验证规则：

php

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

除了创建图像，你还可以使用 create 方法创建任何其他类型的文件：

php

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

如果需要，你可以向该方法传递一个 $mimeType 参数，以显式定义文件应返回的 MIME 类型：

php

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

测试视图

Laravel 还允许你渲染视图，而无需向应用程序发起模拟 HTTP 请求。为此，你可以在测试中调用 view 方法。view 方法接受视图名称和一个可选的数组数据。该方法返回 Illuminate\Testing\TestView 的实例，它提供了几种方便的方法来对视图内容进行断言：

PestPHPUnit

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 实例转换为字符串来获取原始的渲染视图内容：

php

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

共享错误

某些视图可能依赖于在 Laravel 提供的全局错误包中共享的错误。要使用错误消息填充错误包，你可以使用 withViewErrors 方法：

php

$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 的实例：

php

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

$view->assertSee('Taylor');

你可以使用 component 方法来评估和渲染 Blade 组件。component 方法返回 Illuminate\Testing\TestComponent 的实例：

php

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

$view->assertSee('Taylor');

缓存路由

在测试运行之前，Laravel 会启动一个全新的应用程序实例，包括收集所有定义的路由。如果你的应用程序有许多路由文件，你可能希望在你的测试用例中添加 Illuminate\Foundation\Testing\WithCachedRoutes trait。在使用此 trait 的测试中，路由被构建一次并存储在内存中，这意味着路由收集过程只对套件中的所有测试运行一次：

PestPHPUnit

php

<?php

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

uses(WithCachedRoutes::class);

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

    // ...
});

php

<?php

namespace Tests\Feature;

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

class BasicTest extends TestCase
{
    use WithCachedRoutes;

    /**
     * 一个基本的功能测试示例。
     */
    public function test_basic_example(): void
    {
        $response = $this->get(action([UserController::class, 'index']));

        // ...
    }
}

可用的断言

响应断言

Laravel 的 Illuminate\Testing\TestResponse 类提供了各种自定义断言方法，你可以在测试应用程序时使用这些方法。这些断言可以在由 json、get、post、put 和 delete 测试方法返回的响应上访问：

assertAccepted assertBadRequest assertClientError assertConflict assertCookie assertCookieExpired assertCookieNotExpired assertCookieMissing assertCreated assertDontSee assertDontSeeText assertDownload assertExactJson assertExactJsonStructure assertForbidden assertFound assertGone assertHeader assertHeaderContains assertHeaderMissing assertInternalServerError assertJson assertJsonCount assertJsonFragment assertJsonIsArray assertJsonIsObject assertJsonMissing assertJsonMissingExact assertJsonMissingValidationErrors assertJsonPath assertJsonMissingPath assertJsonStructure assertJsonValidationErrors assertJsonValidationErrorFor assertLocation assertMethodNotAllowed assertMovedPermanently assertContent assertNoContent assertStreamed assertStreamedContent assertNotFound assertOk assertPaymentRequired assertPlainCookie assertRedirect assertRedirectBack assertRedirectBackWithErrors assertRedirectBackWithoutErrors assertRedirectContains assertRedirectToRoute assertRedirectToSignedRoute assertRequestTimeout assertSee assertSeeInOrder assertSeeText assertSeeTextInOrder assertServerError assertServiceUnavailable assertSessionHas assertSessionHasInput assertSessionHasAll assertSessionHasErrors assertSessionHasErrorsIn assertSessionHasNoErrors assertSessionDoesntHaveErrors assertSessionMissing assertStatus assertSuccessful assertTooManyRequests assertUnauthorized assertUnprocessable assertUnsupportedMediaType assertValid assertInvalid assertViewHas assertViewHasAll assertViewIs assertViewMissing

assertAccepted

断言响应具有接受的（202）HTTP 状态码：

php

$response->assertAccepted();

assertBadRequest

断言响应具有错误请求（400）HTTP 状态码：

php

$response->assertBadRequest();

assertClientError

断言响应具有客户端错误（>= 400, < 500）HTTP 状态码：

php

$response->assertClientError();

assertConflict

断言响应具有冲突（409）HTTP 状态码：

php

$response->assertConflict();

assertCookie

断言响应包含给定的 cookie：

php

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

assertCookieExpired

断言响应包含给定的 cookie 并且已过期：

php

$response->assertCookieExpired($cookieName);

assertCookieNotExpired

断言响应包含给定的 cookie 并且未过期：

php

$response->assertCookieNotExpired($cookieName);

assertCookieMissing

断言响应不包含给定的 cookie：

php

$response->assertCookieMissing($cookieName);

assertCreated

断言响应具有 201 HTTP 状态码：

php

$response->assertCreated();

assertDontSee

断言应用程序返回的响应中不包含给定的字符串。除非你传递第二个参数 false，否则此断言将自动转义给定的字符串：

php

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

assertDontSeeText

断言响应文本中不包含给定的字符串。除非你传递第二个参数 false，否则此断言将自动转义给定的字符串。此方法在进行断言之前会将响应内容传递给 PHP 的 strip_tags 函数：

php

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

assertDownload

断言响应是一个“下载”。通常，这意味着返回响应的调用路由返回了一个 Response::download 响应、BinaryFileResponse 或 Storage::download 响应：

php

$response->assertDownload();

如果你愿意，可以断言可下载的文件被分配了一个给定的文件名：

php

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

assertExactJson

断言响应包含与给定 JSON 数据的精确匹配：

php

$response->assertExactJson(array $data);

assertExactJsonStructure

断言响应包含与给定 JSON 结构的精确匹配：

php

$response->assertExactJsonStructure(array $data);

此方法是 assertJsonStructure 的更严格变体。与 assertJsonStructure 相比，如果响应包含任何未显式包含在预期 JSON 结构中的键，此方法将失败。

assertForbidden

断言响应具有禁止访问（403）HTTP 状态码：

php

$response->assertForbidden();

assertFound

断言响应具有已找到（302）HTTP 状态码：

php

$response->assertFound();

assertGone

断言响应具有已删除（410）HTTP 状态码：

php

$response->assertGone();

assertHeader

断言给定的标头和值存在于响应中：

php

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

assertHeaderContains

断言给定的标头包含给定的子字符串值：

php

$response->assertHeaderContains($headerName, $value);

assertHeaderMissing

断言给定的标头不存在于响应中：

php

$response->assertHeaderMissing($headerName);

assertInternalServerError

断言响应具有“内部服务器错误”（500）HTTP 状态码：

php

$response->assertInternalServerError();

assertJson

断言响应包含给定的 JSON 数据：

php

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

assertJsonCount

断言响应 JSON 在给定键处具有包含预期项目数的数组：

php

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

assertJsonFragment

断言响应中的任何位置包含给定的 JSON 数据：

php

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

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

assertJsonIsArray

断言响应 JSON 是一个数组：

php

$response->assertJsonIsArray();

assertJsonIsObject

断言响应 JSON 是一个对象：

php

$response->assertJsonIsObject();

assertJsonMissing

断言响应不包含给定的 JSON 数据：

php

$response->assertJsonMissing(array $data);

assertJsonMissingExact

断言响应不包含精确的 JSON 数据：

php

$response->assertJsonMissingExact(array $data);

assertJsonMissingValidationErrors

断言响应对于给定的键没有 JSON 验证错误：

php

$response->assertJsonMissingValidationErrors($keys);

NOTE

更通用的 assertValid 方法可用于断言响应没有以 JSON 形式返回的验证错误，并且没有错误被闪存到会话存储中。

assertJsonPath

断言响应在指定路径包含给定的数据：

php

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

例如，如果应用程序返回以下 JSON 响应：

json

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

你可以像这样断言 user 对象的 name 属性与给定值匹配：

php

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

assertJsonMissingPath

断言响应不包含给定的路径：

php

$response->assertJsonMissingPath($path);

例如，如果应用程序返回以下 JSON 响应：

json

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

你可以断言它不包含 user 对象的 email 属性：

php

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

assertJsonStructure

断言响应具有给定的 JSON 结构：

php

$response->assertJsonStructure(array $structure);

例如，如果应用程序返回的 JSON 响应包含以下数据：

json

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

你可以像这样断言 JSON 结构符合你的期望：

php

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

有时，应用程序返回的 JSON 响应可能包含对象数组：

json

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

在这种情况下，你可以使用 * 字符来断言数组中所有对象的结构：

php

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

assertJsonValidationErrors

断言响应对于给定的键具有给定的 JSON 验证错误。此方法应用于断言响应，其中验证错误以 JSON 结构返回，而不是被闪存到会话中：

php

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

NOTE

更通用的 assertInvalid 方法可用于断言响应具有以 JSON 形式返回的验证错误或错误被闪存到会话存储中。

assertJsonValidationErrorFor

断言响应对于给定的键具有任何 JSON 验证错误：

php

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

assertMethodNotAllowed

断言响应具有方法不允许（405）HTTP 状态码：

php

$response->assertMethodNotAllowed();

assertMovedPermanently

断言响应具有永久重定向（301）HTTP 状态码：

php

$response->assertMovedPermanently();

assertLocation

断言响应在 Location 标头中具有给定的 URI 值：

php

$response->assertLocation($uri);

assertContent

断言给定的字符串与响应内容匹配：

php

$response->assertContent($value);

assertNoContent

断言响应具有给定的 HTTP 状态码且没有内容：

php

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

assertStreamed

断言响应是一个流式响应：

php

$response->assertStreamed();

assertStreamedContent

断言给定的字符串与流式响应内容匹配：

php

$response->assertStreamedContent($value);

assertNotFound

断言响应具有未找到（404）HTTP 状态码：

php

$response->assertNotFound();

assertOk

断言响应具有 200 HTTP 状态码：

php

$response->assertOk();

assertPaymentRequired

断言响应具有需要付款（402）HTTP 状态码：

php

$response->assertPaymentRequired();

assertPlainCookie

断言响应包含给定的未加密 cookie：

php

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

assertRedirect

断言响应是到给定 URI 的重定向：

php

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

assertRedirectBack

断言响应是否重定向回上一页：

php

$response->assertRedirectBack();

assertRedirectBackWithErrors

断言响应是否重定向回上一页，并且会话具有给定的错误：

php

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

assertRedirectBackWithoutErrors

断言响应是否重定向回上一页，并且会话不包含任何错误消息：

php

$response->assertRedirectBackWithoutErrors();

assertRedirectContains

断言响应是否重定向到包含给定字符串的 URI：

php

$response->assertRedirectContains($string);

assertRedirectToRoute

断言响应是到给定的命名路由的重定向：

php

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

assertRedirectToSignedRoute

断言响应是到给定的签名路由的重定向：

php

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

assertRequestTimeout

断言响应具有请求超时（408）HTTP 状态码：

php

$response->assertRequestTimeout();

assertSee

断言给定的字符串包含在响应中。除非你传递第二个参数 false，否则此断言将自动转义给定的字符串：

php

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

assertSeeInOrder

断言给定的字符串按顺序包含在响应中。除非你传递第二个参数 false，否则此断言将自动转义给定的字符串：

php

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

assertSeeText

断言给定的字符串包含在响应文本中。除非你传递第二个参数 false，否则此断言将自动转义给定的字符串。在进行断言之前，响应内容将被传递给 PHP 的 strip_tags 函数：

php

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

assertSeeTextInOrder

断言给定的字符串按顺序包含在响应文本中。除非你传递第二个参数 false，否则此断言将自动转义给定的字符串。在进行断言之前，响应内容将被传递给 PHP 的 strip_tags 函数：

php

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

assertServerError

断言响应具有服务器错误（>= 500, < 600）HTTP 状态码：

php

$response->assertServerError();

assertServiceUnavailable

断言响应具有“服务不可用”（503）HTTP 状态码：

php

$response->assertServiceUnavailable();

assertSessionHas

断言会话包含给定的数据片段：

php

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

如果需要，可以向 assertSessionHas 方法提供一个闭包作为第二个参数。如果闭包返回 true，则断言通过：

php

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

assertSessionHasInput

断言会话在闪存输入数组中具有给定的值：

php

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

如果需要，可以向 assertSessionHasInput 方法提供一个闭包作为第二个参数。如果闭包返回 true，则断言通过：

php

use Illuminate\Support\Facades\Crypt;

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

assertSessionHasAll

断言会话包含给定的键/值对数组：

php

$response->assertSessionHasAll(array $data);

例如，如果你的应用程序的会话包含 name 和 status 键，你可以像这样断言两者都存在并具有指定的值：

php

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

assertSessionHasErrors

断言会话包含给定 $keys 的错误。如果 $keys 是一个关联数组，则断言会话包含每个字段（键）的特定错误消息（值）。此方法应用于测试那些将验证错误闪存到会话而不是以 JSON 结构返回的路由：

php

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

例如，要断言 name 和 email 字段具有闪存到会话的验证错误消息，你可以像这样调用 assertSessionHasErrors 方法：

php

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

或者，你可以断言给定字段具有特定的验证错误消息：

php

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

NOTE

更通用的 assertInvalid 方法可用于断言响应具有以 JSON 形式返回的验证错误或错误被闪存到会话存储中。

assertSessionHasErrorsIn

断言会话在特定的错误包中包含给定 $keys 的错误。如果 $keys 是一个关联数组，则断言会话在错误包中包含每个字段（键）的特定错误消息（值）：

php

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

assertSessionHasNoErrors

断言会话没有验证错误：

php

$response->assertSessionHasNoErrors();

assertSessionDoesntHaveErrors

断言会话对于给定的键没有验证错误：

php

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

NOTE

更通用的 assertValid 方法可用于断言响应没有以 JSON 形式返回的验证错误，并且没有错误被闪存到会话存储中。

assertSessionMissing

断言会话不包含给定的键：

php

$response->assertSessionMissing($key);

assertStatus

断言响应具有给定的 HTTP 状态码：

php

$response->assertStatus($code);

assertSuccessful

断言响应具有成功的（>= 200 且 < 300）HTTP 状态码：

php

$response->assertSuccessful();

assertTooManyRequests

断言响应具有请求过多（429）HTTP 状态码：

php

$response->assertTooManyRequests();

assertUnauthorized

断言响应具有未授权（401）HTTP 状态码：

php

$response->assertUnauthorized();

assertUnprocessable

断言响应具有不可处理的实体（422）HTTP 状态码：

php

$response->assertUnprocessable();

assertUnsupportedMediaType

断言响应具有不支持的媒体类型（415）HTTP 状态码：

php

$response->assertUnsupportedMediaType();

assertValid

断言响应对于给定的键没有验证错误。此方法可用于断言响应，其中验证错误以 JSON 结构返回，或者验证错误已被闪存到会话：

php

// 断言没有验证错误存在...
$response->assertValid();

// 断言给定的键没有验证错误...
$response->assertValid(['name', 'email']);

assertInvalid

断言响应对于给定的键具有验证错误。此方法可用于断言响应，其中验证错误以 JSON 结构返回，或者验证错误已被闪存到会话：

php

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

你也可以断言给定键具有特定的验证错误消息。这样做时，你可以提供完整消息或仅提供消息的一小部分：

php

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

如果你想断言给定的字段是唯一具有验证错误的字段，可以使用 assertOnlyInvalid 方法：

php

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

assertViewHas

断言响应视图包含给定的数据片段：

php

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

向 assertViewHas 方法传递一个闭包作为第二个参数，将允许你检查并对特定的视图数据进行断言：

php

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

此外，视图数据可以作为数组变量在响应上访问，允许你方便地检查它：

PestPHPUnit

php

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

php

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

assertViewHasAll

断言响应视图具有给定的数据列表：

php

$response->assertViewHasAll(array $data);

此方法可用于断言视图简单地包含与给定键匹配的数据：

php

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

或者，你可以断言视图数据存在并具有特定值：

php

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

assertViewIs

断言给定的视图由路由返回：

php

$response->assertViewIs($value);

assertViewMissing

断言给定的数据键在应用程序返回的视图中不可用：

php

$response->assertViewMissing($key);

认证断言

Laravel 还提供了各种与认证相关的断言，你可以在应用程序的功能测试中使用它们。请注意，这些方法是在测试类本身上调用的，而不是在由 get 和 post 等方法返回的 Illuminate\Testing\TestResponse 实例上调用的。

assertAuthenticated

断言用户已认证：

php

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

assertGuest

断言用户未认证：

php

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

assertAuthenticatedAs

断言特定用户已认证：

php

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

验证断言

Laravel 提供了两个主要的验证相关断言，你可以使用它们来确保请求中提供的数据要么有效，要么无效。

assertValid

断言响应对于给定的键没有验证错误。此方法可用于断言响应，其中验证错误以 JSON 结构返回，或者验证错误已被闪存到会话：

php

// 断言没有验证错误存在...
$response->assertValid();

// 断言给定的键没有验证错误...
$response->assertValid(['name', 'email']);

assertInvalid

断言响应对于给定的键具有验证错误。此方法可用于断言响应，其中验证错误以 JSON 结构返回，或者验证错误已被闪存到会话：

php

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

你也可以断言给定键具有特定的验证错误消息。这样做时，你可以提供完整消息或仅提供消息的一小部分：

php

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

HTTP 测试 ​

简介 ​

发起请求 ​

自定义请求头 ​

Cookies ​

会话 / 认证 ​

调试响应 ​

异常处理 ​

测试 JSON API ​

断言精确的 JSON 匹配 ​

对 JSON 路径进行断言 ​

流畅的 JSON 测试 ​

理解 etc 方法 ​

断言属性存在/不存在 ​

对 JSON 集合进行断言 ​

限定 JSON 集合断言的作用域 ​

断言 JSON 类型 ​

测试文件上传 ​

模拟文件自定义 ​

测试视图 ​

共享错误 ​

渲染 Blade 和组件 ​

缓存路由 ​

可用的断言 ​

响应断言 ​

assertAccepted ​

assertBadRequest ​

assertClientError ​

assertConflict ​

assertCookie ​

assertCookieExpired ​

assertCookieNotExpired ​

assertCookieMissing ​

assertCreated ​

assertDontSee ​

assertDontSeeText ​

assertDownload ​

assertExactJson ​

assertExactJsonStructure ​

assertForbidden ​

assertFound ​

assertGone ​

assertHeader ​

assertHeaderContains ​

assertHeaderMissing ​

assertInternalServerError ​

assertJson ​

assertJsonCount ​

assertJsonFragment ​

assertJsonIsArray ​

assertJsonIsObject ​

assertJsonMissing ​

assertJsonMissingExact ​

assertJsonMissingValidationErrors ​

assertJsonPath ​

assertJsonMissingPath ​

assertJsonStructure ​

assertJsonValidationErrors ​

assertJsonValidationErrorFor ​

assertMethodNotAllowed ​

assertMovedPermanently ​

assertLocation ​

assertContent ​

assertNoContent ​

assertStreamed ​

assertStreamedContent ​

assertNotFound ​

assertOk ​

assertPaymentRequired ​

assertPlainCookie ​

assertRedirect ​

assertRedirectBack ​

assertRedirectBackWithErrors ​

assertRedirectBackWithoutErrors ​

assertRedirectContains ​

assertRedirectToRoute ​

assertRedirectToSignedRoute ​

assertRequestTimeout ​

assertSee ​

assertSeeInOrder ​

HTTP 测试

简介

发起请求

自定义请求头

Cookies

会话 / 认证

调试响应

异常处理

测试 JSON API

断言精确的 JSON 匹配

对 JSON 路径进行断言

流畅的 JSON 测试

理解 `etc` 方法

断言属性存在/不存在

对 JSON 集合进行断言

限定 JSON 集合断言的作用域

断言 JSON 类型

测试文件上传

模拟文件自定义

测试视图

共享错误

渲染 Blade 和组件

缓存路由

可用的断言

响应断言

assertAccepted

assertBadRequest

assertClientError

assertConflict

assertCookie

assertCookieExpired

assertCookieNotExpired

assertCookieMissing

assertCreated

assertDontSee

assertDontSeeText

assertDownload

assertExactJson

assertExactJsonStructure

assertForbidden

assertFound

assertGone

assertHeader

assertHeaderContains

assertHeaderMissing

assertInternalServerError

assertJson

assertJsonCount

assertJsonFragment

assertJsonIsArray

assertJsonIsObject

assertJsonMissing

assertJsonMissingExact

assertJsonMissingValidationErrors

assertJsonPath

assertJsonMissingPath

assertJsonStructure

assertJsonValidationErrors

assertJsonValidationErrorFor

assertMethodNotAllowed

assertMovedPermanently

assertLocation

assertContent

assertNoContent

assertStreamed

assertStreamedContent

assertNotFound

assertOk

assertPaymentRequired

assertPlainCookie

assertRedirect

assertRedirectBack

assertRedirectBackWithErrors

assertRedirectBackWithoutErrors

assertRedirectContains

assertRedirectToRoute

assertRedirectToSignedRoute

assertRequestTimeout

assertSee

assertSeeInOrder