测试响应

TestResponse 类提供了许多有用的函数来解析测试用例中的响应并对其进行测试。通常, TestResponse 将作为你的结果提供,:doc:控制器测试 <controllers> 或 HTTP 功能测试,但你始终可以直接使用任何 ResponseInterface 创建自己的:

<?php

$result = new \CodeIgniter\Test\TestResponse($response);
$result->assertOK();

测试响应

测试响应 

无论你是从测试中获得 TestResponse 还是自己创建,都可以在测试中使用许多新的断言。

访问请求/响应 

request()

如果在测试期间设置了请求,你可以直接访问请求对象:

<?php

$request = $results->request();

response()

这允许你直接访问响应对象:

<?php

$response = $results->response();

检查响应状态 

isOK()

根据响应是否被视为“正常”返回布尔值 true/false。这主要由 200 或 300 范围内的响应状态代码确定。如果重定向,空响应正文不被视为有效。

<?php

if ($result->isOK()) {
    // ...
}

assertOK()

此断言简单地使用 isOK() 方法来测试响应。assertNotOK() 是此断言的逆。

<?php

$result->assertOK();

isRedirect()

根据响应是否重定向返回布尔值 true/false。

<?php

if ($result->isRedirect()) {
    // ...
}

assertRedirect()

断言响应是 RedirectResponse 的一个实例。assertNotRedirect() 是此断言的逆。

<?php

$result->assertRedirect();

assertRedirectTo()

断言响应是一个 RedirectResponse 实例,且目标与给定的 uri 匹配。

<?php

$result->assertRedirectTo('foo/bar');

getRedirectUrl()

返回设置为 RedirectResponse 的 URL,如果失败则为 null。

<?php

$url = $result->getRedirectUrl();
$this->assertEquals(site_url('foo/bar'), $url);

assertStatus(int $code)

断言返回的 HTTP 状态码匹配 $code。

<?php

$result->assertStatus(403);

会话断言 

assertSessionHas(string $key, $value = null)

断言结果会话中存在一个值。如果传递了 $value,还将断言变量的值与指定的相匹配。

<?php

$result->assertSessionHas('logged_in', 123);

assertSessionMissing(string $key)

断言结果会话不包括指定的 $key。

<?php

$result->assertSessionMissing('logged_in');

标头断言 

assertHeader(string $key, $value = null)

断言响应中存在一个名为 $key 的标头。如果 $value 非空,还将断言值匹配。

<?php

$result->assertHeader('Content-Type', 'text/html');

assertHeaderMissing(string $key)

断言响应中不存在名为 $key 的标头。

<?php

$result->assertHeader('Accepts');

DOM 帮助方法 

你得到的响应包含许多帮助方法来检查响应中的 HTML 输出。这些在测试中的断言中很有用。

see()

see() 方法检查页面上的文本,看它是否自身存在,或者更具体地说是在由类型、类或 id 指定的标记内存在:

<?php

// Check that "Hello World" is on the page
$results->see('Hello World');
// Check that "Hello World" is within an h1 tag
$results->see('Hello World', 'h1');
// Check that "Hello World" is within an element with the "notice" class
$results->see('Hello World', '.notice');
// Check that "Hello World" is within an element with id of "title"
$results->see('Hello World', '#title');

dontSee() 方法正好相反:

<?php

// Checks that "Hello World" does NOT exist on the page
$results->dontSee('Hello World');
// Checks that "Hellow World" does NOT exist within any h1 tag
$results->dontSee('Hello World', 'h1');

seeElement()

seeElement() 和 dontSeeElement() 与前面的方法非常相似,但不检查元素的值。相反,它们仅检查元素是否存在于页面上:

<?php

// Check that an element with class 'notice' exists
$results->seeElement('.notice');
// Check that an element with id 'title' exists
$results->seeElement('#title');
// Verify that an element with id 'title' does NOT exist
$results->dontSeeElement('#title');

seeLink()

你可以使用 seeLink() 来确保页面上存在具有指定文本的链接:

<?php

