Merge pull request #707 from magento/MQE-2130

MQE-2130: All PayPal SmartButton tests fail with error even though th…

Author: okolesnyk

src/Magento/FunctionalTestingFramework/Helper/HelperContainer.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types = 1);
 
 namespace Magento\FunctionalTestingFramework\Helper;
 
@@ -11,20 +12,30 @@
 /**
  * Class HelperContainer
  */
-class HelperContainer
+class HelperContainer extends \Codeception\Module
 {
     /**
      * @var Helper[]
      */
     private $helpers = [];
 
     /**
-     * HelperContainer constructor.
-     * @param array $helpers
+     * Create custom helper class.
+     *
+     * @param string $helperClass
+     * @return Helper
+     * @throws \Exception
      */
-    public function __construct(array $helpers = [])
+    public function create(string $helperClass): Helper
     {
-        $this->helpers = $helpers;
+        if (get_parent_class($helperClass) !== Helper::class) {
+            throw new \Exception("Helper class must extend " . Helper::class);
+        }
+        if (!isset($this->helpers[$helperClass])) {
+            $this->helpers[$helperClass] = $this->moduleContainer->create($helperClass);
+        }
+
+        return $this->helpers[$helperClass];
     }
 
     /**
@@ -34,7 +45,7 @@ public function __construct(array $helpers = [])
      * @return Helper
      * @throws TestFrameworkException
      */
-    public function get(string $className)
+    public function get(string $className): Helper
     {
         if ($this->has($className)) {
             return $this->helpers[$className];
@@ -48,7 +59,7 @@ public function get(string $className)
      * @param string $className
      * @return boolean
      */
-    public function has(string $className)
+    public function has(string $className): bool
     {
         return array_key_exists($className, $this->helpers);
     }

src/Magento/FunctionalTestingFramework/Helper/views/TestInjectMethod.mustache

@@ -6,14 +6,10 @@
     /**
      * Special method which automatically creates the respective objects.
      */
-    public function _inject(
-        {{argumentsWithTypes}}
-    ) {
-        $this->helperContainer = new \Magento\FunctionalTestingFramework\Helper\HelperContainer(
-            [
-            {{#arguments}}
-                '{{type}}' => {{var}},
-            {{/arguments}}
-            ]
-        );
+    public function _inject(\Magento\FunctionalTestingFramework\Helper\HelperContainer $helperContainer)
+    {
+        $this->helperContainer = $helperContainer;
+        {{#arguments}}
+        $this->helperContainer->create("{{type}}");
+        {{/arguments}}
     }

src/Magento/FunctionalTestingFramework/ObjectManager/ObjectHandlerInterface.php

@@ -24,7 +24,7 @@ public static function getInstance();
      * Function to return a single object by name
      *
      * @param string $objectName
-     * @return object
+     * @return mixed
      */
     public function getObject($objectName);
 

src/Magento/FunctionalTestingFramework/Suite/Generators/GroupClassGenerator.php

@@ -131,14 +131,18 @@ private function buildHookMustacheArray($hookObj)
     {
         $actions = [];
         $mustacheHookArray['actions'][] = ['webDriverInit' => true];
+        $mustacheHookArray['helpers'] = [];
 
         foreach ($hookObj->getActions() as $action) {
             /** @var ActionObject $action */
             $index = count($actions);
+            if ($action->getType() === ActionObject::ACTION_TYPE_HELPER) {
+                $mustacheHookArray['helpers'][] = $action->getCustomActionAttributes()['class'];
+            }
             //deleteData contains either url or createDataKey, if it contains the former it needs special formatting
             if ($action->getType() !== "createData"
                 && !array_key_exists(TestGenerator::REQUIRED_ENTITY_REFERENCE, $action->getCustomActionAttributes())) {
-                $actions = $this->buildWebDriverActionsMustacheArray($action, $actions, $index);
+                $actions = $this->buildWebDriverActionsMustacheArray($action, $actions);
                 continue;
             }
 

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

@@ -20,12 +20,25 @@ class {{suiteName}} extends \Codeception\GroupObject
     private $testCount = {{testCount}};
     private $preconditionFailure = null;
     private $currentTestRun = 0;
+    {{#helpers}}
+    /**
+     * @var \Magento\FunctionalTestingFramework\Helper\HelperContainer $helperContainer
+     */
+    private $helperContainer;
+    {{/helpers}}
     private static $HOOK_EXECUTION_INIT = "\n/******** Beginning execution of {{suiteName}} suite %s block ********/\n";
     private static $HOOK_EXECUTION_END = "\n/******** Execution of {{suiteName}} suite %s block complete ********/\n";
 
     {{#before}}
     public function _before(\Codeception\Event\TestEvent $e)
     {
+        {{#helpers}}
+        /** @var \Magento\FunctionalTestingFramework\Helper\HelperContainer $helperContainer */
+        $this->helperContainer = $this->getModule('\Magento\FunctionalTestingFramework\Helper\HelperContainer');
+        {{/helpers}}
+        {{#helpers}}
+        $this->helperContainer->create("{{ . }}");
+        {{/helpers}}
         // increment test count per execution
         $this->currentTestRun++;
         $this->executePreConditions();