MQE-541: changed to use stepKey for test step sequencing.

Author: jilu1

dev/tests/verification/Resources/MergeFunctionalCest.txt

@@ -54,6 +54,9 @@ class MergeFunctionalCest
 		$I->fillField("#bar", "Dane");
 		$I->searchAndMultiSelectOption("#foo", ["Jane", "Dane"]);
 		$I->see("#element .Jane");
+		$I->click("#step10MergedInResult");
+		$I->click("#step11MergedInResult");
+		$I->click("#step12MergedInResult");
 	}
 
 	/**

dev/tests/verification/TestModule/Cest/MergeBaseFunctionalCest.xml

@@ -27,6 +27,9 @@
             <fillField stepKey="step3" selector="#username" userInput="step3"/>
             <fillField stepKey="step5" selector="#password" userInput="step5"/>
             <click stepKey="step6" selector=".step6"/>
+            <click stepKey="step10" selector="#step10ShouldNotInResult"/>
+            <click mergeKey="step11" selector="#step11ShouldNotInResult"/>
+            <click stepKey="step12" selector="#step12ShouldNotInResult"/>
         </test>
         <test name="MergedReferencesTest">
             <fillField stepKey="fillField1" selector="{{SampleSection.mergeElement}}" userInput="{{DefaultPerson.mergedField}}"/>

dev/tests/verification/TestModule/Cest/MergeInFunctionalCest.xml

@@ -24,6 +24,9 @@
             <click stepKey="step4" selector="#step4" before="step5"/>
             <click stepKey="step6" remove="true"/>
             <click stepKey="step6Merge" selector="#step6Merged" after="step5"/>
+            <click stepKey="step10" selector="#step10MergedInResult"/>
+            <click mergeKey="step11" selector="#step11MergedInResult"/>
+            <click mergeKey="step12" selector="#step12MergedInResult"/>
             <actionGroup ref="FunctionalActionGroupWithData" stepKey="step8Merge" after="step7Merge"/>
         </test>
     </cest>

src/Magento/FunctionalTestingFramework/Config/Dom.php

@@ -6,6 +6,8 @@
 
 namespace Magento\FunctionalTestingFramework\Config;
 
+use Magento\FunctionalTestingFramework\Util\GlobalConstants;
+
 /**
  * Magento configuration XML DOM utility
  */
@@ -222,6 +224,12 @@ protected function getNodePathByParent(\DOMElement $node, $parentPath)
                 if ($value = $node->getAttribute($idAttributeValue)) {
                     $path .= "[@{$idAttributeValue}='{$value}']";
                     break;
+                } elseif (empty($value) && $idAttributeValue === GlobalConstants::TEST_ID_ATTRIBUTE) {
+                    $idAttributeValue = GlobalConstants::DEPRECATED_TEST_ID_ATTRIBUTE;
+                    if ($value = $node->getAttribute($idAttributeValue)) {
+                        $path .= "[@{$idAttributeValue}='{$value}']";
+                        break;
+                    }
                 }
             }
         }

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

@@ -8,15 +8,13 @@
 
 use Magento\FunctionalTestingFramework\Config\ConverterInterface;
 use Magento\FunctionalTestingFramework\Config\Dom\ArrayNodeConfig;
+use Magento\FunctionalTestingFramework\Util\GlobalConstants;
 
 /**
  * Universal converter of any XML data to an array representation with no data loss
  */
 class Flat implements ConverterInterface
 {
-    const UNIQUE_KEY = 'stepKey';
-    const DEPRECATED_UNIQUE_KEY = 'mergeKey';
-
     /**
      * Array node configuration.
      *
@@ -88,9 +86,11 @@ public function convertXml(\DOMNode $source, $basePath = '')
                 }
 
                 $nodeData = $this->convertXml($node, $nodePath);
-                if (!isset($nodeData[self::UNIQUE_KEY]) && isset($nodeData[self::DEPRECATED_UNIQUE_KEY])) {
-                    $nodeData[self::UNIQUE_KEY] = $nodeData[self::DEPRECATED_UNIQUE_KEY];
-                    unset($nodeData[self::DEPRECATED_UNIQUE_KEY]);
+                if (!isset($nodeData[GlobalConstants::TEST_ID_ATTRIBUTE])
+                        && isset($nodeData[GlobalConstants::DEPRECATED_TEST_ID_ATTRIBUTE])) {
+                    $nodeData[GlobalConstants::TEST_ID_ATTRIBUTE] =
+                        $nodeData[GlobalConstants::DEPRECATED_TEST_ID_ATTRIBUTE];
+                    unset($nodeData[GlobalConstants::DEPRECATED_TEST_ID_ATTRIBUTE]);
                 }
                 if ($isArrayNode) {
                     if ($isNumericArrayNode) {

src/Magento/FunctionalTestingFramework/Util/GlobalConstants.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\FunctionalTestingFramework\Util;
+
+final class GlobalConstants
+{
+    /**
+     * A new id attribute that needs special handling to maintain backward compatibility.
+     */
+    const TEST_ID_ATTRIBUTE = 'stepKey';
+
+    /**
+     * The old attribute that should still work as an id attribute.
+     */
+    const DEPRECATED_TEST_ID_ATTRIBUTE = 'mergeKey';
+
+    /**
+     * GlobalConstants constructor.
+     *
+     * Make this private so it cannot be instantiated.
+     */
+    private function __construct()
+    {
+    }
+}