// Check that a link exists with 'Upgrade Account' as the text::
$results->seeLink('Upgrade Account');
// Check that a link exists with 'Upgrade Account' as the text, AND a class of 'upsell'
$results->seeLink('Upgrade Account', '.upsell');

seeInField()

seeInField() 方法检查是否存在具有给定名称和值的输入标签:

<?php

// Check that an input exists named 'user' with the value 'John Snow'
$results->seeInField('user', 'John Snow');
// Check a multi-dimensional input
$results->seeInField('user[name]', 'John Snow');

seeCheckboxIsChecked()

最后,你可以使用 seeCheckboxIsChecked() 方法检查复选框是否存在并已被选中:

<?php

// Check if checkbox is checked with class of 'foo'
$results->seeCheckboxIsChecked('.foo');
// Check if checkbox with id of 'bar' is checked
$results->seeCheckboxIsChecked('#bar');

DOM 断言 

你可以使用以下断言来测试响应正文中是否存在特定元素/文本等。

assertSee(string $search = null, string $element = null)

断言文本/HTML 存在于页面上,无论是自身存在还是更具体地说是存在于由类型、类或 id 指定的标记内:

<?php

// Check that "Hello World" is on the page
$result->assertSee('Hello World');
// Check that "Hello World" is within an h1 tag
$result->assertSee('Hello World', 'h1');
// Check that "Hello World" is within an element with the "notice" class
$result->assertSee('Hello World', '.notice');
// Check that "Hello World" is within an element with id of "title"
$result->assertSee('Hello World', '#title');

assertDontSee(string $search = null, string $element = null)

与 assertSee() 方法完全相反:

<?php

// Checks that "Hello World" does NOT exist on the page
$results->dontSee('Hello World');
// Checks that "Hello World" does NOT exist within any h1 tag
$results->dontSee('Hello World', 'h1');

assertSeeElement(string $search)

类似于 assertSee(),但是这只检查存在的元素。它不检查特定文本:

<?php

// Check that an element with class 'notice' exists
$results->seeElement('.notice');
// Check that an element with id 'title' exists
$results->seeElement('#title');

assertDontSeeElement(string $search)

类似于 assertSee(),但是这只检查缺失的现有元素。它不检查特定文本:

<?php

// Verify that an element with id 'title' does NOT exist
$results->dontSeeElement('#title');

assertSeeLink(string $text, string $details = null)

断言找到一个锚定标签,其标签体匹配 $text:

<?php

// Check that a link exists with 'Upgrade Account' as the text::
$results->seeLink('Upgrade Account');
// Check that a link exists with 'Upgrade Account' as the text, AND a class of 'upsell'
$results->seeLink('Upgrade Account', '.upsell');

assertSeeInField(string $field, string $value = null)

断言存在具有给定名称和值的输入标签:

<?php

// Check that an input exists named 'user' with the value 'John Snow'
$results->assertSeeInField('user', 'John Snow');
// Check a multi-dimensional input
$results->assertSeeInField('user[name]', 'John Snow');

使用 JSON 

响应通常会包含 JSON 响应,特别是在使用 API 方法时。以下方法可以帮助测试响应。

getJSON()

此方法将以 JSON 字符串的形式返回响应正文:

<?php

/*
 * Response body is this:
 * ['foo' => 'bar']
 */

$json = $result->getJSON();
/*
 * $json is this:
 * {
 *     "foo": "bar"
 * }
`*/

你可以使用此方法来确定 $response 是否确实包含 JSON 内容:

<?php

// Verify the response is JSON
$this->assertTrue($result->getJSON() !== false);

备注

请注意结果中的 JSON 字符串将美化打印。

assertJSONFragment(array $fragment)

断言 $fragment 在 JSON 响应中找到。它不需要匹配整个 JSON 值。

<?php

/*
 * Response body is this:
 * [
 *     'config' => ['key-a', 'key-b'],
 * ]
 */

// Is true
$result->assertJSONFragment(['config' => ['key-a']]);

assertJSONExact($test)

与 assertJSONFragment() 类似,但检查整个 JSON 响应以确保完全匹配。

使用 XML 

getXML()

如果应用程序返回 XML,则可以通过此方法检索它。