MQE-233 [Customizability] Update Object Model to handle special behaviors (#3)

* MQE-233 Cleanup

Rebranching and re-publish.

* MQE-233

Cleanup and Rebranching fixes

Author: KevinBKozan

src/Magento/AcceptanceTestFramework/Test/Objects/ActionObject.php

@@ -2,13 +2,18 @@
 
 namespace Magento\AcceptanceTestFramework\Test\Objects;
 
+use Magento\AcceptanceTestFramework\PageObject\Page\Page;
+use Magento\AcceptanceTestFramework\PageObject\Section\Section;
+
 class ActionObject
 {
     private $mergeKey;
     private $type;
     private $actionAttributes = [];
     private $linkedAction;
     private $orderOffset = 0;
+    private $resolvedCustomAttributes = [];
+    private $timeout;
 
     public function __construct($mergeKey, $type, $actionAttributes, $linkedAction = null, $order = 0)
     {
@@ -37,11 +42,13 @@ public function getType()
      * the tag <seeNumberOfElements selector="value1" expected="value2" mergeKey=""/> has 3 attributes,
      * only 2 of which are specific to the 'seeNumberOfElements' tag. As a result this function would
      * return the array would return [selector => value1, expected => value2]
+     * The returned array is also the merged result of the resolved and normal actions, giving
+     * priority to the resolved actions (resolved selector instead of section.element, etc).
      * @return array
      */
     public function getCustomActionAttributes()
     {
-        return $this->actionAttributes;
+        return array_merge($this->actionAttributes, $this->resolvedCustomAttributes);
     }
 
     public function getLinkedAction()
@@ -53,4 +60,46 @@ public function getOrderOffset()
     {
         return $this->orderOffset;
     }
-}
+
+    public function getTimeout()
+    {
+        return $this->timeout;
+    }
+
+    /**
+     * Resolves all references
+     */
+    public function resolveReferences()
+    {
+        if(empty($this->resolvedCustomAttributes)){
+            $this->resolveSelectorReference();
+            $this->resolveUrlReference();
+        }
+    }
+
+    /**
+     * Checks if selector is an attribute, and if the selector refers to a defined section.
+     * If not, assume selector is CSS/xpath literal and leave it be.
+     */
+    private function resolveSelectorReference()
+    {
+        if(array_key_exists('selector', $this->actionAttributes)
+            and array_key_exists(strtok($this->actionAttributes['selector'], '.'), Section::getSection()) ) {
+            list($section, $element) = explode('.', $this->actionAttributes['selector']);
+            $this->resolvedCustomAttributes['selector'] = Section::getElementLocator($section, $element);
+            $this->timeout = Section::getElementTimeOut($section, $element);
+        }
+    }
+
+    /**
+     * Checks if url is an attribute, and if the url given is a defined page.
+     * If not, assume url is literal and leave it be.
+     */
+    private function resolveUrlReference()
+    {
+        if (array_key_exists('url', $this->actionAttributes)
+            and array_key_exists($this->actionAttributes['url'], Page::getPage())) {
+            $this->resolvedCustomAttributes['url'] = $_ENV['MAGENTO_BASE_URL'] . Page::getPageUrl($this->actionAttributes['url']);
+        }
+    }
+}

src/Magento/AcceptanceTestFramework/Test/Objects/TestObject.php

@@ -39,6 +39,7 @@ public function getAnnotations()
     public function getOrderedActions()
     {
         $this->mergeActions();
+        $this->insertWaits();
         return $this->orderedSteps;
     }
 
@@ -50,6 +51,7 @@ public function getOrderedActions()
     private function sortActions()
     {
         foreach ($this->parsedSteps as $parsedStep) {
+            $parsedStep->resolveReferences();
             if ($parsedStep->getLinkedAction()) {
                 $this->stepsToMerge[$parsedStep->getMergeKey()] = $parsedStep;
             } else {
@@ -98,10 +100,30 @@ private function mergeAction($stepToMerge)
             $this->mergeAction($this->stepsToMerge[$linkedStep]);
         }
 
-        $position = array_search($linkedStep, array_keys($this->orderedSteps)) + $stepToMerge->getOrderOffset();
+        $this->insertStep($stepToMerge);
+    }
+
+    /**
+     * Runs through the prepared orderedSteps and calls insertWait if a step requires a wait after it.
+     * @return void
+     */
+    private function insertWaits()
+    {
+        foreach ($this->orderedSteps as $step) {
+
+            if ($step->getTimeout()) {
+                $waitStepAttributes = array('timeout' => $step->getTimeout());
+                $waitStep = new ActionObject($step->getMergeKey() . 'WaitForPageLoad', 'waitForPageLoad', $waitStepAttributes, $step->getMergeKey(), 'after');
+                $this->insertStep($waitStep);
+            }
+        }
+    }
+
+    private function insertStep($stepToMerge)
+    {
+        $position = array_search($stepToMerge->getLinkedAction(), array_keys($this->orderedSteps)) + $stepToMerge->getOrderOffset();
         $previous_items = array_slice($this->orderedSteps, 0, $position, true);
         $next_items = array_slice($this->orderedSteps, $position, null, true);
         $this->orderedSteps = $previous_items + [$stepToMerge->getMergeKey() => $stepToMerge] + $next_items;
     }
-
-}
+}