Merge pull request #131 from magento/MQE-1011

MQE-1011: Keyword Comment In User Input For Action Group Substitutes Incorrectly

Author: imeron2433

dev/tests/verification/Resources/ActionGroupContainsStepKeyInArgText.txt

@@ -0,0 +1,42 @@
+<?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 ActionGroupContainsStepKeyInArgTextCest
+{
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _before(AcceptanceTester $I)
+	{
+		$I->see("arg1", ".selector");
+	}
+
+	/**
+	 * @Features({"TestModule"})
+	 * @Parameter(name = "AcceptanceTester", value="$I")
+	 * @param AcceptanceTester $I
+	 * @return void
+	 * @throws \Exception
+	 */
+	public function ActionGroupContainsStepKeyInArgText(AcceptanceTester $I)
+	{
+		$I->see("arg1", ".selector");
+	}
+}

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

@@ -98,4 +98,11 @@
             <requiredEntity createDataKey="createCategory"/>
         </createData>
     </actionGroup>
+
+    <actionGroup name="actionGroupContainsStepKeyInArgValue">
+        <arguments>
+            <argument name="sameStepKeyAsArg" type="string" defaultValue="stringLiteral"/>
+        </arguments>
+        <see selector=".selector" userInput="{{sameStepKeyAsArg}}" stepKey="arg1" />
+    </actionGroup>
 </actionGroups>

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

@@ -143,4 +143,15 @@
             <actionGroup ref="actionGroupWithCreateData" stepKey="Key1"/>
         </before>
     </test>
+
+    <test name="ActionGroupContainsStepKeyInArgText">
+        <before>
+            <actionGroup ref="actionGroupContainsStepKeyInArgValue" stepKey="actionGroup">
+                <argument name="sameStepKeyAsArg" value="arg1"/>
+            </actionGroup>
+        </before>
+        <actionGroup ref="actionGroupContainsStepKeyInArgValue" stepKey="actionGroup">
+            <argument name="sameStepKeyAsArg" value="arg1"/>
+        </actionGroup>
+    </test>
 </tests>

dev/tests/verification/Tests/ActionGroupGenerationTest.php

@@ -173,4 +173,15 @@ public function testActionGroupWithCreateData()
     {
         $this->generateAndCompareTest('ActionGroupUsingCreateData');
     }
+
+    /**
+     * Test an action group with an arg containing stepKey text
+     *
+     * @throws \Exception
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     */
+    public function testActionGroupWithArgContainingStepKey()
+    {
+        $this->generateAndCompareTest('ActionGroupContainsStepKeyInArgText');
+    }
 }

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1385,9 +1385,18 @@ private function resolveStepKeyReferences($input, $actionGroupOrigin)
         $testInvocationKey = ucfirst($actionGroupOrigin[ActionGroupObject::ACTION_GROUP_ORIGIN_TEST_REF]);
 
         foreach ($stepKeys as $stepKey) {
-            if (strpos($output, $stepKey)) {
-                $output = str_replace($stepKey, $stepKey . $testInvocationKey, $output);
+            // MQE-1011
+            $stepKeyVarRef = "$" . $stepKey;
+            $classVarRef = "\$this->$stepKey";
+
+            if (strpos($output, $stepKeyVarRef) !== false) {
+                $output = str_replace($stepKeyVarRef, $stepKeyVarRef . $testInvocationKey, $output);
+            }
+
+            if (strpos($output, $classVarRef) !== false) {
+                $output = str_replace($classVarRef, $classVarRef . $testInvocationKey, $output);
             }
+
         }
         return $output;
     }