[ Laravel 5.4 文档 ] 测试 —— HTTP 测试

1、简介

Laravel 为生成 HTTP 请求、测试输出提供了流式 API。举个例子,我们看下下面定义的测试:

<?php

namespace Tests\Feature;

use Tests\TestCase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;

class ExampleTest extends TestCase
{
    /**
     * 基本测试示例.
     *
     * @return void
     */
    public function testBasicTest()
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

get 方法生成了一个 GET 请求,而 assertStatus 方法断言返回的响应应该包含给定的 HTTP 状态码。除了这个简单的断言之外,Laravel 还包含检查响应头、响应内容、响应JSON结构等多种断言。

2、会话/认证

Laravel 提供了多个辅助函数用于在 HTTP 测试期间处理会话(Session),首先,你可以使用 withSession 方法来设置会话数据。这对于在发起请求之前加载会话数据很有用:

<?php

class ExampleTest extends TestCase
{
    public function testApplication()
    {
        $response = $this->withSession(['foo' => 'bar'])
                         ->get('/');
    }
}

当然,会话最常见的用途还是维护认证用户的状态。对此,辅助函数 actionAs 方法提供了一个简单的方式来认证当前用户,例如,我们可以使用模型工厂来生成并认证用户:

<?php

use App\User;

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

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

你还可以通过传递 guard 名作为 actionAs 方法的第二个参数来指定使用哪一个 guard 来认证给定用户:

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

3、测试JSON API

Laravel 还提供了多个辅助函数用于测试 JSON API 及其响应。例如, jsongetpostputpatchdelete 方法用于通过多种 HTTP 请求方式发出请求。你还可以轻松传递数据和请求头到这些方法。作为开始,我们编写测试来生成 POST 请求到 /user 并断言返回的数据是否是我们所期望的:

<?php

class ExampleTest extends TestCase
{
    /**
     * 基本功能测试示例.
     *
     * @return void
     */
    public function testBasicExample()
    {
        $response = $this->json('POST', '/user', ['name' => 'Sally']);

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

注:assertJson 方法将响应转化为数组并使用 PHPUnit::assertArraySubset 验证给定数组在应用返回的 JSON 响应中存在。所以,如果在 JSON 响应中存在其它属性,这个测试仍然会通过,只要给定的片段存在即可。

验证完全匹配

如果你想要验证给定数组和应用返回的 JSON 能够完全匹配,使用 assertExactJson 方法:

<?php

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

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

4、测试文件上传

Illuminate\Http\UploadedFile 类提供了一个 fake 方法用于生成假文件或图片进行测试。这一机制和 Storage 门面的 fake 方法联合在一起,极大的简化了文件上传的测试。例如,你可以联合这两个特性来轻松测试头像上传表单:

<?php

namespace Tests\Feature;

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

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

        $response = $this->json('POST', '/avatar', [
            'avatar' => UploadedFile::fake()->image('avatar.jpg')
        ]);

        // Assert the file was stored...
        Storage::disk('avatars')->assertExists('avatar.jpg');

        // Assert a file does not exist...
        Storage::disk('avatars')->assertMissing('missing.jpg');
    }
}

伪造文件自定义

使用 fake 方法创建文件的时候,你可以指定宽度、高度、以及图片的尺寸以便更好的测试验证规则:

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

除了创建图片之外,你还可以使用 create 方法创建其它类型的文件:

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

5、有效的断言方法

Laravel 为 PHPUnit 测试提供了多个自定义的断言方法。这些断言可以通过测试方法jsongetpostputdelete 返回的响应进行访问:

方法 描述
$response->assertStatus($code); 断言响应是否包含给定code
$response->assertRedirect($uri); 断言响应是否重定向到给定URI
$response->assertHeader($headerName, $value = null); 断言请求头是否在响应中存在
$response->assertCookie($cookieName, $value = null); 断言响应是否包含给定cookie
$response->assertPlainCookie($cookieName, $value = null); 断言响应是否包含给定cookie(未加密)
$response->assertSessionHas($key, $value = null); 断言会话是否包含给定数据片段
$response->assertSessionHasErrors(array $keys); 断言会话是否包含给定片段错误
$response->assertSessionMissing($key); 断言会话不包含给定键
$response->assertJson(array $data); 断言响应包含给定JSON数据
$response->assertJsonFragment(array $data); 断言响应包含给定JSON片段
$response->assertJsonMissing(array $data); 断言响应不包含给定JSON片段
$response->assertExactJson(array $data); 断言响应包含完整的给定JSON片段
$response->assertJsonStructure(array $structure); 断言响应包含给定JSON结构
$response->assertViewHas($key, $value = null); 断言响应视图包含给定数据片段

学院君 has written 716 articles

资深PHP工程师,Laravel学院院长

One thought on “[ Laravel 5.4 文档 ] 测试 —— HTTP 测试

发表评论

标记为*的字段是必填项(邮箱地址不会被公开)

你可以使用这些HTML 标签和属性: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>