MQE-211: Implement exception handling in TestObject.

Author: KevinBKozan

entryPoint.php

@@ -3,5 +3,5 @@
 require_once 'bootstrap.php';
 
 /** @var Magento\AcceptanceTestFramework\Dummy $dummy */
-$dummy = $objectManager->create(\Magento\AcceptanceTestFramework\Dummy::class);
-$dummy->readPageObjects();
+//$dummy = $objectManager->create(\Magento\AcceptanceTestFramework\Dummy::class);
+//$dummy->readPageObjects();

src/Magento/AcceptanceTestFramework/Exceptions/XmlException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Magento\AcceptanceTestFramework\Exceptions;
+
+use Exception;
+
+class XmlException extends Exception
+{
+    public function __construct($message)
+    {
+        parent::__construct($message);
+    }
+
+}

src/Magento/AcceptanceTestFramework/Test/ActionObject.php

@@ -21,9 +21,9 @@ public function __construct($name, $actor, $function, $selector, $parameter, $or
         $this->function = $function;
         $this->selector = $selector;
         $this->parameter = $parameter;
-        $this->linkedAction = $linkedAction;
         $this->returnVariable = $returnVariable;
         $this->userInput = $userInput;
+        $this->linkedAction = $linkedAction;
 
         if ($order == 'after') {
             $this->orderOffset = 1;
@@ -55,11 +55,6 @@ public function getSelector()
         return $this->selector;
     }
 
-    public function getLinkedAction()
-    {
-        return $this->linkedAction;
-    }
-
     public function getReturnVariable()
     {
         return $this->returnVariable;
@@ -70,7 +65,12 @@ public function getUserInput()
         return $this->userInput;
     }
 
-    public function getOrderOffset()
+    public function getLinkedAction()
+    {
+        return $this->linkedAction;
+    }
+
+    public function getOrderOffset(): int
     {
         return $this->orderOffset;
     }

src/Magento/AcceptanceTestFramework/Test/CestDataConstants.php

@@ -23,8 +23,8 @@ class CestDataConstants
     const TEST_ACTION_ACTOR = 'actor';
     const TEST_ACTION_PARAMETER = 'parameter';
     const TEST_ACTION_SELECTOR = 'selector';
-    const TEST_ACTION_ORDER = 'order';
-    const TEST_ACTION_LINK = 'linkedAction';
+    const TEST_ACTION_BEFORE = 'before';
+    const TEST_ACTION_AFTER = 'after';
     const TEST_ACTION_USER_INPUT = 'userInput';
     const TEST_ACTION_RETURN_VARIABLE = 'returnVariable';
 

src/Magento/AcceptanceTestFramework/Test/CestDataManager.php

@@ -3,9 +3,12 @@
 namespace Magento\AcceptanceTestFramework\Test;
 
 use Magento\AcceptanceTestFramework\ObjectManagerFactory;
+use Magento\AcceptanceTestFramework\Exceptions\XmlException;
 
 class CestDataManager
 {
+    const BEFORE_AFTER_ERROR_MSG = "Merge Error - Steps cannot have both before and after attributes.\tTestStep='%s'";
+
     public static function getCestData()
     {
         $cestDataParser = ObjectManagerFactory::getObjectManager()->create(TestDataParser::class);
@@ -135,9 +138,9 @@ private static function extractTestActions($testActions)
             $actor = null;
             $parameter = null;
             $selector = null;
-            $linkedAction = null;
             $userInput = null;
             $returnVariable = null;
+            $linkedAction = null;
             $order = null;
 
             if (array_key_exists(CestDataConstants::TEST_ACTION_ACTOR, $actionData)) {
@@ -150,9 +153,17 @@ private static function extractTestActions($testActions)
                 $selector = $actionData[CestDataConstants::TEST_ACTION_SELECTOR];
             }
 
-            if (array_key_exists(CestDataConstants::TEST_ACTION_LINK, $actionData)) {
-                $linkedAction = $actionData[CestDataConstants::TEST_ACTION_LINK];
-                $order = $actionData [CestDataConstants::TEST_ACTION_ORDER];
+            if (array_key_exists(CestDataConstants::TEST_ACTION_BEFORE, $actionData)
+                and array_key_exists(CestDataConstants::TEST_ACTION_AFTER, $actionData)) {
+                throw new XmlException(sprintf(self::BEFORE_AFTER_ERROR_MSG, $actionName));
+            }
+
+            if (array_key_exists(CestDataConstants::TEST_ACTION_BEFORE, $actionData)) {
+                $linkedAction = $actionData[CestDataConstants::TEST_ACTION_BEFORE];
+                $order = "before";
+            } elseif (array_key_exists(CestDataConstants::TEST_ACTION_AFTER, $actionData)) {
+                $linkedAction = $actionData[CestDataConstants::TEST_ACTION_AFTER];
+                $order = "after";
             }
 
             if (array_key_exists(CestDataConstants::TEST_ACTION_USER_INPUT, $actionData)) {

src/Magento/AcceptanceTestFramework/Test/TestObject.php

@@ -2,6 +2,8 @@
 
 namespace Magento\AcceptanceTestFramework\Test;
 
+use Magento\AcceptanceTestFramework\Exceptions\XmlException;
+
 class TestObject
 {
     private $name;
@@ -10,6 +12,7 @@ class TestObject
     private $parsedSteps = [];
     private $dependencies = [];
     private $annotations = [];
+    private const STEP_MISSING_ERROR_MSG = "Merge Error - Step could not be found in either TestXML or DeltaXML.\tTest = '%s'\tTestStep='%s'\tLinkedStep'%s'";
 
     public function __construct($name, $dependencies, $parsedSteps, $annotations)
     {
@@ -47,6 +50,7 @@ public function getOrderedActions()
     /**
      * This method takes the steps from the parser and splits steps which need merge from steps that are ordered.
      * @return void
+     * @throws XmlException
      */
     private function sortActions()
     {
@@ -79,14 +83,17 @@ private function mergeActions()
     /**
      * Recursively merges in each step and its dependencies
      * @param ActionObject $stepToMerge
+     * @throws XmlException
      * @return void
      */
     private function mergeAction($stepToMerge)
     {
         $linkedStep = $stepToMerge->getLinkedAction();
 
-        if (!array_key_exists($linkedStep, $this->orderedSteps)) {
-            $this->mergeAction($this->stepsToMerge[$stepToMerge->getLinkedAction()]);
+        if (!array_key_exists($linkedStep, $this->orderedSteps) and !array_key_exists($linkedStep, $this->stepsToMerge)) {
+            throw new XmlException(sprintf(self::STEP_MISSING_ERROR_MSG, $this->getName(), $stepToMerge->getName(), $linkedStep));
+        } elseif (!array_key_exists($linkedStep, $this->orderedSteps)) {
+            $this->mergeAction($this->stepsToMerge[$linkedStep]);
         }
 
         $position = array_search($linkedStep, array_keys($this->orderedSteps)) + $stepToMerge->getOrderOffset();

src/Magento/AcceptanceTestFramework/Test/etc/testSchema.xsd

@@ -50,8 +50,8 @@
         <xs:attribute name="returnVariable" type="xs:string" use="optional"></xs:attribute>
         <xs:attribute name="name" type="xs:string" use="required"></xs:attribute>
         <xs:attribute name="userInput" type="xs:string" use="optional"></xs:attribute>
-        <xs:attribute name="order" type="xs:string" use="optional"></xs:attribute>
-        <xs:attribute name="linkedAction" type="xs:string" use="optional"></xs:attribute>
+        <xs:attribute name="before" type="xs:string" use="optional"></xs:attribute>
+        <xs:attribute name="after" type="xs:string" use="optional"></xs:attribute>
         <xs:attributeGroup ref="removeAttribute"/>
     </xs:complexType>