Yii2中如何使用CodeCeption

Yii2和CodeCeption

CodeCeption是一個全棧的PHP測試框架，關於CodeCeption的介紹見：CodeCeption官方文檔。

Yii2官方增加了對CodeCeption的支持，這里主要講解Yii2里如何基於CodeCeption進行單元測試和功能測試。

知識准備

• Composer基礎：Composer官方文檔
• CodeCeption基礎：CodeCeption官方文檔
• Yii2-app-basic中的CodeCeption例子：yii2-app-basic
• Yii2-app-basic項目的地址：https://github.com/yiisoft/yii2-app-basic

執行后面操作的前提是本地已經正確安裝配置composer。

通過腳手架開始一個Yii2項目

通過Composer，我們可以很簡單的在本地基於腳手架創建一個Yii2項目：

• 進入一個可以通過web服務器訪問的目錄：cd <webroot>
• 執行：composer global require "fxp/composer-asset-plugin:~1.0.0" 命令驗證必須插件是否全局安裝
• 執行：composer create-project yiisoft/yii2-app-basic basic 命令在當前目錄的basic目錄創建一個”yiisoft/yii2-app/basic”腳手架項目。注意，如果是本地開發環境，你也可以增加--prefer-dist --stability=dev選項，參考stability選項，這樣，composer會到github上拉取最新的開發包下來。

通過以上操作，你的本地目錄應該大致如下：

webroot/basic
    |--- assets/
    |--- commands/
    |--- config/
    |--- controllers/
    |--- mail/
    |--- models/
    |--- runtime/
    |--- tests/
    |--- vendor/
    |--- views/
    |--- web/
    |--- .gitignore
    |--- composer.json
    |--- composer.lock
    ...

 

其中，tests就是框架默認創建的測試代碼目錄，里面有框架提供的一些測試的例子，你可以按如下步驟測試一下：

• cd basic/tests/ 進入CodeCeption測試用例所在目錄
• codecept build 將構建測試用例（根據cept生成tester）
• codecept run 運行測試用例

如果你終端提示codecept命令未知，請執行以下命令安裝codeception擴展：

composer global require "codeception/codeception=2.0.*"
composer global require "codeception/specify=*"
composer global require "codeception/verify=*"
composer require --dev yiisoft/yii2-faker:*

 

正常安裝后，再執行codecept run時，如果看到類似如下的報錯：

