codeception在YII2中的使用

codeception是一款PHP的行为测试工具，能自动化进行单元测试、功能测试、验收测试等。

官网：http://codeception.com/

Yii2框架已经默认集成了codeception，可以直接使用，否则需要安装。安装过程见官方。

看一下高级版的frontend的tests目录结构：

image.png

默认已经集成了验收测试、功能测试、单元测试模块，研究里面的代码可以基本满足上述三项测试的要求。如果有更高级的需求，可以研究官方的文档。目前项目内写了API测试，下面主要讨论一下API测试的实现。

以下操作在windows环境，linux环境可能命令有所不用

首先修改common/config/test-local.php文件，修改数据库配置，test环境使用单独的数据库。（使用Fixture时默认会清空数据表，如果不切换非常危险。以身试法！）

配置完成后，可以运行一遍框架默认的测试看看效果：

cd E:\code\yii2-advanced\frontend
E:\code\yii2-advanced\vendor\bin\codecept build
E:\code\yii2-advanced\vendor\bin\codecept run

image.png

OK

下面新建一个APITester

官方参照文档：http://codeception.com/for/yii

以下命令在项目frontend目录下执行，生成的文件写入frontend/test中

运行下面的命令新建一个apiTester，系统会新建部分文件
E:\code\yii2-advanced\vendor\bin\codecept generate:suite api  //新建模块
E:\code\yii2-advanced\vendor\bin\codecept generate:cest api TestCest   //新建测试方法控制器。注意cest和cept的区别，前者是多个，后者是单个

image.png

修改api.suite.yml配置文件

actor: ApiTester
modules:
    enabled:
        - REST:
            url: /api/v1
            depends: Yii2
        - \frontend\tests\Helper\Api
        - Yii2:
            transaction: false   //如果测试的接口中有数据库事务操作，这个必须设置为false，否则会报错

运行一下build生成所需文件

E:\code\yii2-advanced\vendor\bin\codecept build

测试代码写在TestCest.php文件中，分析一个例子：

namespace frontend\tests;

use common\fixtures\VoteFixture;
use Codeception\Util\HttpCode;

class PostCest
{
    public function _before(ApiTester $I)
    {
        $I->haveFixtures([  //预加载user表数据
            'user' => [
                'class' => UserFixture::className(),
                'dataFile' => codecept_data_dir() . 'user.php',
            ],
        ]);
    }

    public function _after(ApiTester $I)
    {
    }
public function voteCancel(ApiTester $I)
{
    $I->wantToTest('post/vote cancel success');   //运行提示语
    $I->haveFixtures([    //加载Fixtures
        'vote' => [
            'class' => VoteFixture::className(),
            'dataFile' => codecept_data_dir() . 'vote.php',  //数据表载入数据
        ]
    ]);
    $I->withAuthHeader();  //自定义的方法，写在生成的_support/ApiTester文件中。
    $I->sendPOST('/post/vote', ['post_id' => 1]);  //发送带参数请求
    $I->seeResponseCodeIs(HttpCode::OK);   //返回200
    $I->seeResponseIsJson();  //返回时json格式
    $I->seeResponseContains('"code":200');  //返回的结果中包含内容
}

Fixture：测试夹工具，基本写法：

namespace common\fixtures;

use yii\test\ActiveFixture;

class VoteFixture extends ActiveFixture   //继承ActiveFixture类
{
    public $modelClass = 'common\models\Vote';    //使用数据表模型
}

前面提到的使用Fixture过后默认有清表操作，需要注意

数据文件在tests/_data文件夹中，格式为二维数组返回