HTTP 测试
介绍
Laravel 提供了一个非常流畅的 API,用于向应用程序发出 HTTP 请求并检查输出。例如,请查看下面定义的测试:
<?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 结构等。
会话 / 认证
Laravel 提供了几个助手,用于在 HTTP 测试期间处理会话。首先,您可以使用 withSession
方法将会话数据设置为给定的数组。这对于在向应用程序发出请求之前加载会话数据非常有用:
<?php
class ExampleTest extends TestCase
{
public function testApplication()
{
$response = $this->withSession(['foo' => 'bar'])
->get('/');
}
}
当然,会话的一个常见用途是维护已认证用户的状态。actingAs
助手方法提供了一种简单的方法来将给定用户认证为当前用户。例如,我们可以使用 模型工厂 来生成和认证用户:
<?php
use App\User;
class ExampleTest extends TestCase
{
public function testApplication()
{
$user = factory(User::class)->create();
$response = $this->actingAs($user)
->withSession(['foo' => 'bar'])
->get('/');
}
}
您还可以通过将守卫名称作为第二个参数传递给 actingAs
方法来指定应使用哪个守卫来认证给定用户:
$this->actingAs($user, 'api')
测试 JSON API
Laravel 还提供了几个助手,用于测试 JSON API 及其响应。例如,可以使用 json
、get
、post
、put
、patch
和 delete
方法发出具有各种 HTTP 动词的请求。您还可以轻松地将数据和头信息传递给这些方法。首先,让我们编写一个测试,以向 /user
发出 POST
请求并断言返回了预期的数据:
<?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
{
/**
* 一个基本的功能测试示例。
*
* @return void
*/
public function testBasicExample()
{
$response = $this->json('POST', '/user', ['name' => 'Sally']);
$response
->assertStatus(200)
->assertExactJson([
'created' => true,
]);
}
}
测试文件上传
Illuminate\Http\UploadedFile
类提供了一个 fake
方法,可用于生成用于测试的虚拟文件或图像。这与 Storage
facade 的 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')
]);
// 断言文件已存储...
Storage::disk('avatars')->assertExists('avatar.jpg');
// 断言文件不存在...
Storage::disk('avatars')->assertMissing('missing.jpg');
}
}
虚拟文件自定义
在使用 fake
方法创建文件时,您可以指定图像的宽度、高度和大小,以便更好地测试您的验证规则:
UploadedFile::fake()->image('avatar.jpg', $width, $height)->size(100);
除了创建图像,您还可以使用 create
方法创建任何其他类型的文件:
UploadedFile::fake()->create('document.pdf', $sizeInKilobytes);
可用的断言
Laravel 为您的 PHPUnit 测试提供了多种自定义断言方法。这些断言可以在从 json
、get
、post
、put
和 delete
测试方法返回的响应上访问:
方法 | 描述 |
---|---|
$response->assertStatus($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->assertViewIs($value); | 断言给定的视图由路由返回。 |
$response->assertViewHas($key, $value = null); | 断言响应视图被赋予了一段数据。 |