Codeception test adjustments for basic and advanced applications

- Moved everything test-related into `tests` directory. Codeception tests are in `codeception`.
- Removed database module since we're using fixtures and migrations.
- Moved console entry points and bootstrap into `tests/codeception/bin`.
- Adjusted travis build scripts.
- Adjusted documentation to be consistent and reflect changes made.

composer.json

@@ -24,11 +24,6 @@
         "yiisoft/yii2-debug": "*",
         "yiisoft/yii2-gii": "*"
     },
-    "suggest": {
-        "codeception/codeception": "Codeception, 2.0.* is currently works well with Yii.",
-        "codeception/specify": "BDD style code blocks for PHPUnit and Codeception",
-        "codeception/verify": "BDD Assertions for PHPUnit and Codeception"
-    },
     "scripts": {
         "post-create-project-cmd": [
             "yii\\composer\\Installer::setPermission",

tests/README.md

@@ -1,32 +1,50 @@
-This folder contains various tests for the basic application.
+This directory contains various tests for the basic application.
-These tests are developed with [Codeception PHP Testing Framework](http://codeception.com/).
+
+Tests in `codeception` directory are developed with [Codeception PHP Testing Framework](http://codeception.com/).
 
 After creating the basic application, follow these steps to prepare for the tests:
 
-1. Install additional composer packages:
+1. Install Codeception if it's not yet installed:
 
-   ```
+```
-   php composer.phar require --dev "codeception/codeception: 2.0.*" "codeception/specify: *" "codeception/verify: *"
+composer global require "codeception/codeception=2.0.*"
-   ```
+composer global require "codeception/specify=*"
-2. In the file `_bootstrap.php`, modify the definition of the constant `TEST_ENTRY_URL` so
+composer global require "codeception/verify=*"
-   that it points to the correct entry script URL.
+```
-3. Go to the application base directory and build the test suites:
 
-   ```
+If you've never used Composer for global packages run `composer global status`. It should output:
-   vendor/bin/codecept build
-   ```
 
-Now you can run the tests with the following commands:
+```
+Changed current directory to <directory>
+```
+
+Then add `<directory>/vendor/bin` to you `PATH` environment variable. Now we're able to use `codecept` from command
+line globally.
+
+2. Build the test suites:
+
+```
+codecept build
+```
+
+3. In order to be able to run acceptance tests you need to start a webserver. The simplest way is to use PHP built in
+webserver. In the `web` directory execute the following:
+
+```
+php -S localhost:8080
+```
+
+4. Now you can run the tests with the following commands:
 
 ```
 # run all available tests
-vendor/bin/codecept run
+codecept run
 # run acceptance tests
-vendor/bin/codecept run acceptance
+codecept run acceptance
 # run functional tests
-vendor/bin/codecept run functional
+codecept run functional
 # run unit tests
-vendor/bin/codecept run unit
+codecept run unit
 ```
 
 Please refer to [Codeception tutorial](http://codeception.com/docs/01-Introduction) for

tests/acceptance/_console.php

@@ -1,13 +0,0 @@
-<?php
-
-return yii\helpers\ArrayHelper::merge(
-    require(__DIR__ . '/../../config/console.php'),
-    require(__DIR__ . '/../_config.php'),
-    [
-        'components' => [
-            'db' => [
-                'dsn' => 'mysql:host=localhost;dbname=yii2_basic_acceptance',
-            ],
-        ],
-    ]
-);

tests/acceptance/yii

@@ -1,17 +0,0 @@
-#!/usr/bin/env php
-<?php
-/**
- * Yii console bootstrap file.
- *
- * @link http://www.yiiframework.com/
- * @copyright Copyright (c) 2008 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
-
-require_once __DIR__ . '/../_console_bootstrap.php';
-
-$config = require(__DIR__ . '/_console.php');
-
-$application = new yii\console\Application($config);
-$exitCode = $application->run();
-exit($exitCode);

tests/codeception.yml

@@ -1,9 +1,9 @@
 actor: Tester
 paths:
-    tests: tests
+    tests: codeception
-    log: tests/_log
+    log: codeception/_log
-    data: tests/_data
+    data: codeception/_data
-    helpers: tests/_helpers
+    helpers: codeception/_helpers
 settings:
     bootstrap: _bootstrap.php
     suite_class: \PHPUnit_Framework_TestSuite
@@ -16,4 +16,4 @@ modules:
             dsn: ''
             user: ''
             password: ''
-            dump: tests/_data/dump.sql
+            dump: codeception/_data/dump.sql

tests/codeception/_bootstrap.php

@@ -2,22 +2,22 @@
 
 // the entry script URL (without host info) for functional and acceptance tests
 // PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
-defined('TEST_ENTRY_URL') or define('TEST_ENTRY_URL', '/basic/web/index-test.php');
+defined('TEST_ENTRY_URL') or define('TEST_ENTRY_URL', '/index-test.php');
 
 // the entry script file path for functional and acceptance tests
-defined('TEST_ENTRY_FILE') or define('TEST_ENTRY_FILE', dirname(__DIR__) . '/web/index-test.php');
+defined('TEST_ENTRY_FILE') or define('TEST_ENTRY_FILE', dirname(dirname(__DIR__)) . '/web/index-test.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/autoload.php');
 
-require_once(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');
+require_once(__DIR__ . '/../../vendor/yiisoft/yii2/Yii.php');
 
 // set correct script paths
 $_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
 $_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
 $_SERVER['SERVER_NAME'] = 'localhost';
 
-Yii::setAlias('@tests', __DIR__);
+Yii::setAlias('@codeception', __DIR__);

tests/codeception/_pages/AboutPage.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace tests\_pages;
+namespace codeception\_pages;
 
 use yii\codeception\BasePage;
 

tests/codeception/_pages/ContactPage.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace tests\_pages;
+namespace codeception\_pages;
 
 use yii\codeception\BasePage;
 

tests/codeception/_pages/LoginPage.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace tests\_pages;
+namespace codeception\_pages;
 
 use yii\codeception\BasePage;
 

tests/codeception/acceptance/AboutCept.php

@@ -1,6 +1,6 @@
 <?php
 
-use tests\_pages\AboutPage;
+use codeception\_pages\AboutPage;
 
 $I = new WebGuy($scenario);
 $I->wantTo('ensure that about works');

tests/codeception/acceptance/ContactCept.php

@@ -1,6 +1,6 @@
 <?php
 
-use tests\_pages\ContactPage;
+use codeception\_pages\ContactPage;
 
 $I = new WebGuy($scenario);
 $I->wantTo('ensure that contact works');

tests/codeception/acceptance/LoginCept.php

@@ -1,6 +1,6 @@
 <?php
 
-use tests\_pages\LoginPage;
+use codeception\_pages\LoginPage;
 
 $I = new WebGuy($scenario);
 $I->wantTo('ensure that login works');

tests/codeception/acceptance/_config.php

@@ -1,7 +1,7 @@
 <?php
 
 return yii\helpers\ArrayHelper::merge(
-    require(__DIR__ . '/../../config/web.php'),
+    require(__DIR__ . '/../../../config/web.php'),
     require(__DIR__ . '/../_config.php'),
     [
         'components' => [

tests/codeception/bin/_console_bootstrap.php

@@ -8,5 +8,7 @@ defined('YII_ENV') or define('YII_ENV', 'test');
 defined('STDIN') or define('STDIN', fopen('php://stdin', 'r'));
 defined('STDOUT') or define('STDOUT', fopen('php://stdout', 'w'));
 
-require(__DIR__ . '/../vendor/autoload.php');
+defined('ROOT_DIR') or define('ROOT_DIR', dirname(dirname(dirname(__DIR__))));
-require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');
+
+require(ROOT_DIR . '/vendor/autoload.php');
+require(ROOT_DIR . '/vendor/yiisoft/yii2/Yii.php');

tests/codeception/bin/yii_acceptance

@@ -0,0 +1,27 @@
+#!/usr/bin/env php
+<?php
+/**
+ * Yii console bootstrap file.
+ *
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+require_once __DIR__ . '/_console_bootstrap.php';
+
+$config = yii\helpers\ArrayHelper::merge(
+    require(ROOT_DIR . '/config/console.php'),
+    require(__DIR__ . '/../_config.php'),
+    [
+        'components' => [
+            'db' => [
+                'dsn' => 'mysql:host=localhost;dbname=yii2_basic_acceptance',
+            ],
+        ],
+    ]
+);
+
+$application = new yii\console\Application($config);
+$exitCode = $application->run();
+exit($exitCode);

tests/codeception/bin/yii_acceptance.bat

@@ -15,6 +15,6 @@ set YII_PATH=%~dp0
 
 if "%PHP_COMMAND%" == "" set PHP_COMMAND=php.exe
 
-"%PHP_COMMAND%" "%YII_PATH%yii" %*
+"%PHP_COMMAND%" "%YII_PATH%yii_acceptance" %*
 
 @endlocal

tests/codeception/bin/yii_functional

@@ -0,0 +1,27 @@
+#!/usr/bin/env php
+<?php
+/**
+ * Yii console bootstrap file.
+ *
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+require_once __DIR__ . '/_console_bootstrap.php';
+
+$config = yii\helpers\ArrayHelper::merge(
+    require(ROOT_DIR . '/config/console.php'),
+    require(__DIR__ . '/../_config.php'),
+    [
+        'components' => [
+            'db' => [
+                'dsn' => 'mysql:host=localhost;dbname=yii2_basic_functional',
+            ],
+        ],
+    ]
+);
+
+$application = new yii\console\Application($config);
+$exitCode = $application->run();
+exit($exitCode);

tests/codeception/bin/yii_functional.bat

@@ -15,6 +15,6 @@ set YII_PATH=%~dp0
 
 if "%PHP_COMMAND%" == "" set PHP_COMMAND=php.exe
 
-"%PHP_COMMAND%" "%YII_PATH%yii" %*
+"%PHP_COMMAND%" "%YII_PATH%yii_functional" %*
 
 @endlocal

tests/codeception/bin/yii_unit

@@ -0,0 +1,27 @@
+#!/usr/bin/env php
+<?php
+/**
+ * Yii console bootstrap file.
+ *
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+require_once __DIR__ . '/_console_bootstrap.php';
+
+$config = yii\helpers\ArrayHelper::merge(
+    require(ROOT_DIR . '/config/console.php'),
+    require(__DIR__ . '/../_config.php'),
+    [
+        'components' => [
+            'db' => [
+                'dsn' => 'mysql:host=localhost;dbname=yii2_basic_unit',
+            ],
+        ],
+    ]
+);
+
+$application = new yii\console\Application($config);
+$exitCode = $application->run();
+exit($exitCode);

tests/codeception/bin/yii_unit.bat

@@ -15,6 +15,6 @@ set YII_PATH=%~dp0
 
 if "%PHP_COMMAND%" == "" set PHP_COMMAND=php.exe
 
-"%PHP_COMMAND%" "%YII_PATH%yii" %*
+"%PHP_COMMAND%" "%YII_PATH%yii_unit" %*
 
 @endlocal

tests/codeception/functional.suite.yml

@@ -13,4 +13,4 @@ modules:
       - Yii2
     config:
         Yii2:
-            configFile: 'tests/functional/_config.php'
+            configFile: 'codeception/functional/_config.php'

tests/codeception/functional/AboutCept.php

@@ -1,6 +1,6 @@
 <?php
 
-use tests\_pages\AboutPage;
+use codeception\_pages\AboutPage;
 
 $I = new TestGuy($scenario);
 $I->wantTo('ensure that about works');

tests/codeception/functional/ContactCept.php

@@ -1,6 +1,6 @@
 <?php
 
-use tests\_pages\ContactPage;
+use codeception\_pages\ContactPage;
 
 $I = new TestGuy($scenario);
 $I->wantTo('ensure that contact works');

tests/codeception/functional/LoginCept.php

@@ -1,6 +1,6 @@
 <?php
 
-use tests\_pages\LoginPage;
+use codeception\_pages\LoginPage;
 
 $I = new TestGuy($scenario);
 $I->wantTo('ensure that login works');

tests/codeception/functional/_config.php

@@ -5,7 +5,7 @@ $_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
 $_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
 
 return yii\helpers\ArrayHelper::merge(
-    require(__DIR__ . '/../../config/web.php'),
+    require(__DIR__ . '/../../../config/web.php'),
     require(__DIR__ . '/../_config.php'),
     [
         'components' => [

tests/codeception/unit/_config.php

@@ -1,7 +1,7 @@
 <?php
 
 return yii\helpers\ArrayHelper::merge(
-    require(__DIR__ . '/../../config/web.php'),
+    require(__DIR__ . '/../../../config/web.php'),
     require(__DIR__ . '/../_config.php'),
     [
         'components' => [

tests/codeception/unit/models/ContactFormTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace tests\unit\models;
+namespace codeception\unit\models;
 
 use Yii;
 use yii\codeception\TestCase;

tests/codeception/unit/models/LoginFormTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace tests\unit\models;
+namespace codeception\unit\models;
 
 use Yii;
 use yii\codeception\TestCase;

tests/codeception/unit/models/UserTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace tests\unit\models;
+namespace codeception\unit\models;
 
 use yii\codeception\TestCase;
 

tests/functional/_console.php

@@ -1,13 +0,0 @@
-<?php
-
-return yii\helpers\ArrayHelper::merge(
-    require(__DIR__ . '/../../config/console.php'),
-    require(__DIR__ . '/../_config.php'),
-    [
-        'components' => [
-            'db' => [
-                'dsn' => 'mysql:host=localhost;dbname=yii2_basic_functional',
-            ],
-        ],
-    ]
-);

tests/functional/yii

@@ -1,17 +0,0 @@
-#!/usr/bin/env php
-<?php
-/**
- * Yii console bootstrap file.
- *
- * @link http://www.yiiframework.com/
- * @copyright Copyright (c) 2008 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
-
-require_once __DIR__ . '/../_console_bootstrap.php';
-
-$config = require(__DIR__ . '/_console.php');
-
-$application = new yii\console\Application($config);
-$exitCode = $application->run();
-exit($exitCode);

tests/unit/_console.php

@@ -1,13 +0,0 @@
-<?php
-
-return yii\helpers\ArrayHelper::merge(
-    require(__DIR__ . '/../../config/console.php'),
-    require(__DIR__ . '/../_config.php'),
-    [
-        'components' => [
-            'db' => [
-                'dsn' => 'mysql:host=localhost;dbname=yii2_basic_unit',
-            ],
-        ],
-    ]
-);

tests/unit/yii

@@ -1,17 +0,0 @@
-#!/usr/bin/env php
-<?php
-/**
- * Yii console bootstrap file.
- *
- * @link http://www.yiiframework.com/
- * @copyright Copyright (c) 2008 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
-
-require_once __DIR__ . '/../_console_bootstrap.php';
-
-$config = require(__DIR__ . '/_console.php');
-
-$application = new yii\console\Application($config);
-$exitCode = $application->run();
-exit($exitCode);

web/index-test.php

@@ -11,6 +11,6 @@ defined('YII_ENV') or define('YII_ENV', 'test');
 require(__DIR__ . '/../vendor/autoload.php');
 require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');
 
-$config = require(__DIR__ . '/../tests/acceptance/_config.php');
+$config = require(__DIR__ . '/../tests/codeception/acceptance/_config.php');
 
 (new yii\web\Application($config))->run();