1) Failed to ensure that about works in [1mAboutCept[22m (D:\php\basic\tests\codeception\acceptance\AboutCept.php)
Can't be on page "/index-test.php?r=site%2Fabout":
GuzzleHttp\Exception\ConnectException: cURL error 7: Failed to connect to localhost port 8080: Connection refused

提示在xx端口連接拒絕，這里，我們需要修改一下配置文件:

• 修改basic/tests/codeception.yml里面的config/test_entry_url配置，為你實際的項目入口地址
• 修改basic/tests/codeception/acceptance.suite.yml里面的modules/config/PhpBrowser配置為你實際的地址

完成后，再執行codecept run，你應該可以看到終端沒有報錯了。

我們來看看tests目錄的結構：

webroot/basic/tests
    |--- codeception/
    |        |--- _output/
    |        |--- _pages/
    |        |--- acceptance/
    |        |--- bin/
    |        |--- config/
    |        |--- fixtures/
    |        |--- functional/
    |        |--- templates/
    |        |--- unit
    |        |--- _bootstrap.php
    |        |--- acceptance.suite.yml
    |        |--- functional.suite.yml
    |        |--- unit.suite.yml
    |--- codeception.yml

 

其實，這里acceptance、functional、unit是Yii2默認為我們創建的三個suite，顧名思義，分別用於驗收，功能，單元測試。

而執行codecept run時，會依次將codeception目錄的所有suite運行，故，你可以通過codecept run suitename的方式制定執行某個suite；同理，可以執行codecept run suitename testname的方式執行某個test。

你可以仿照functional，unit，acceptance里面的例子寫你自己的測試用例。

注：通過腳手架創建的Yii2項目會自動增加gitignore，將vendor中的內容從版本庫中忽略，如果你需要提交，請手動修改gitignore文件。

從已有的Yii2項目開始CodeCeption

對於一個已有的Yii2項目，我們需要遵循如下幾步來配置CodeCeption。

• 在項目根目錄執行composer init來初始化composer。
• 執行如下指令確保codeception的擴展包已經全局安裝
  • composer global require "codeception/codeception=2.0.*"
  • composer global require "codeception/specify=*"
  • composer global require "codeception/verify=*"
  • composer require --dev yiisoft/yii2-faker:*
• 在項目合適的目錄創建一個codeception目錄作為codeception的測試代碼目錄
• 進入codeception目錄，執行codecept bootstrap來初始化生成測試代碼腳手架。
• 仿照yii2-app-basic，修改codeception.yml
• 仿照yii2-app-basic，修改codeception/tests/_bootstrap.php文件
• 仿照yii2-app-basic，修改codeception/tests/*.suite.yml
• 增加一個codeception/tests/config目錄，以存儲配置文件。仿照yii2-app-basic的形式增加config.php,common.php

具體的配置內容依實際情況而定，具體可以參考yii2-app-basic提供的例子。

附：如何基於yii2-app-basic按照module來組織項目代碼

前面所述，通過腳手架創建yii2-app-basic開發環境后，我們的代碼目錄結構為：

webroot/basic
    |--- assets/
    |--- commands/
    |--- config/
    |--- controllers/
    |--- mail/
    |--- models/
    |--- runtime/
    |--- tests/
    |--- vendor/
    |--- views/
    |--- web/
    |--- .gitignore
    |--- composer.json
    |--- composer.lock
    ...

 

這個結構是Yii2默認創建的目錄，我們可以看到它並沒有安裝module進行划分。我們可以對其進行調整：

• 新建一個modules目錄，假設默認的module為demo
• 在modules目錄下面新建demo目錄作為demo模塊代碼存放目錄
• 將上面的controllers，models，views三個目錄移到demo目錄下面
• 在demo目錄下新建一個Module.php，新建一個類繼承自[[\yii\base\Module]],代碼見后。
• 在config目錄下面增加一個modules.php，增加對demo目錄的配置
• 修改web.php，增加對modules.php的引用
• 修改index.php，增加@modules的別名
• 對應調整modules/demo/里面的namespace

按照以上步驟調整后的路徑如下：

webroot/basic
    |--- assets/
    |--- commands/
    |--- config/
    |--- modules/
    |        |--- demo/
    |        |        |--- controllers/
    |        |        |--- views/
    |        |        |--- models/
    |        |--- ...
    |--- mail/
    |--- runtime/
    |--- tests/
    |--- vendor/
    |--- web/
    |--- .gitignore
    |--- composer.json
    |--- composer.lock
    ...

 

各文件的內容如下：

basic/modules/demo/Module.php

<?php
 /**
  * Module.php
  *
  * @author        fangliang
  * @create_time       2015-06-16
  */

namespace modules\demo;


class Module extends \yii\base\Module
{
    public $layout = "main";
    public $controllerNamespace = 'modules\demo\controllers';

    public function init()
    {
        parent::init();
        //do something init here
    }
} 

 

basic/web/index.php

<?php

// comment out the following two lines when deployed to production
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'dev');

require(__DIR__ . '/../vendor/autoload.php');
require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');

$config = require(__DIR__ . '/../config/web.php');

Yii::setAlias("@modules",dirname(__DIR__) .'/modules' );

(new yii\web\Application($config))->run();

 

basic/config/web.php

<?php

$params = require(__DIR__ . '/params.php');

$config = [
    'id' => 'basic',
    'basePath' => dirname(__DIR__),
    'bootstrap' => ['log'],
    'components' => [
        'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
            'cookieValidationKey' => '0_wkmOLxql9rlIaqjYNPFL3pYDfLNuLk',
        ],
        'cache' => [
            'class' => 'yii\caching\FileCache',
        ],
        'user' => [
            'identityClass' => 'modules\demo\models\User',
            'enableAutoLogin' => true,
        ],
        'errorHandler' => [
            'errorAction' => 'demo/site/error',
        ],
        'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            'useFileTransport' => true,
        ],
        'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
                [
                    'class' => 'yii\log\FileTarget',
                    'levels' => ['error', 'warning'],
                ],
            ],
        ],
        'db' => require(__DIR__ . '/db.php'),
    ],
    'params' => $params,
    'modules'=> require(__DIR__.'/modules.php'),
];

if (YII_ENV_DEV) {
    // configuration adjustments for 'dev' environment
    $config['bootstrap'][] = 'debug';
    $config['modules']['debug'] = 'yii\debug\Module';

    $config['bootstrap'][] = 'gii';
    $config['modules']['gii'] = 'yii\gii\Module';
}

return $config;

 

basic/config/modules.php

<?php

return [
    'demo' =>[
        'class'=>'modules\demo\Module',
    ]
];

 

在完成以上的配置后，基本的配置就完成了。

如果是一個全新的項目，你可以直接fork我的這個腳手架：Yii2模塊化Web應用腳手架。

文章來源摘自：http://hustnaive.github.io/php/2015/06/16/work-with-yii-and-codeception.html