MQE-1234: Allow XML Parser to read XML comment into comment action

Author: okolesnyk

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

@@ -10,7 +10,7 @@
         xsi:noNamespaceSchemaLocation="../../../../../../../src/Magento/FunctionalTestingFramework/Test/etc/testSchema.xsd">
     <test name="DevDocsTest">
         <annotations>
-            <!--   Hwello -->
+            <!--   Comment in Annotations for DevDocs Test are not affecting test generation  -->
             <features value="DevDocs available"/>
             <stories value="MFTF DevDocs available"/>
             <title value="Magento Functional Testing Framework Documentation is available."/>
@@ -21,7 +21,6 @@
 
         <!--   Open MFTF DevDocs Page -->
         <amOnPage stepKey="openMFTFDevDocPage" url="{{MFTFDocPage.url}}" />
-        <!--< > & $abc " abc ' <click stepKey="click" userInput="$$createDataHook.firstname$$" selector="#id">/-->
         <actionGroup ref="AdminNavigateMenuActionGroup" stepKey="asdf" />
         <see stepKey="verifyPageIntroText" selector="{{contentSection.pageIntro}}" userInput="Introduction to the Magento Functional Testing Framework" />
     </test>

dev/tests/verification/Resources/ActionGroupWithDefaultArgumentAndStringSelectorParam.txt

@@ -30,6 +30,7 @@ class ActionGroupWithDefaultArgumentAndStringSelectorParamCest
 	public function ActionGroupWithDefaultArgumentAndStringSelectorParam(AcceptanceTester $I)
 	{
 		$I->comment("Entering Action Group [actionGroup] actionGroupWithDefaultArgumentAndStringSelectorParam");
+		$I->comment("< > & \$abc \" abc ' <click stepKey=\"click\" userInput=\"\$\$createDataHook.firstname\$\$\" selector=\"#id\">/");
 		$I->see("John", "#element .test1"); // stepKey: seeFirstNameActionGroup
 		$I->comment("Exiting Action Group [actionGroup] actionGroupWithDefaultArgumentAndStringSelectorParam");
 	}

dev/tests/verification/Resources/ActionGroupWithPassedArgumentAndStringSelectorParam.txt

@@ -30,6 +30,7 @@ class ActionGroupWithPassedArgumentAndStringSelectorParamCest
 	public function ActionGroupWithPassedArgumentAndStringSelectorParam(AcceptanceTester $I)
 	{
 		$I->comment("Entering Action Group [actionGroup] actionGroupWithDefaultArgumentAndStringSelectorParam");
+		$I->comment("< > & \$abc \" abc ' <click stepKey=\"click\" userInput=\"\$\$createDataHook.firstname\$\$\" selector=\"#id\">/");
 		$I->see("John" . msq("UniquePerson"), "#element .test1"); // stepKey: seeFirstNameActionGroup
 		$I->comment("Exiting Action Group [actionGroup] actionGroupWithDefaultArgumentAndStringSelectorParam");
 	}

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

@@ -13,9 +13,12 @@
 
     <actionGroup name="actionGroupWithDefaultArgumentAndStringSelectorParam">
         <arguments>
+            <!--  Comments in arguments are not affecting test generation -->
+            <!--  <argument name="someArgument" defaultValue="ReplacementPerson" />  -->
             <argument name="someArgument" defaultValue="ReplacementPerson" />
         </arguments>
 
+        <!--< > & $abc " abc ' <click stepKey="click" userInput="$$createDataHook.firstname$$" selector="#id">/-->
         <see selector="{{SampleSection.oneParamElement('test1')}}" userInput="{{someArgument.firstname}}" stepKey="seeFirstName" />
     </actionGroup>
 

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

@@ -15,8 +15,11 @@
         <actionGroup ref="actionGroupWithoutArguments" stepKey="actionGroup"/>
     </test>
 
+    <!--< > & $abc " abc ' <click stepKey="click" userInput="$$createDataHook.firstname$$" selector="#id">/-->
     <test name="ActionGroupWithDefaultArgumentAndStringSelectorParam">
         <annotations>
+            <!--  Comments in Test annotations are not affecting test generation  -->
+            <!--  <severity value="BLOCKER"/>  -->
             <severity value="BLOCKER"/>
             <title value="Action Group With Default Argument Value and Hardcoded Value in Param"/>
         </annotations>

src/Magento/FunctionalTestingFramework/Test/Config/Converter/Dom/Flat.php

@@ -125,7 +125,7 @@ public function convertXml(\DOMNode $source, $basePath = '')
                 $value = $node->nodeValue;
                 break;
             } elseif ($node->nodeType == XML_COMMENT_NODE) {
-                $uniqid = uniqid(str_replace("#", "", $node->nodeName));
+                $uniqid = uniqid($node->nodeName);
                 $value[$uniqid] = [
                     'value' => trim($node->nodeValue),
                     'nodeName' => $node->nodeName,

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

@@ -9,6 +9,7 @@
 use Magento\FunctionalTestingFramework\Data\Argument\Interpreter\Argument;
 use Magento\FunctionalTestingFramework\Exceptions\XmlException;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionGroupObject;
+use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 use Magento\FunctionalTestingFramework\Test\Objects\ArgumentObject;
 
 /**
@@ -117,6 +118,10 @@ private function extractArguments($arguments)
             self::NODE_NAME
         );
 
+        $argData = array_filter($argData, function ($key) {
+            return strpos($key, ActionObject::COMMENT_ACTION) === false;
+        }, ARRAY_FILTER_USE_KEY);
+
         foreach ($argData as $argName => $argValue) {
             $parsedArguments[] = new ArgumentObject(
                 $argValue[ArgumentObject::ARGUMENT_NAME],

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

@@ -58,9 +58,10 @@ public function extractActions($testActions, $testName = null)
         $stepKeyRefs = [];
 
         foreach ($testActions as $actionName => $actionData) {
+            //  Removing # from nodeName to match stepKey requirements
             $stepKey = strpos($actionData[self::NODE_NAME], ActionObject::COMMENT_ACTION) === false
                 ? $actionData[self::TEST_STEP_MERGE_KEY]
-                : $actionName;
+                : str_replace("#", "", $actionName);
             $actionType = $actionData[self::NODE_NAME];
 
             if (empty($stepKey)) {

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1306,6 +1306,7 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                     $testSteps .= $this->wrapFunctionCall($actor, $actionObject, $customActionAttributes['state']);
                     break;
                 case "comment":
+                    // Combining userInput from native XML comment and <comment /> action and fall-through 'default' case.
                     $input = $input === null ? strtr($value, ['$' => '\$', '{' => '\{', '}' => '\}']) : $input;
                 default:
                     $testSteps .= $this->wrapFunctionCall(