MQE-574: set proper required attributes in test schema and added attribute rule checks in test generator.

Author: jilu1

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -344,8 +344,9 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
         foreach ($stepsObject as $steps) {
             $actor = "I";
             $actionName = $steps->getType();
-            $attribute = null;
+            $stepKey = $steps->getStepKey();
             $customActionAttributes = $steps->getCustomActionAttributes();
+            $attribute = null;
             $selector = null;
             $selector1 = null;
             $selector2 = null;
@@ -377,7 +378,7 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
             $assertDelta = null;
 
             // Validate action attributes and print notice messages on violation.
-            $this->validateXmlAttributesMutuallyExclusive($actionName, $customActionAttributes);
+            $this->validateXmlAttributesMutuallyExclusive($stepKey, $actionName, $customActionAttributes);
 
             if (isset($customActionAttributes['returnVariable'])) {
                 $returnVariable = $customActionAttributes['returnVariable'];
@@ -517,12 +518,11 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
             switch ($actionName) {
                 case "createData":
                     $entity = $customActionAttributes['entity'];
-                    $key = $steps->getStepKey();
                     //Add an informative statement to help the user debug test runs
                     $testSteps .= sprintf(
                         "\t\t$%s->amGoingTo(\"create entity that has the stepKey: %s\");\n",
                         $actor,
-                        $key
+                        $stepKey
                     );
                     //Get Entity from Static data.
                     $testSteps .= sprintf(
@@ -554,17 +554,17 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                     }
 
                     if ($hookObject) {
-                        $createEntityFunctionCall = sprintf("\t\t\$this->%s->createEntity(", $key);
+                        $createEntityFunctionCall = sprintf("\t\t\$this->%s->createEntity(", $stepKey);
                         $dataPersistenceHandlerFunctionCall = sprintf(
                             "\t\t\$this->%s = new DataPersistenceHandler($%s",
-                            $key,
+                            $stepKey,
                             $entity
                         );
                     } else {
-                        $createEntityFunctionCall = sprintf("\t\t\$%s->createEntity(", $key);
+                        $createEntityFunctionCall = sprintf("\t\t\$%s->createEntity(", $stepKey);
                         $dataPersistenceHandlerFunctionCall = sprintf(
                             "\t\t$%s = new DataPersistenceHandler($%s",
-                            $key,
+                            $stepKey,
                             $entity
                         );
                     }
@@ -659,12 +659,11 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                     break;
                 case "getData":
                     $entity = $customActionAttributes['entity'];
-                    $key = $steps->getStepKey();
                     //Add an informative statement to help the user debug test runs
                     $testSteps .= sprintf(
                         "\t\t$%s->amGoingTo(\"get entity that has the stepKey: %s\");\n",
                         $actor,
-                        $key
+                        $stepKey
                     );
                     //Get Entity from Static data.
                     $testSteps .= sprintf(
@@ -696,17 +695,17 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                     }
 
                     if ($hookObject) {
-                        $getEntityFunctionCall = sprintf("\t\t\$this->%s->getEntity(", $key);
+                        $getEntityFunctionCall = sprintf("\t\t\$this->%s->getEntity(", $stepKey);
                         $dataPersistenceHandlerFunctionCall = sprintf(
                             "\t\t\$this->%s = new DataPersistenceHandler($%s",
-                            $key,
+                            $stepKey,
                             $entity
                         );
                     } else {
-                        $getEntityFunctionCall = sprintf("\t\t\$%s->getEntity(", $key);
+                        $getEntityFunctionCall = sprintf("\t\t\$%s->getEntity(", $stepKey);
                         $dataPersistenceHandlerFunctionCall = sprintf(
                             "\t\t$%s = new DataPersistenceHandler($%s",
-                            $key,
+                            $stepKey,
                             $entity
                         );
                     }
@@ -1543,11 +1542,12 @@ private function stripQuotes($inStr)
     /**
      * Validate action attributes are either not set at all or only one is set for a given rule.
      *
+     * @param string $key
      * @param string $tagName
      * @param array $attributes
      * @return void
      */
-    private function validateXmlAttributesMutuallyExclusive($tagName, $attributes)
+    private function validateXmlAttributesMutuallyExclusive($key, $tagName, $attributes)
     {
         $rules = [
             [   'attributes' => [
@@ -1588,34 +1588,27 @@ private function validateXmlAttributesMutuallyExclusive($tagName, $attributes)
                 }
             }
             if ($count > 1) {
-                $this->printRuleErrorToConsole($tagName, $rule['attributes']);
+                $this->printRuleErrorToConsole($key, $tagName, $rule['attributes']);
             }
         }
     }
 
     /**
      * Print rule violation message to console.
      *
-     * @param $tagName
-     * @param $attributes
+     * @param string $key
+     * @param string $tagName
+     * @param array $attributes
      * @return void
      */
-    private function printRuleErrorToConsole($tagName, $attributes)
+    private function printRuleErrorToConsole($key, $tagName, $attributes)
     {
         if (empty($tagName) || empty($attributes)) {
             return;
         }
-        $message = "Only one of the attributes: ";
-        $first = true;
-        foreach ($attributes as $attribute) {
-            if ($first) {
-                $message .= '"' . $attribute . '"';
-                $first = false;
-            } else {
-                $message .= ', "' . $attribute . '"';
-            }
-        }
-        $message .= ' can be use for action: "' . $tagName . "\"\n";
+        $message = 'On step with stepKey "' . $key . '", only one of the attributes: "';
+        $message .= implode('", "', $attributes);
+        $message .= '" can be use for action "' . $tagName . "\".\n";
         print $message;
     }
 }