MQE-2162: Chrome remains running after MFTF suite finishes

Author: okolesnyk

etc/config/.env.example

@@ -21,6 +21,7 @@ MAGENTO_ADMIN_PASSWORD=123123q
 #SELENIUM_PORT=4444
 #SELENIUM_PROTOCOL=http
 #SELENIUM_PATH=/wd/hub
+SELENIUM_CLOSE_ALL_SESSIONS=true
 
 #*** Browser for running tests, default chrome. Uncomment and change if you want to run tests on another browser (ex. firefox).
 BROWSER=chrome

etc/config/functional.suite.dist.yml

@@ -34,6 +34,7 @@ modules:
             port: "%SELENIUM_PORT%"
             protocol: "%SELENIUM_PROTOCOL%"
             path: "%SELENIUM_PATH%"
+            close_all_sessions: "%SELENIUM_CLOSE_ALL_SESSIONS%"
             capabilities:
                 unhandledPromptBehavior: "ignore"
                 chromeOptions:

src/Magento/FunctionalTestingFramework/Suite/views/SuiteClass.mustache

@@ -2,8 +2,10 @@
 
 namespace Group;
 
+use Facebook\WebDriver\Remote\RemoteWebDriver;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\PersistedObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
+use Magento\FunctionalTestingFramework\Module\MagentoWebDriver;
 
 /**
  * Group class is Codeception Extension which is allowed to handle to all internal events.
@@ -55,18 +57,20 @@ class {{suiteName}} extends \Codeception\GroupObject
         if ($this->currentTestRun == 1) {
             print sprintf(self::$HOOK_EXECUTION_INIT, "before");
 
+            /** @var MagentoWebDriver $webDriver */
+            $webDriver = $this->getModule('\Magento\FunctionalTestingFramework\Module\MagentoWebDriver');
+
             try {
                 {{> testActions}}
-
-                // reset configuration and close session
-                $this->getModule('\Magento\FunctionalTestingFramework\Module\MagentoWebDriver')->_resetConfig();
-                $webDriver->webDriver->close();
-                $webDriver->webDriver = null;
-
             } catch (\Exception $exception) {
                 $this->preconditionFailure = $exception->getMessage();
             }
 
+            // reset configuration and close session
+            $webDriver->_resetConfig();
+            $webDriver->webDriver->close();
+            $webDriver->webDriver = null;
+
             print sprintf(self::$HOOK_EXECUTION_END, "before");
         }
     }
@@ -84,6 +88,9 @@ class {{suiteName}} extends \Codeception\GroupObject
         if ($this->currentTestRun == $this->testCount) {
             print sprintf(self::$HOOK_EXECUTION_INIT, "after");
 
+            /** @var MagentoWebDriver $webDriver */
+            $webDriver = $this->getModule('\Magento\FunctionalTestingFramework\Module\MagentoWebDriver');
+
             try {
                 // Find out if Test in Suite failed, will cause potential failures in suite after
                 $cest = $e->getTest();
@@ -112,8 +119,38 @@ class {{suiteName}} extends \Codeception\GroupObject
             }
 
             PersistedObjectHandler::getInstance()->clearSuiteObjects();
+
+            $this->closeSession($webDriver);
+
             print sprintf(self::$HOOK_EXECUTION_END, "after");
         }
     }
     {{/after}}
+
+    /**
+     * Close session method closes current session.
+     * If config 'close_all_sessions' is set to 'true' all sessions will be closed.
+     *
+     * @param MagentoWebDriver $webDriver
+     * return void
+     */
+    private function closeSession(MagentoWebDriver $webDriver): void
+    {
+        $webDriverConfig = $webDriver->_getConfig();
+        $webDriver->_closeSession();
+        if (isset($webDriverConfig['close_all_sessions']) && $webDriverConfig['close_all_sessions'] === "true") {
+            $wdHost = sprintf(
+                '%s://%s:%s%s',
+                $webDriverConfig['protocol'],
+                $webDriverConfig['host'],
+                $webDriverConfig['port'],
+                $webDriverConfig['path']
+            );
+            $availableSessions = RemoteWebDriver::getAllSessions($wdHost);
+            foreach ($availableSessions as $session) {
+                $remoteWebDriver = RemoteWebDriver::createBySessionID($session['id'], $wdHost);
+                $remoteWebDriver->quit();
+            }
+        }
+    }
 }

src/Magento/FunctionalTestingFramework/Suite/views/partials/testActions.mustache

@@ -1,15 +1,10 @@
 {{#actions}}
 {{#webDriverInit}}
-$webDriver = $this->getModule('\Magento\FunctionalTestingFramework\Module\MagentoWebDriver');
-
-// close any open sessions
 if ($webDriver->webDriver != null) {
-    $webDriver->webDriver->close();
-    $webDriver->webDriver = null;
+    $webDriver->_restart();
+} else {
+    $webDriver->_initializeSession();
 }
-
-// initialize the webdriver session
-$webDriver->_initializeSession();
 {{/webDriverInit}}
 {{#action}}
 {{{action}}}