单元测试使用记录

什么是单元测试

简单来说就是对一个类中的方法进行测试，对输出的结果检查判断是否符合预期结果

但是在多年的工作中，从来没有哪个项目中真正系统的用到了单元测试，因此对它还是很陌生的，也就造成更加不会在项目中区使用它。

如何使用

以前不使用单元单元测试，是因为觉得没有必要：既然单元测试是对方法输入不同参数，然后对输出进行判断。那么方法本身也必定已经对不同参数进行过判断和不同处理，才会有不同的输出，那么在单元测试代码中再进行一次参数判断，不是重复劳动吗，这么做有什么意义呢？

经过学习后才明白，之所以有上面的错误理解，是弄错了单元测试代码的编写时机和方式。

首先，单元测试代码是在被测试类和方法建立之前就要先建立的。之后，根据单元测试代码去建立被测试类，一步步编写被测试方法。方法中每实现一个测试，就运行对应的测试方法验证，直到所有的测试方法都被验证通过，方法就完成了。这就是所谓的：测试驱动开发。

其次，单元测试中，对与一个方法的测试并不是放在一个测试方法中的，每个测试方法只对一组参数的返回结果进行断言。
比如，当被测试方法中有5条执行路径时，就有5个对应的测试方法。测试方法的名称根据要断言的路径不同命名，这就是所谓的：单元测试可以作为代码文档使用

理解了上面的概念后，就等于掌握了单元测试的核心思想。

接口测试、功能测试、验收测试

使用单元测试时，我们一般会使用相应的框架。框架中除了单元测试外，一般还包含接口测试、功能测试、验收测试等功能。这些测试的使用思想和单元测试是一致的，只不过是测试对象有所不同。

接口测试，是使用框架中组件，模拟浏览器行为，请求接口的url地址，对返回结果进行断言

功能测试，是使用框架中组件，模拟浏览器行为，对某个前端页面进行点击，并对跳转和返回结果进行断言。

验收测试，是调用真实的浏览器内核，对某个前端页面进行点击，并对跳转和返回结果进行断言。

目前来说功能测试和验收测试对后端程序员不再适用。
因为现在应用基本都是前后端分离，后端只需要做好接口测试即可

codeception 在yii2中的基本使用

目录结构和生成

yii2框架安装后，vender下已经包含了codeception包，并且在项目根目录中也已经生成了单元测试目录和相关配置文件。tests目录是单元测试的相关文件，codeception.yml文件是单元测试的配置文件。

如果是在其他项目或框架中没有自带codeception组件，则需要通过composer安装。
安装后，在vender的bin目录下会出现codeception的命令行文件，如下
在这里插入图片描述
需要在环境变量中把该文件所属的目录添加上，方便之后在命令行全局使用codecept命令，
之后我们在命令行定位到想要放置单元测试文件的目录，执行如下命令，就会单元测试的文件和目

codecept bootstrap

在这里插入图片描述
默认情况下，只会生成单元测试、功能测试、验收测试的套件；接口测试套件需要我们单独执行命令生成，如下

codecept generate:suite api

在这里插入图片描述

基本命令使用

通过命令行执行单元测试时，首先要定位到codeception.yml文件所属目录。因为codecepti命令会默认调用当前目录下的codeception.yml

执行所有测试

codecept run

执行所有单元测试

Codecept run unit

执行指定测试文件

Codecept run tests/unit/TestOrder.php

基本配置选项

在这里插入图片描述
当使用了框架时，bootstrap 指定就指定框架的起始文件。以Yii2为了，_bootstrap.php文件就是加载框架的核心组件和自动加载文件等，如下

Moudel中的相关配置，可以根据开启的模块，去查看具体的配置项
在这里插入图片描述
我们可以在该目录下看到支持的所有模块，打开文件后就可以在注释中看到该模块的相关配置项

多模块测试

当我们的项目较大时，我们可能需要把单元测试分模块放置，目录结构如下
在这里插入图片描述

当我们想执行某个模块下的单元测试时，可以比较方便的实现。
当时当我们想在project目录下，执行所有module下的单元测试时该如何实现呢？

我们只需要在project目录下的codeception.yml文件中添加include配置项，如下
在这里插入图片描述
配置完成后，再project目录下，执行：codecept run unit
就会自动查找并执行三个module下的单元测试

常用单元测试断言

常规断言

assertEquals($expected, $actual[, $message ]) 检查两个变量是否相等。

assertNotEquals($expected, $actual[, $message]) 检查两个变量是否不相等。

assertTrue($condition[, $message = ‘’]) 检查条件是否为 true。

assertFalse($condition[, $message = ‘’]) 检查条件是否为 false。

assertEmpty($actual[, $message = ‘’]) 检查变量是否为空。

assertNotEmpty($actual[, $message = ‘’]) 检查变量是否非空。

assertNull($actual[, $message = ‘’]) 检查变量是否为 null。

assertNotNull($actual[, $message = ‘’]) 检查变量是否不为 null。

assertGreaterThan($expected, $actual[, $message = ‘’]) 检查实际值是否大于预期值。

