MQE-1964: MFTF Helper - Implementation

 - fix static tests

Author: okolesnyk

dev/tests/functional/tests/MFTF/DevDocs/Helper/CustomHelper.php

@@ -1,13 +1,35 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 
 namespace MFTF\DevDocs\Helper;
 
 use Magento\FunctionalTestingFramework\Helper\Helper;
 
 class CustomHelper extends Helper
 {
-    public function goTo(string $url, $test, array $module = [], $superBla = null, $bla = 'blaValue', array $arraysomething = [])
-    {
+    /**
+     * Custom helper.
+     *
+     * @param string $url
+     * @param float  $test
+     * @param array  $module
+     * @param null   $superBla
+     * @param string $bla
+     * @param array  $arraysomething
+     * @return void
+     */
+    public function goTo(
+        string $url,
+        float $test,
+        array $module = [],
+        $superBla = null,
+        $bla = 'blaValue',
+        array $arraysomething = []
+    ) {
         print("this is it: " . $url . PHP_EOL);
+        sleep(4);
     }
 }

src/Magento/FunctionalTestingFramework/Helper/Helper.php

@@ -1,10 +1,15 @@
 <?php
-
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 
 namespace Magento\FunctionalTestingFramework\Helper;
 
-
+/**
+ * Class Helper to abstract Codeception module class and make possible to add own functionality if needed.
+ */
 class Helper extends \Codeception\Module
 {
     //
-}
+}

src/Magento/FunctionalTestingFramework/Helper/HelperContainer.php

@@ -1,20 +1,39 @@
 <?php
-
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 
 namespace Magento\FunctionalTestingFramework\Helper;
 
-
 use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 
+/**
+ * Class HelperContainer
+ */
 class HelperContainer
 {
+    /**
+     * @var Helper[]
+     */
     private $helpers = [];
 
+    /**
+     * HelperContainer constructor.
+     * @param array $helpers
+     */
     public function __construct(array $helpers = [])
     {
         $this->helpers = $helpers;
     }
 
+    /**
+     * Returns helper object by it's class name.
+     *
+     * @param string $className
+     * @return Helper
+     * @throws TestFrameworkException
+     */
     public function get(string $className)
     {
         if ($this->has($className)) {
@@ -23,6 +42,12 @@ public function get(string $className)
         throw new TestFrameworkException('Custom helper ' . $className . 'not found.');
     }
 
+    /**
+     * Verifies that helper object exist.
+     *
+     * @param string $className
+     * @return boolean
+     */
     public function has(string $className)
     {
         return array_key_exists($className, $this->helpers);

src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php

@@ -296,8 +296,10 @@ public function resolveReferences()
     }
 
     /**
+     * Resolves references for helpers.
+     *
      * @throws TestReferenceException
-     * @throws XmlException
+     * @return void
      */
     private function resolveHelperReferences()
     {
@@ -308,7 +310,10 @@ private function resolveHelperReferences()
 
         try {
             foreach ($this->actionAttributes as $attrKey => $attrValue) {
-                $this->actionAttributes[$attrKey] = $this->findAndReplaceReferences(SectionObjectHandler::getInstance(), $attrValue);
+                $this->actionAttributes[$attrKey] = $this->findAndReplaceReferences(
+                    SectionObjectHandler::getInstance(),
+                    $attrValue
+                );
             }
             $isResolved = true;
         } catch (\Exception $e) {
@@ -317,7 +322,10 @@ private function resolveHelperReferences()
 
         try {
             foreach ($this->actionAttributes as $attrKey => $attrValue) {
-                $this->actionAttributes[$attrKey] = $this->findAndReplaceReferences(PageObjectHandler::getInstance(), $attrValue);
+                $this->actionAttributes[$attrKey] = $this->findAndReplaceReferences(
+                    PageObjectHandler::getInstance(),
+                    $attrValue
+                );
             }
             $isResolved = true;
         } catch (\Exception $e) {
@@ -326,7 +334,10 @@ private function resolveHelperReferences()
 
         try {
             foreach ($this->actionAttributes as $attrKey => $attrValue) {
-                $this->actionAttributes[$attrKey] = $this->findAndReplaceReferences(DataObjectHandler::getInstance(), $attrValue);
+                $this->actionAttributes[$attrKey] = $this->findAndReplaceReferences(
+                    DataObjectHandler::getInstance(),
+                    $attrValue
+                );
             }
             $isResolved = true;
         } catch (\Exception $e) {
@@ -339,7 +350,6 @@ private function resolveHelperReferences()
                 . "in Action with stepKey \"{$this->getStepKey()}\"",
                 ["input" => $attrValue, "stepKey" => $this->getStepKey()]
             );
-
         }
     }
 

src/Magento/FunctionalTestingFramework/Test/Util/ActionObjectExtractor.php

@@ -176,6 +176,7 @@ private function processActionGroupArgs($actionType, $actionAttributeData)
      * @param string $actionType
      * @param array  $actionAttributeData
      * @return array
+     * @throws TestFrameworkException
      */
     private function processHelperArgs($actionType, $actionAttributeData)
     {
@@ -187,9 +188,12 @@ private function processHelperArgs($actionType, $actionAttributeData)
         $actionAttributeArgData = [];
         foreach ($actionAttributeData as $attributeDataKey => $attributeDataValues) {
             if (isset($attributeDataValues['nodeName']) && $attributeDataValues['nodeName'] == 'argument') {
-                if (isset($attributeDataValues['name']) && in_array($attributeDataValues['name'], $reservedHelperVariableNames)) {
+                if (isset($attributeDataValues['name'])
+                    && in_array($attributeDataValues['name'], $reservedHelperVariableNames)) {
+                    $message = 'Helper argument names ' . implode(',', $reservedHelperVariableNames);
+                    $message .= ' are reserved and can not be used.';
                     throw new TestFrameworkException(
-                        'Helper argument names ' . implode(',', $reservedHelperVariableNames) . ' are reserved and can not be used.'
+                        $message
                     );
                 }
                 $actionAttributeArgData[$attributeDataValues['name']] = $attributeDataValues['value'] ?? null;

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -285,14 +285,21 @@ public function assembleTestPhp($testObject)
         return $cestPhp;
     }
 
+    /**
+     * Generates _injectMethod based on $this->customHelpers.
+     *
+     * @return string
+     */
     private function generateInjectMethod()
     {
         if (empty($this->customHelpers)) {
             return "";
         }
 
         $mustacheEngine = new Mustache_Engine([
-            'loader' => new Mustache_Loader_FilesystemLoader(dirname(__DIR__) . DIRECTORY_SEPARATOR . "Helper" . DIRECTORY_SEPARATOR . 'views')
+            'loader' => new Mustache_Loader_FilesystemLoader(
+                dirname(__DIR__) . DIRECTORY_SEPARATOR . "Helper" . DIRECTORY_SEPARATOR . 'views'
+            )
         ]);
 
         $argumentsWithType = [];