Commit 8621949f by Carsten Brandt

cleanup and re-aranged codeception tests for basic app

follow up to PR #1393
parent 57277f74
......@@ -10,7 +10,7 @@ namespace app\commands;
use yii\console\Controller;
/**
* This command echoes what the first argument that you have entered.
* This command echoes the first argument that you have entered.
*
* This command is provided as an example for you to learn how to create console commands.
*
......
......@@ -16,11 +16,11 @@
"require": {
"php": ">=5.4.0",
"yiisoft/yii2": "*",
"yiisoft/yii2-swiftmailer": "*",
"yiisoft/yii2-bootstrap": "*",
"yiisoft/yii2-codeception": "*",
"yiisoft/yii2-debug": "*",
"yiisoft/yii2-gii": "*"
"yiisoft/yii2-gii": "*",
"yiisoft/yii2-swiftmailer": "*"
},
"scripts": {
"post-create-project-cmd": [
......
<?php
// configuration adjustments for codeception acceptance tests. Will be merged with web.php config.
return [
'components' => [
'db' => [
......
<?php
// configuration adjustments for codeception functional tests. Will be merged with web.php config.
return [
'components' => [
'db' => [
......
<?php
// configuration adjustments for codeception unit tests. Will be merged with web.php config.
return [
'components' => [
'fixture' => [
'class' => 'yii\test\DbFixtureManager',
'basePath' => '@app/tests/unit/fixtures',
'basePath' => '@tests/unit/fixtures',
],
'db' => [
'dsn' => 'mysql:host=localhost;dbname=yii2basic_unit',
......
<?php
Yii::setAlias('tests', realpath(__DIR__ . '/../tests'));
$config = require(__DIR__ . '/web.php');
// ... customize $config for the "test" environment here...
return $config;
<?php
Yii::setAlias('tests', realpath(__DIR__ . '/../tests'));
$params = require(__DIR__ . '/params.php');
$config = [
......@@ -41,10 +39,20 @@ $config = [
'params' => $params,
];
if (YII_ENV_DEV) {
if (YII_ENV_DEV)
{
// configuration adjustments for 'dev' environment
$config['preload'][] = 'debug';
$config['modules']['debug'] = 'yii\debug\Module';
$config['modules']['gii'] = 'yii\gii\Module';
}
if (YII_ENV_TEST)
{
// configuration adjustments for 'test' environment.
// configuration for codeception test environments can be found in codeception folder.
// if needed, customize $config here.
}
return $config;
......@@ -3,18 +3,26 @@ These tests are developed with [Codeception PHP Testing Framework](http://codece
To run the tests, follow these steps:
1. [Install Codeception](http://codeception.com/quickstart) if you do not have it yet.
2. Create test configuration files based on your environment:
- Copy `acceptance.suite.dist.yml` to `acceptance.suite.yml` and customize it;
- Copy `functional.suite.dist.yml` to `functional.suite.yml` and customize it;
- Copy `unit.suite.dist.yml` to `unit.suite.yml` and customize it.
3. Switch to the parent folder and run tests:
```
cd ..
php codecept.phar build // rebuild test scripts, only need to be run once
php codecept.phar run // run all available tests
```
1. Download Codeception([Quickstart step 1](http://codeception.com/quickstart)) and put the codeception.phar in the
application base directory (not in this `tests` directory!).
2. Adjust the test configuration files based on your environment:
- Configure the URL for [acceptance tests](http://codeception.com/docs/04-AcceptanceTests) in `acceptance.suite.yml`.
The URL should point to the `index-test-acceptance.php` file that is located under the `web` directory of the application.
- `functional.suite.yml` for [functional testing](http://codeception.com/docs/05-FunctionalTests) and
`unit.suite.yml` for [unit testing](http://codeception.com/docs/06-UnitTests) should already work out of the box
and should not need to be adjusted.
3. Go to the application base directory and build the test suites:
```
php codecept.phar build // rebuild test scripts, only need to be run once
```
4. Run the tests:
```
php codecept.phar run // run all available tests
// you can also run a test suite alone:
php codecept.phar run acceptance
php codecept.phar run functional
php codecept.phar run unit
```
Please refer to [Codeception tutorial](http://codeception.com/docs/01-Introduction) for
more details about writing acceptance, functional and unit tests.
<?php
require_once(__DIR__.'/yii_bootstrap.php');
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'test');
require_once(__DIR__ . '/../vendor/autoload.php');
require_once(__DIR__ . '/../vendor/yiisoft/yii2/yii/Yii.php');
Yii::setAlias('@tests', __DIR__);
<?php
namespace Codeception\Module;
// here you can define custom functions for CodeGuy
class CodeHelper extends \Codeception\Module
{
// here you can define custom methods for CodeGuy
}
<?php
namespace Codeception\Module;
// here you can define custom functions for TestGuy
class TestHelper extends \Codeception\Module
{
// here you can define custom methods for TestGuy
}
<?php
namespace Codeception\Module;
// here you can define custom functions for WebGuy
class WebHelper extends \Codeception\Module
{
// here you can define custom methods for WebGuy
}
......@@ -2,9 +2,9 @@
namespace tests\_pages;
class AboutPage extends \yii\codeception\BasePage
{
use yii\codeception\BasePage;
class AboutPage extends BasePage
{
public static $URL = '?r=site/about';
}
\ No newline at end of file
......@@ -2,9 +2,10 @@
namespace tests\_pages;
class ContactPage extends \yii\codeception\BasePage
{
use yii\codeception\BasePage;
class ContactPage extends BasePage
{
public static $URL = '?r=site/contact';
/**
......@@ -12,31 +13,26 @@ class ContactPage extends \yii\codeception\BasePage
* @var string
*/
public $name = 'input[name="ContactForm[name]"]';
/**
* contact form email text field locator
* @var string
*/
public $email = 'input[name="ContactForm[email]"]';
/**
* contact form subject text field locator
* @var string
*/
public $subject = 'input[name="ContactForm[subject]"]';
/**
* contact form body textarea locator
* @var string
*/
public $body = 'textarea[name="ContactForm[body]"]';
/**
* contact form verification code text field locator
* @var string
*/
public $verifyCode = 'input[name="ContactForm[verifyCode]"]';
/**
* contact form submit button
* @var string
......@@ -51,13 +47,12 @@ class ContactPage extends \yii\codeception\BasePage
{
if (!empty($contactData))
{
$this->guy->fillField($this->name,$contactData['name']);
$this->guy->fillField($this->email,$contactData['email']);
$this->guy->fillField($this->subject,$contactData['subject']);
$this->guy->fillField($this->body,$contactData['body']);
$this->guy->fillField($this->verifyCode,$contactData['verifyCode']);
$this->guy->fillField($this->name, $contactData['name']);
$this->guy->fillField($this->email, $contactData['email']);
$this->guy->fillField($this->subject, $contactData['subject']);
$this->guy->fillField($this->body, $contactData['body']);
$this->guy->fillField($this->verifyCode, $contactData['verifyCode']);
}
$this->guy->click($this->button);
}
}
......@@ -2,9 +2,10 @@
namespace tests\_pages;
class LoginPage extends \yii\codeception\BasePage
{
use yii\codeception\BasePage;
class LoginPage extends BasePage
{
public static $URL = '?r=site/login';
/**
......@@ -12,13 +13,11 @@ class LoginPage extends \yii\codeception\BasePage
* @var string
*/
public $username = 'input[name="LoginForm[username]"]';
/**
* login form password text field locator
* @var string
*/
public $password = 'input[name="LoginForm[password]"]';
/**
* login form submit button locator
* @var string
......@@ -32,9 +31,8 @@ class LoginPage extends \yii\codeception\BasePage
*/
public function login($username, $password)
{
$this->guy->fillField($this->username,$username);
$this->guy->fillField($this->password,$password);
$this->guy->fillField($this->username, $username);
$this->guy->fillField($this->password, $password);
$this->guy->click($this->button);
}
}
......@@ -12,8 +12,13 @@ class_name: WebGuy
modules:
enabled:
- WebHelper
- WebDriver
- PhpBrowser
# you can use WebDriver instead of PhpBrowser to test javascript and ajax.
# This will require you to install selenium. See http://codeception.com/docs/04-AcceptanceTests#Selenium
# - WebDriver
config:
WebDriver:
url: 'http://localhost/basic/web/index-test-accept.php'
browser: firefox
PhpBrowser:
url: 'http://localhost/basic-app/web/index-test-acceptance.php'
# WebDriver:
# url: 'http://localhost/basic-app/web/index-test-acceptance.php'
# browser: firefox
<?php
use tests\_pages\AboutPage;
$I = new WebGuy($scenario);
......
<?php
use tests\_pages\ContactPage;
$I = new WebGuy($scenario);
......
<?php
$I = new WebGuy($scenario);
$I->wantTo('ensure that home page works');
$I->amOnPage('');
......
<?php
use tests\_pages\LoginPage;
$I = new WebGuy($scenario);
......
This source diff could not be displayed because it is too large. You can view the blob instead.
<?php
// Here you can initialize variables that will for your tests
$config = require(__DIR__.'/../yii_bootstrap.php');
$config = yii\helpers\ArrayHelper::merge(
$config,
require(__DIR__ . '/../../config/web.php'),
require(__DIR__ . '/../../config/codeception/acceptance.php')
);
......
......@@ -5,11 +5,14 @@
# (tip: better to use with frameworks).
# RUN `build` COMMAND AFTER ADDING/REMOVING MODULES.
#basic/web/index-test-func.php
#basic/web/index.php
class_name: TestGuy
modules:
enabled: [Filesystem, TestHelper, Yii2]
enabled:
- Filesystem
- TestHelper
- Yii2
config:
Yii2:
entryScript: 'web/index-test-func.php'
entryScript: 'web/index-test-functional.php'
url: 'http://localhost/'
<?php
use tests\functional\_pages\ContactPage;
$I = new TestGuy($scenario);
......
<?php
$I = new TestGuy($scenario);
$I->wantTo('ensure that home page works');
$I->amOnPage('');
......
<?php
use tests\functional\_pages\LoginPage;
$I = new TestGuy($scenario);
......
......@@ -1698,8 +1698,8 @@ class TestGuy extends \Codeception\AbstractGuy
*
* ``` php
* <?php
* $I->sendAjaxPostRequest('/updateSettings', array('notifications' => true); // POST
* $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true); // GET
* $I->sendAjaxPostRequest('/updateSettings', array('notifications' => true)); // POST
* $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true)); // GET
*
* ```
*
......@@ -1723,6 +1723,40 @@ class TestGuy extends \Codeception\AbstractGuy
* Documentation taken from corresponding module.
* ----------------------------------------------
*
* If your page triggers an ajax request, you can perform it manually.
* This action sends an ajax request with specified method and params.
*
* Example:
*
* You need to perform an ajax request specifying the HTTP method.
*
* ``` php
* <?php
* $I->sendAjaxRequest('PUT', /posts/7', array('title' => 'new title');
*
* ```
*
* @param $method
* @param $uri
* @param $params
* @see Codeception\Util\Framework::sendAjaxRequest()
* @return \Codeception\Maybe
*/
public function sendAjaxRequest($method, $uri, $params = null) {
$this->scenario->addStep(new \Codeception\Step\Action('sendAjaxRequest', func_get_args()));
if ($this->scenario->running()) {
$result = $this->scenario->runStep();
return new Maybe($result);
}
return new Maybe();
}
/**
* This method is generated.
* Documentation taken from corresponding module.
* ----------------------------------------------
*
* Finds and returns text contents of element.
* Element is searched by CSS selector, XPath or matcher by regex.
*
......
<?php
$config = require(__DIR__.'/../yii_bootstrap.php');
$config = yii\helpers\ArrayHelper::merge(
$config,
require(__DIR__ . '/../../config/web.php'),
require(__DIR__ . '/../../config/codeception/functional.php')
);
......
......@@ -4,31 +4,26 @@ namespace tests\functional\_pages;
class ContactPage extends \tests\_pages\ContactPage
{
/**
* contact form name text field locator
* @var string
*/
public $name = 'ContactForm[name]';
/**
* contact form email text field locator
* @var string
*/
public $email = 'ContactForm[email]';
/**
* contact form subject text field locator
* @var string
*/
public $subject = 'ContactForm[subject]';
/**
* contact form body textarea locator
* @var string
*/
public $body = 'ContactForm[body]';
/**
* contact form verification code text field locator
* @var string
......@@ -41,10 +36,10 @@ class ContactPage extends \tests\_pages\ContactPage
*/
public function submit(array $contactData)
{
if (empty($contactData))
$this->guy->submitForm('#contact-form',[]);
else
$this->guy->submitForm('#contact-form',[
if (empty($contactData)) {
$this->guy->submitForm('#contact-form', []);
} else {
$this->guy->submitForm('#contact-form', [
$this->name => $contactData['name'],
$this->email => $contactData['email'],
$this->subject => $contactData['subject'],
......@@ -52,5 +47,5 @@ class ContactPage extends \tests\_pages\ContactPage
$this->verifyCode => $contactData['verifyCode'],
]);
}
}
}
......@@ -4,13 +4,11 @@ namespace tests\functional\_pages;
class LoginPage extends \tests\_pages\LoginPage
{
/**
* login form username text field locator
* @var string
*/
public $username = 'LoginForm[username]';
/**
* login form password text field locator
* @var string
......@@ -24,10 +22,9 @@ class LoginPage extends \tests\_pages\LoginPage
*/
public function login($username, $password)
{
$this->guy->submitForm('#login-form',[
$this->guy->submitForm('#login-form', [
$this->username => $username,
$this->password => $password,
]);
}
}
<?php
$config = require(__DIR__.'/../yii_bootstrap.php');
return yii\helpers\ArrayHelper::merge(
$config,
require(__DIR__ . '/../../config/codeception/unit.php')
);
// add unit testing specific bootstrap code here
\ No newline at end of file
......@@ -2,7 +2,9 @@
namespace tests\unit\models;
class ContactFormTest extends \yii\codeception\TestCase
{
use yii\codeception\TestCase;
class ContactFormTest extends TestCase
{
// TODO add test methods here
}
......@@ -2,7 +2,9 @@
namespace tests\unit\models;
class LoginFormTest extends \yii\codeception\TestCase
{
use yii\codeception\TestCase;
class LoginFormTest extends TestCase
{
// TODO add test methods here
}
\ No newline at end of file
......@@ -2,24 +2,19 @@
namespace tests\unit\models;
#use yii\test\DbTestTrait;
use yii\codeception\TestCase;
use yii\test\DbTestTrait;
class UserTest extends \yii\codeception\TestCase
class UserTest extends TestCase
{
use DbTestTrait;
protected function setUp()
{
/*
*
* you can load fixtures in this way
*
parent::setUp();
$this->loadFixtures([
'tbl_user',
]);
*/
// uncomment the following to load fixtures for table tbl_user
//$this->loadFixtures(['tbl_user']);
}
// TODO add test methods here
}
<?php
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'test');
require_once(__DIR__ . '/../vendor/autoload.php');
require_once(__DIR__ . '/../vendor/yiisoft/yii2/yii/Yii.php');
return require(__DIR__ . '/../config/web.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/Yii.php');
$config = require(__DIR__ . '/../config/web.php');
$application = new yii\web\Application($config);
$application->run();
<?php
defined('YII_DEBUG') or define('YII_DEBUG', true);
// NOTE: Make sure this file is not accessable when deployed to production
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'test');
require_once(__DIR__ . '/../vendor/autoload.php');
require_once(__DIR__ . '/../vendor/yiisoft/yii2/yii/Yii.php');
require(__DIR__ . '/../vendor/autoload.php');
require(__DIR__ . '/../vendor/yiisoft/yii2/yii/Yii.php');
$config = yii\helpers\ArrayHelper::merge(
require(__DIR__ . '/../config/web-test.php'),
require(__DIR__ . '/../config/web.php'),
require(__DIR__ . '/../config/codeception/acceptance.php')
);
......
<?php
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'test');
require_once(__DIR__ . '/../vendor/autoload.php');
require_once(__DIR__ . '/../vendor/yiisoft/yii2/yii/Yii.php');
// this file is used as the entry script for codeception functional testing
$config = yii\helpers\ArrayHelper::merge(
require(__DIR__ . '/../config/web-test.php'),
require(__DIR__ . '/../config/web.php'),
require(__DIR__ . '/../config/codeception/functional.php')
);
......
<?php
// comment out the following two lines when deployed to production
defined('YII_DEBUG') or define('YII_DEBUG', false);
defined('YII_ENV') or define('YII_ENV', 'prod');
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/Yii.php');
......
......@@ -2,30 +2,25 @@
namespace yii\codeception;
class BasePage
{
// include url of current page
public static $URL = '';
use Codeception\AbstractGuy;
/**
/**
*
* Declare UI map for this page here. CSS or XPath allowed.
* public static $usernameField = '#username';
* public static $formSubmitButton = "#mainForm input[type=submit]";
*
* @author Mark Jebri <mark.github@yandex.ru>
* @since 2.0
*/
abstract class BasePage
{
/**
* Basic route example for your current URL
* You can append any additional parameter to URL
* and use it in tests like: EditPage::route('/123-post');
* @var string include url of current page. This property has to be overwritten by subclasses
*/
public static function route($param)
{
return static::$URL.$param;
}
public static $URL = '';
/**
* @var
* @var AbstractGuy
*/
protected $guy;
......@@ -35,11 +30,21 @@ class BasePage
}
/**
* @return $this
* Basic route example for your current URL
* You can append any additional parameter to URL
* and use it in tests like: EditPage::route('/123-post');
*/
public static function route($param)
{
return static::$URL.$param;
}
/**
* @param $I
* @return static
*/
public static function of($I)
{
return new static($I);
}
}
......@@ -4,9 +4,4 @@ Yii Framework 2 Codeception extension Change Log
2.0.0 beta under development
----------------------------
- no changes in this release.
2.0.0 alpha, December 1, 2013
-----------------------------
- Initial release.
\ No newline at end of file
......@@ -6,26 +6,25 @@ use Yii;
class TestCase extends \PHPUnit_Framework_TestCase
{
/**
* Your application base config that will be used for creating application each time before test.
* This can be an array or alias, pointing to the config file. For example for console application it can be
* '@tests/unit/console_bootstrap.php' that can be similar to existing unit tests bootstrap file.
* @var mixed
*/
protected $baseConfig = '@tests/unit/_bootstrap.php';
protected $baseConfig = '@app/config/web.php';
/**
* Your application config, will be merged with base config when creating application. Can be an alias too.
* @var mixed
*/
protected $config = array();
protected $config = [];
/**
* Created application class
* @var string
*/
protected $appClass = '\yii\web\Application';
protected $appClass = 'yii\web\Application';
protected function setUp()
{
......@@ -41,8 +40,8 @@ class TestCase extends \PHPUnit_Framework_TestCase
protected function mockApplication()
{
$baseConfig = is_array($this->baseConfig)? $this->baseConfig : require(Yii::getAlias($this->baseConfig, true));
$config = is_array($this->config)? $this->config : require(Yii::getAlias($this->config, true));
$baseConfig = is_array($this->baseConfig) ? $this->baseConfig : require(Yii::getAlias($this->baseConfig));
$config = is_array($this->config)? $this->config : require(Yii::getAlias($this->config));
new $this->appClass(\yii\helpers\ArrayHelper::merge($baseConfig,$config));
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment