Yii2 rework, new PR same changes. (#4894)

* Reorganized travis jobs

* Improved Yii2 module

* Fixed issue and updated docs

* Added notice about absence of $app.

* Fixed weird sentence

Author: SamMousa

src/Codeception/Lib/Connector/Yii2.php

@@ -2,14 +2,16 @@
 namespace Codeception\Lib\Connector;
 
 use Codeception\Lib\Connector\Yii2\Logger;
-use Codeception\Lib\Connector\Yii2\TestMailer;
+use Codeception\Lib\InnerBrowser;
 use Codeception\Util\Debug;
 use Symfony\Component\BrowserKit\Client;
 use Symfony\Component\BrowserKit\Cookie;
 use Symfony\Component\BrowserKit\Response;
 use Yii;
 use yii\base\ExitException;
+use yii\base\Security;
 use yii\web\HttpException;
+use yii\web\Request;
 use yii\web\Response as YiiResponse;
 
 class Yii2 extends Client
@@ -21,71 +23,41 @@ class Yii2 extends Client
      */
     public $configFile;
 
-    public $defaultServerVars = [];
-
-    /**
-     * @var array
-     */
-    public $headers;
-    public $statusCode;
-
-    /**
-     * @var \yii\web\Application
-     */
-    private $app;
-
-    /**
-     * @var \yii\db\Connection
-     */
-    public static $db; // remember the db instance
-
-    /**
-     * @var TestMailer
-     */
-    public static $mailer;
-
     /**
      * @return \yii\web\Application
      */
     public function getApplication()
     {
-        if (!isset($this->app)) {
+        if (!isset(Yii::$app)) {
             $this->startApp();
         }
-        return $this->app;
+        return Yii::$app;
     }
 
     public function resetApplication()
     {
-        $this->app = null;
+        codecept_debug('Destroying application');
+        Yii::$app = null;
+        \yii\web\UploadedFile::reset();
+        if (method_exists(\yii\base\Event::className(), 'offAll')) {
+            \yii\base\Event::offAll();
+        }
+        Yii::setLogger(null);
     }
 
     public function startApp()
     {
+        codecept_debug('Starting application');
         $config = require($this->configFile);
         if (!isset($config['class'])) {
             $config['class'] = 'yii\web\Application';
         }
-        if (static::$db) {
-            // If the DB conection already exists, make sure to pass it as early as possible
-            // to prevent application from new connection creating during bootstrap
-            $config['components']['db'] = static::$db;
-        }
+
+        $config = $this->mockMailer($config);
         /** @var \yii\web\Application $app */
-        $this->app = Yii::createObject($config);
-        $this->persistDb();
-        $this->mockMailer($config);
-        \Yii::setLogger(new Logger());
-    }
+        Yii::$app = Yii::createObject($config);
 
-    public function resetPersistentVars()
-    {
-        static::$db = null;
-        static::$mailer = null;
-        \yii\web\UploadedFile::reset();
-        if (method_exists(\yii\base\Event::className(), 'offAll')) {
-            \yii\base\Event::offAll();
-        }
+        Yii::setLogger(new Logger());
     }
 
     /**
@@ -98,7 +70,6 @@ public function doRequest($request)
     {
         $_COOKIE = $request->getCookies();
         $_SERVER = $request->getServer();
-        $this->restoreServerVars();
         $_FILES = $this->remapFiles($request->getFiles());
         $_REQUEST = $this->remapRequestParameters($request->getParameters());
         $_POST = $_GET = [];
@@ -123,20 +94,28 @@ public function doRequest($request)
 
         $app = $this->getApplication();
 
-        $app->getResponse()->on(YiiResponse::EVENT_AFTER_PREPARE, [$this, 'processResponse']);
+        /**
+         * Just before the request we set the response object so it is always fresh.
+         * @todo Implement some kind of check to see if someone tried to change the objects' properties and expects
+         * those changes to be reflected in the reponse.
+         */
+        $app->set('response', $app->getComponents()['response']);
 
         // disabling logging. Logs are slowing test execution down
         foreach ($app->log->targets as $target) {
             $target->enabled = false;
         }
 
-        $this->headers    = [];
-        $this->statusCode = null;
-
         ob_start();
 
         // recreating request object to reset headers and cookies collections
+        /**
+         * Just before the request we set the request object so it is always fresh.
+         * @todo Implement some kind of check to see if someone tried to change the objects' properties and expects
+         * those changes to be reflected in the reponse.
+         */
         $app->set('request', $app->getComponents()['request']);
+
         $yiiRequest = $app->getRequest();
         if ($request->getContent() !== null) {
             $yiiRequest->setRawBody($request->getContent());
@@ -148,35 +127,42 @@ public function doRequest($request)
         $yiiRequest->setQueryParams($_GET);
 
         try {
+            /*
+             * This is basically equivalent to $app->run() without sending the response.
+             * Sending the response is problematic because it tries to send headers.
+             */
             $app->trigger($app::EVENT_BEFORE_REQUEST);
-
-            $app->handleRequest($yiiRequest)->send();
-
+            $response = $app->handleRequest($yiiRequest);
             $app->trigger($app::EVENT_AFTER_REQUEST);
+            codecept_debug($response->isSent);
+            $response->send();
         } catch (\Exception $e) {
             if ($e instanceof HttpException) {
                 // Don't discard output and pass exception handling to Yii to be able
                 // to expect error response codes in tests.
                 $app->errorHandler->discardExistingOutput = false;
                 $app->errorHandler->handleException($e);
+                $response = $app->response;
+
             } elseif (!$e instanceof ExitException) {
                 // for exceptions not related to Http, we pass them to Codeception
                 $this->resetApplication();
                 throw $e;
             }
         }
 
-        $content = ob_get_clean();
+        $this->encodeCookies($response, $yiiRequest, $app->security);
 
-        // catch "location" header and display it in debug, otherwise it would be handled
-        // by symfony browser-kit and not displayed.
-        if (isset($this->headers['location'])) {
-            Debug::debug("[Headers] " . json_encode($this->headers));
+        if ($response->isRedirection) {
+            Debug::debug("[Redirect with headers]" . print_r($response->getHeaders()->toArray(), true));
         }
 
-        $this->resetApplication();
+        $content = ob_get_clean();
+        if (empty($content) && !empty($response->content)) {
+            throw new \Exception('No content was sent from Yii application');
+        }
 
-        return new Response($content, $this->statusCode, $this->headers);
+        return new Response($content, $response->statusCode, $response->getHeaders()->toArray());
     }
 
     protected function revertErrorHandler()
@@ -186,36 +172,28 @@ protected function revertErrorHandler()
     }
 
 
-    public function restoreServerVars()
-    {
-        $this->server = $this->defaultServerVars;
-        foreach ($this->server as $key => $value) {
-            $_SERVER[$key] = $value;
-        }
-    }
-
-    public function processResponse($event)
-    {
-        /** @var \yii\web\Response $response */
-        $response = $event->sender;
-        $request = Yii::$app->getRequest();
-        $this->headers = $response->getHeaders()->toArray();
-        $response->getHeaders()->removeAll();
-        $this->statusCode = $response->getStatusCode();
-        $cookies = $response->getCookies();
-
+    /**
+     * Encodes the cookies and adds them to the headers.
+     * @param \yii\web\Response $response
+     * @throws \yii\base\InvalidConfigException
+     */
+    protected function encodeCookies(
+        YiiResponse $response,
+        Request $request,
+        Security $security
+    ) {
         if ($request->enableCookieValidation) {
             $validationKey = $request->cookieValidationKey;
         }
 
-        foreach ($cookies as $cookie) {
+        foreach ($response->getCookies() as $cookie) {
             /** @var \yii\web\Cookie $cookie */
             $value = $cookie->value;
             if ($cookie->expire != 1 && isset($validationKey)) {
                 $data = version_compare(Yii::getVersion(), '2.0.2', '>')
                     ? [$cookie->name, $cookie->value]
                     : $cookie->value;
-                $value = Yii::$app->security->hashData(serialize($data), $validationKey);
+                $value = $security->hashData(serialize($data), $validationKey);
             }
             $c = new Cookie(
                 $cookie->name,
@@ -228,21 +206,15 @@ public function processResponse($event)
             );
             $this->getCookieJar()->set($c);
         }
-        $cookies->removeAll();
     }
 
     /**
      * Replace mailer with in memory mailer
-     * @param $config
-     * @param $app
+     * @param array $config Original configuration
+     * @return array New configuration
      */
-    protected function mockMailer($config)
+    protected function mockMailer(array $config)
     {
-        if (static::$mailer) {
-            $this->app->set('mailer', static::$mailer);
-            return;
-        }
-
         // options that make sense for mailer mock
         $allowedOptions = [
             'htmlLayout',
@@ -267,21 +239,24 @@ protected function mockMailer($config)
                 }
             }
         }
+        $config['components']['mailer'] = $mailerConfig;
 
-        $this->app->set('mailer', $mailerConfig);
-        static::$mailer = $this->app->get('mailer');
+        return $config;
     }
 
     /**
-     * @param $app
+     * A new client is created for every test, it is destroyed after every test.
+     * @see InnerBrowser::_after()
+     *
      */
-    protected function persistDb()
+    public function __destruct()
     {
-        // always use the same DB connection
-        if (static::$db) {
-            $this->app->set('db', static::$db);
-        } elseif ($this->app->has('db')) {
-            static::$db = $this->app->get('db');
-        }
+        $this->resetApplication();
+    }
+
+    public function restart()
+    {
+        parent::restart();
+        $this->resetApplication();
     }
 }