MQE-993: ActionGroups that use createData are not generated correctly (#129)

* MQE-993: ActionGroups that use createData are not generated correctly

- Added check in getResolvedActionsWithArgs

* MQE-993: ActionGroups that use createData are not generated correctly

- Abstracted method to private function

* MQE-993: ActionGroups that use createData are not generated correctly

- Removed broken out line in ActionGroupObject

* MQE-993: ActionGroups that use createData are not generated correctly

- Removed nested if

Author: aljcalandra

dev/tests/verification/Resources/ActionGroupUsingCreateData.txt

@@ -0,0 +1,58 @@
+<?php
+namespace Magento\AcceptanceTest\_default\Backend;
+
+use Magento\FunctionalTestingFramework\AcceptanceTester;
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
+use Yandex\Allure\Adapter\Annotation\Features;
+use Yandex\Allure\Adapter\Annotation\Stories;
+use Yandex\Allure\Adapter\Annotation\Title;
+use Yandex\Allure\Adapter\Annotation\Description;
+use Yandex\Allure\Adapter\Annotation\Parameter;
+use Yandex\Allure\Adapter\Annotation\Severity;
+use Yandex\Allure\Adapter\Model\SeverityLevel;
+use Yandex\Allure\Adapter\Annotation\TestCaseId;
+
+/**
+ */
+class ActionGroupUsingCreateDataCest
+{
+	/**
+	  * @var DataPersistenceHandler $createCategoryKey1;
+	  */
+	protected $createCategoryKey1;
+
+	/**
+	  * @var DataPersistenceHandler $createConfigProductKey1;
+	  */
+	protected $createConfigProductKey1;
+
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _before(AcceptanceTester $I)
+	{
+		$I->amGoingTo("create entity that has the stepKey: createCategoryKey1");
+		$ApiCategory = DataObjectHandler::getInstance()->getObject("ApiCategory");
+		$this->createCategoryKey1 = new DataPersistenceHandler($ApiCategory, []);
+		$this->createCategoryKey1->createEntity();
+		$I->amGoingTo("create entity that has the stepKey: createConfigProductKey1");
+		$ApiConfigurableProduct = DataObjectHandler::getInstance()->getObject("ApiConfigurableProduct");
+		$this->createConfigProductKey1 = new DataPersistenceHandler($ApiConfigurableProduct, [$this->createCategoryKey1]);
+		$this->createConfigProductKey1->createEntity();
+	}
+
+	/**
+	 * @Features({"TestModule"})
+	 * @Parameter(name = "AcceptanceTester", value="$I")
+	 * @param AcceptanceTester $I
+	 * @return void
+	 * @throws \Exception
+	 */
+	public function ActionGroupUsingCreateData(AcceptanceTester $I)
+	{
+	}
+}

dev/tests/verification/TestModule/ActionGroup/BasicActionGroup.xml

@@ -91,4 +91,11 @@
     <actionGroup name="extendRemoveTestActionGroup" extends="extendBasicActionGroup">
         <remove keyForRemoval="removeMe"/>
     </actionGroup>
+
+    <actionGroup name="actionGroupWithCreateData">
+        <createData entity="ApiCategory" stepKey="createCategory"/>
+        <createData entity="ApiConfigurableProduct" stepKey="createConfigProduct">
+            <requiredEntity createDataKey="createCategory"/>
+        </createData>
+    </actionGroup>
 </actionGroups>

dev/tests/verification/TestModule/Test/ActionGroupTest.xml

@@ -137,4 +137,10 @@
     <test name="ExtendedRemoveActionGroup">
         <actionGroup ref="extendRemoveTestActionGroup" stepKey="actionGroup"/>
     </test>
+
+    <test name="ActionGroupUsingCreateData">
+        <before>
+            <actionGroup ref="actionGroupWithCreateData" stepKey="Key1"/>
+        </before>
+    </test>
 </tests>

dev/tests/verification/Tests/ActionGroupGenerationTest.php

@@ -162,4 +162,15 @@ public function testExtendedRemoveActionGroup()
     {
         $this->generateAndCompareTest('ExtendedRemoveActionGroup');
     }
+
+    /**
+     * Test generation of a test referencing an action group that uses stepKey references within the action group
+     *
+     * @throws \Exception
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     */
+    public function testActionGroupWithCreateData()
+    {
+        $this->generateAndCompareTest('ActionGroupUsingCreateData');
+    }
 }

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

@@ -136,15 +136,21 @@ private function resolveArguments($arguments)
     private function getResolvedActionsWithArgs($arguments, $actionReferenceKey)
     {
         $resolvedActions = [];
+        $replacementStepKeys = [];
 
         foreach ($this->parsedActions as $action) {
+            $replacementStepKeys[$action->getStepKey()] = $action->getStepKey() . ucfirst($actionReferenceKey);
             $varAttributes = array_intersect($this->varAttributes, array_keys($action->getCustomActionAttributes()));
+
+            // replace createDataKey attributes inside the action group
+            $resolvedActionAttributes = $this->replaceCreateDataKeys($action, $replacementStepKeys);
+
             $newActionAttributes = [];
 
             if (!empty($varAttributes)) {
                 $newActionAttributes = $this->resolveAttributesWithArguments(
                     $arguments,
-                    $action->getCustomActionAttributes()
+                    $resolvedActionAttributes
                 );
             }
 
@@ -159,7 +165,7 @@ private function getResolvedActionsWithArgs($arguments, $actionReferenceKey)
             $resolvedActions[$action->getStepKey() . ucfirst($actionReferenceKey)] = new ActionObject(
                 $action->getStepKey() . ucfirst($actionReferenceKey),
                 $action->getType(),
-                array_replace_recursive($action->getCustomActionAttributes(), $newActionAttributes),
+                array_replace_recursive($resolvedActionAttributes, $newActionAttributes),
                 $action->getLinkedAction() == null ? null : $action->getLinkedAction() . ucfirst($actionReferenceKey),
                 $orderOffset,
                 [self::ACTION_GROUP_ORIGIN_NAME => $this->name,
@@ -432,4 +438,27 @@ function ($e) use ($name) {
         }
         return null;
     }
+
+    /**
+     * Replaces references to step keys used earlier in an action group
+     *
+     * @param ActionObject $action
+     * @param array $replacementStepKeys
+     * @return ActionObject[]
+     */
+    private function replaceCreateDataKeys($action, $replacementStepKeys)
+    {
+        $resolvedActionAttributes = [];
+
+        foreach ($action->getCustomActionAttributes() as $actionAttribute => $actionAttributeDetails) {
+            if (is_array($actionAttributeDetails) && array_key_exists('createDataKey', $actionAttributeDetails)) {
+                $actionAttributeDetails['createDataKey'] =
+                    $replacementStepKeys[$actionAttributeDetails['createDataKey']] ??
+                    $actionAttributeDetails['createDataKey'];
+            }
+            $resolvedActionAttributes[$actionAttribute] = $actionAttributeDetails;
+        }
+
+        return $resolvedActionAttributes;
+    }
 }