This adds support for components that keep state that must be cleared… (#4924)

* This adds support for components that keep state that must be cleared between requests

* Fixed issue in test skip logic + nitpick CS

* Fix application reset after exception

* Add configuration option to recreate the whole application before each request

* Add default configuration

Author: SamMousa

src/Codeception/Lib/Connector/Yii2.php

@@ -64,6 +64,18 @@ class Yii2 extends Client
      */
     public $requestCleanMethod;
 
+    /**
+     * @var string[] List of component names that must be recreated before each request
+     */
+    public $recreateComponents = [];
+
+    /**
+     * This option is there primarily for backwards compatibility.
+     * It means you cannot make any modification to application state inside your app, since they will get discarded.
+     * @var bool whether to recreate the whole application before each request
+     */
+    public $recreateApplication = false;
+
     /**
      * @return \yii\web\Application
      */
@@ -133,31 +145,19 @@ public function doRequest($request)
             $_GET[$k] = $v;
         }
 
-        $app = $this->getApplication();
-
-        /**
-         * 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.
-         */
-        $this->resetResponse($app);
+        ob_start();
 
+        $this->beforeRequest();
 
+        $app = $this->getApplication();
 
         // disabling logging. Logs are slowing test execution down
         foreach ($app->log->targets as $target) {
             $target->enabled = false;
         }
 
-        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.
-         */
-        $this->resetRequest($app);
+
 
         $yiiRequest = $app->getRequest();
         if ($request->getContent() !== null) {
@@ -186,7 +186,6 @@ public function doRequest($request)
                 $app->errorHandler->handleException($e);
             } elseif (!$e instanceof ExitException) {
                 // for exceptions not related to Http, we pass them to Codeception
-                $this->resetApplication();
                 throw $e;
             }
             $response = $app->response;
@@ -378,4 +377,28 @@ protected function resetRequest(Application $app)
                 break;
         }
     }
+
+    /**
+     * Called before each request, preparation happens here.
+     */
+    protected function beforeRequest()
+    {
+        if ($this->recreateApplication) {
+            $this->resetApplication();
+            return;
+        }
+
+        $application = $this->getApplication();
+
+        $this->resetResponse($application);
+        $this->resetRequest($application);
+
+        $definitions = $application->getComponents(true);
+        foreach ($this->recreateComponents as $component) {
+            // Only recreate if it has actually been instantiated.
+            if ($application->has($component, true)) {
+                $application->set($component, $definitions[$component]);
+            }
+        }
+    }
 }

src/Codeception/Module/Yii2.php

@@ -23,6 +23,7 @@
  * ## Application state during testing
  * This section details what you can expect when using this module.
  * * You will get a fresh application in `\Yii::$app` at the start of each test (available in the test and in `_before()`).
+ * * Inside your test you may change application state; however these changes will be lost when doing a request if you have enabled `recreateApplication`.
  * * When executing a request via one of the request functions the `request` and `response` component are both recreated.
  * * After a request the whole application is available for inspection / interaction.
  * * You may use multiple database connections, each will use a separate transaction; to prevent accidental mistakes we
@@ -41,8 +42,12 @@
  * Between test casesthe whole application is always recreated
  * * `requestCleanMethod` - (default: recreate) Method for cleaning the request object. Note that this is only for multiple requests inside a single test case.
  * Between test cases the whole application is always recreated
+ * * `recreateComponents` - (default: []) Some components change their state making them unsuitable for processing multiple requests. In production this is usually
+ * not a problem since web apps tend to die and start over after each request. This allows you to list application components that need to be recreated before each request.
+ * As a consequence, any components specified here should not be changed inside a test since those changes will get regarded.
+ * You can use this module by setting params in your functional.suite.yml:
+ * * `recreateApplication` - (default: false) whether to recreate the whole application before each request
  * You can use this module by setting params in your functional.suite.yml:
- *
  * ```yaml
  * actor: FunctionalTester
  * modules:
@@ -154,7 +159,9 @@ class Yii2 extends Framework implements ActiveRecord, PartedModule
         'entryScript' => '',
         'entryUrl'    => 'http://localhost/index-test.php',
         'responseCleanMethod' => Yii2Connector::CLEAN_CLEAR,
-        'requestCleanMethod' => Yii2Connector::CLEAN_RECREATE
+        'requestCleanMethod' => Yii2Connector::CLEAN_RECREATE,
+        'recreateComponents' => [],
+        'recreateApplication' => false
     ];
 
     protected $requiredFields = ['configFile'];