assertGreaterThanOrEqual($expected, $actual[, $message = ‘’]) 检查实际值是否大于或等于预期值。

assertLessThan($expected, $actual[, $message = ‘’]) 检查实际值是否小于预期值。

assertLessThanOrEqual($expected, $actual[, $message = ‘’]) 检查实际值是否小于或等于预期值。

类型和结构的断言

assertInstanceOf($expected, $actual[, $message = ‘’]) 检查对象是否是某个类的实例

assertNotInstanceOf($expected, $actual[, $message = ‘’]) 检查对象是否不是某个类的实例

assertArrayHasKey($key, $array[, $message = ‘’]) 检查数组是否有指定的键。

assertArrayNotHasKey($key, $array[, $message = ‘’]) 检查数组是否没有指定的键。

assertContains($needle, $haystack[, $message = ‘’]) 检查数组或字符串中是否含有某个值。

assertNotContains($needle, $haystack[, $message = ‘’]) 检查数组或字符串中是否不含有某个值。

assertCount($expectedCount, $haystack[, $message = ‘’]) 检查数组或 Countable 对象中元素的个数。

assertNotCount($expectedCount, $haystack[, $message = ‘’]) 检查数组或 Countable 对象中元素的个数是否不符合预期。

文件和目录的断言

assertFileExists($filename[, $message = ‘’]) 检查文件或目录是否存在。

assertFileNotExists($filename[, $message = ‘’]) 检查文件或目录是否不存在。

assertFileEquals($expected, $actual[, $message = ‘’]) 检查两个文件的内容是否相等。

assertFileNotEquals($expected, $actual[, $message = ‘’]) 检查两个文件的内容是否不相等。
异常的断言

expectException($exception) 预期代码会抛出某个异常。

expectExceptionMessage($message) 预期抛出的异常会包含某个特定的消息。

expectExceptionCode($code) 预期抛出的异常会含有特定的代码

常用接口测试方法

发送 HTTP 请求

sendGET($url, $params = []) 发送一个 GET 请求到指定的 URL，并可以附加查询参数。

sendPOST($url, $params = [], $files = []) 发送一个 POST 请求到指定的 URL，可以附加表单数据和文件。

sendPUT($url, $params = [], $files = []) 发送一个 PUT 请求到指定的 URL，可以附加表单数据和文件。

sendDELETE($url, $params = [], $files = []) 发送一个 DELETE 请求到指定的 URL，可以附加表单数据和文件。

sendPATCH($url, $params = [], $files = []) 发送一个 PATCH 请求到指定的 URL，可以附加表单数据和文件。

sendOPTIONS($url, $params = [], $files = []) 发送一个 OPTIONS 请求到指定的 URL，可以附加表单数据和文件。

sendHEAD($url, $params = [], $files = []) 发送一个 HEAD 请求到指定的 URL，可以附加表单数据和文件。

验证响应

seeResponseCodeIs($code) 验证最后一个响应的 HTTP 状态码是否为指定的 $code。

seeResponseIsJson() 验证最后一个响应是否是有效的 JSON 格式。

seeResponseContainsJson($json = []) 检查最后一个响应中是否包含特定的 JSON 结构。

seeResponseEquals($response) 检查最后一个响应内容是否完全等于指定的字符串。

seeResponseContains($text) 检查最后一个响应内容是否包含指定的文本。

dontSeeResponseContains($text) 检查最后一个响应内容是否不包含指定的文本。

seeResponseJsonMatchesXpath($xpath) 使用 XPath 查询检查最后一个 JSON 响应。

seeResponseJsonMatchesJsonPath($jsonPath) 使用 JSONPath 查询检查最后一个 JSON 响应。

seeResponseMatchesJsonType($type, $jsonPath = null) 检查最后一个响应是否匹配指定的 JSON 类型。

设置和验证 Header

haveHttpHeader($name, $value) 设置请求的 HTTP 头部。

seeHttpHeader($name, $value) 检查响应的 HTTP 头部是否存在并且等于特定的值。

dontSeeHttpHeader($name) 检查响应的 HTTP 头部是否不存在。

seeHttpHeaderOnce($name) 检查响应的 HTTP 头部是否只出现一次。

seeHttpHeaderContains($name, $value) 检查响应的 HTTP 头部是否包含特定的值。

验证 Cookies

seeCookie($name) 检查 Cookie 是否存在。

dontSeeCookie($name) 检查 Cookie 是否不存在。

seeCookieEquals($name, $value) 检查 Cookie 的值是否等于指定的值。

seeCookieMatches($pattern, $name) 检查 Cookie 的值是否符合指定的正则表达式。

数据库操作

seeInDatabase($table, $criteria = []) 检查数据库中的表是否包含匹配指定条件的记录。

dontSeeInDatabase($table, $criteria = []) 检查数据库中的表是否不包含匹配指定条件的记录。

grabFromDatabase($table, $column, $criteria = []) 从数据库中抓取记录，并返回指定列的值。

授权操作

amBearerAuthenticated($token) 在请求中添加一个 Bearer 认证头部。

amHttpAuthenticated($username, $password) 在请求中添加基本 HTTP 认证的头部。