Merge pull request #145 from magento-arcticfoxes/MQE-2575

MQE-2575: Allow MFTF Helpers to Return Data to MFTF Test

Author: okolesnyk

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

@@ -46,4 +46,15 @@ public function goTo(
         print('$bla = ' . $bla . PHP_EOL);
         print('array $arraysomething = [' . implode(', ', $arraysomething) . ']' . PHP_EOL);
     }
+
+    /**
+     * Returns value of provided param $text
+     *
+     * @param string $text
+     * @return string
+     */
+    public function getText(string $text): string
+    {
+        return $text;
+    }
 }

dev/tests/functional/tests/MFTF/DevDocs/Test/DevDocsTest.xml

@@ -42,6 +42,14 @@
             <argument name="int">987</argument>
         </helper>
 
+        <helper class="\MFTF\DevDocs\Helper\CustomHelper" method="getText" stepKey="getText">
+            <argument name="text">some text</argument>
+        </helper>
+        <assertEquals stepKey="assertHelperReturnValue" message="Method getText of CustomHelper should return value which may be used as variable in test">
+            <expectedResult type="string">some text</expectedResult>
+            <actualResult type="variable">getText</actualResult>
+        </assertEquals>
+
         <actionGroup ref="HelperActionGroup" stepKey="actionGroupWithCustomHelper">
             <argument name="test" value="{{HelperData.entityField}}" />
             <argument name="entityTest" value="HelperData" />

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -898,7 +898,12 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                         $stepKey,
                         $customActionAttributes['class'] . '::' . $customActionAttributes['method']
                     );
-                    $testSteps .= $this->wrapFunctionCall($actor, $actionObject, $arguments);
+                    $testSteps .= $this->wrapFunctionCallWithReturnValue(
+                        $stepKey,
+                        $actor,
+                        $actionObject,
+                        $arguments
+                    );
                     break;
                 case "createData":
                     $entity = $customActionAttributes['entity'];
@@ -2016,16 +2021,7 @@ private function addDollarSign($input)
      */
     private function wrapFunctionCall($actor, $action, ...$args)
     {
-        $isFirst = true;
-        $isActionHelper = $action->getType() === 'helper';
-        $actionType = $action->getType();
-        if ($isActionHelper) {
-            $actor = "this->helperContainer->get('" . $action->getCustomActionAttributes()['class'] . "')";
-            $args = $args[0];
-            $actionType = $action->getCustomActionAttributes()['method'];
-        }
-
-        $output = sprintf("\t\t$%s->%s(", $actor, $actionType);
+        $output = sprintf("\t\t$%s->%s(", $actor, $action->getType());
         for ($i = 0; $i < count($args); $i++) {
             if (null === $args[$i]) {
                 continue;
@@ -2046,17 +2042,22 @@ private function wrapFunctionCall($actor, $action, ...$args)
     /**
      * Wrap parameters into a function call with a return value.
      *
-     * @param string $returnVariable
-     * @param string $actor
-     * @param string $action
-     * @param array  ...$args
+     * @param string       $returnVariable
+     * @param string       $actor
+     * @param actionObject $action
+     * @param array        ...$args
      * @return string
      * @throws \Exception
      */
     private function wrapFunctionCallWithReturnValue($returnVariable, $actor, $action, ...$args)
     {
-        $isFirst = true;
-        $output = sprintf("\t\t$%s = $%s->%s(", $returnVariable, $actor, $action->getType());
+        $actionType = $action->getType();
+        if ($actionType === 'helper') {
+            $actor = "this->helperContainer->get('" . $action->getCustomActionAttributes()['class'] . "')";
+            $args = $args[0];
+            $actionType = $action->getCustomActionAttributes()['method'];
+        }
+        $output = sprintf("\t\t$%s = $%s->%s(", $returnVariable, $actor, $actionType);
         for ($i = 0; $i < count($args); $i++) {
             if (null === $args[$i]) {
                 continue;