MQE-241:[CAP] Add .env parameter support

    - add logic for creating _ENV EntityDataObject
    - add logic for populating _ENV EntityDataObject with env var from .env file
    - change Action Object resolution so multiple params can be deind in url and userInput.
    - change Action Object resolution so url will resolve both Page and Env references.
    - remove explicit url reference appending from action object
    - support data inputs from types such as parameterArray

Author: imeron2433

src/Magento/AcceptanceTestFramework/DataGenerator/Managers/DataManager.php

@@ -13,15 +13,21 @@ class DataManager
     private $data = []; // an array of entity names to the entity data objects themselves
     private $arrayData;
     private static $dataManager;
+    const ENV_DATA_OBJECT_NAME = '_ENV';
 
+    /**
+     * Singleton method to access instance of DataManager.
+     * @return DataManager
+     * @throws Exception
+     */
     public static function getInstance()
     {
         if (!self::$dataManager) {
             $entityParser = ObjectManagerFactory::getObjectManager()->create(DataProfileSchemaParser::class);
             $entityParsedData = $entityParser->readDataProfiles();
 
             if (!$entityParsedData) {
-                throw new Exception(sprintf("No entities could be parsed from xml definitions"));
+                throw new Exception("No entities could be parsed from xml definitions");
             }
 
             self::$dataManager = new DataManager($entityParsedData);
@@ -30,14 +36,47 @@ public static function getInstance()
         return self::$dataManager;
     }
 
+    /**
+     * DataManager constructor.
+     * @param array $arrayData
+     */
     private function __construct($arrayData)
     {
         $this->arrayData = $arrayData;
     }
 
+    /**
+     * Adds all .env variables defined in the PROJECT_ROOT as EntityDataObjects. This is to allow resolution
+     * of these variables when referenced in a cest.
+     */
+    private function parseEnvVariables()
+    {
+        $envFilename = PROJECT_ROOT . '/.env';
+
+        if (file_exists($envFilename)) {
+            $envData = [];
+
+            $envFile = file($envFilename);
+
+            foreach ($envFile as $entry) {
+                $params = explode("=", $entry);
+                if (count($params) != 2) {
+                    continue;
+                }
+                $envData[strtolower(trim($params[0]))] = trim($params[1]);
+            }
+
+
+            $envDataObject = new EntityDataObject(self::ENV_DATA_OBJECT_NAME, 'environment', $envData, null);
+            $this->data[$envDataObject->getName()] = $envDataObject;
+        }
+    }
+
+    /**
+     * Parses data xml and extracts all information into EntityDataObject.
+     */
     private function parseDataEntities()
     {
-        $entityObjects = array();
         $entities = $this->arrayData;
 
         foreach ($entities[DataGeneratorConstants::ENTITY_DATA] as $entityName => $entity) {
@@ -85,24 +124,32 @@ private function parseDataEntities()
                 $linkedEntities
             );
 
-            $entityObjects[$entityXmlObject->getName()] = $entityXmlObject;
+            $this->data[$entityXmlObject->getName()] = $entityXmlObject;
 
         }
         unset($entityName);
         unset($entity);
-
-        $this->data = $entityObjects;
     }
 
+    /**
+     * Method returns a single data entity by name based on what is defined in data.xml.
+     * @param $entityName
+     * @return EntityDataObject
+     */
     public function getEntity($entityName)
     {
         return $this->getAllEntities()[$entityName];
     }
 
+    /**
+     * Method returns all data entities read from data.xml into objects.
+     * @return array
+     */
     public function getAllEntities()
     {
         if (!$this->data) {
             $this->parseDataEntities();
+            $this->parseEnvVariables();
         }
 
         return $this->data;

src/Magento/AcceptanceTestFramework/PageObject/Page/Page.php

@@ -25,7 +25,15 @@ class Page implements PageInterface
     public static function getPage($pageName = null)
     {
         self::initPageObjects();
-        return !$pageName ? self::$pageObjects : self::$pageObjects[$pageName];
+        if (!$pageName) {
+            return self::$pageObjects;
+        }
+
+        if (array_key_exists($pageName, self::$pageObjects)) {
+            return self::$pageObjects[$pageName];
+        }
+
+        return null;
     }
 
     /**

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

@@ -8,6 +8,15 @@
 
 class ActionObject
 {
+    /**
+     * @var string $mergeKey
+     * @var string $type
+     * @var array $actionAttributes
+     * @var string $linkedAction
+     * @var int $orderOffset
+     * @var array $resolvedCustomAttributes
+     * @var int timeout
+     */
     private $mergeKey;
     private $type;
     private $actionAttributes = [];
@@ -16,6 +25,16 @@ class ActionObject
     private $resolvedCustomAttributes = [];
     private $timeout;
 
+    const DATA_ENABLED_ATTRIBUTES = ["userInput", "parameterArray"];
+
+    /**
+     * ActionObject constructor.
+     * @param string $mergeKey
+     * @param string $type
+     * @param array $actionAttributes
+     * @param string|null $linkedAction
+     * @param int $order
+     */
     public function __construct($mergeKey, $type, $actionAttributes, $linkedAction = null, $order = 0)
     {
         $this->mergeKey = $mergeKey;
@@ -28,11 +47,19 @@ public function __construct($mergeKey, $type, $actionAttributes, $linkedAction =
         }
     }
 
+    /**
+     * This function returns the string property mergeKey.
+     * @return string
+     */
     public function getMergeKey()
     {
         return $this->mergeKey;
     }
 
+    /**
+     * This function returns the string property type.
+     * @return string
+     */
     public function getType()
     {
         return $this->type;
@@ -52,16 +79,29 @@ public function getCustomActionAttributes()
         return array_merge($this->actionAttributes, $this->resolvedCustomAttributes);
     }
 
+    /**
+     * This function returns the string property linkedAction, describing a step to reference for a merge.
+     * @return string
+     */
     public function getLinkedAction()
     {
         return $this->linkedAction;
     }
 
+    /**
+     * This function returns the int property orderOffset, describing before or after for a merge.
+     * @return int
+     */
     public function getOrderOffset()
     {
         return $this->orderOffset;
     }
 
+    /**
+     * This function returns the int property timeout, this can be set as a result of the use of a section element
+     * requiring a wait.
+     * @return int
+     */
     public function getTimeout()
     {
         return $this->timeout;
@@ -81,7 +121,7 @@ public function resolveReferences()
         if (empty($this->resolvedCustomAttributes)) {
             $this->resolveSelectorReferenceAndTimeout();
             $this->resolveUrlReference();
-            $this->resolveUserInputReference();
+            $this->resolveDataInputReferences();
         }
     }
 
@@ -100,9 +140,11 @@ private function resolveSelectorReferenceAndTimeout()
         }
         $selector = $this->actionAttributes['selector'];
 
-        $reference = $this->findReference($selector);
-        if ($reference == null) {
-            // Nothing to replace
+        $reference = $this->findAllReferences($selector);
+        if (count($reference) == 1) {
+            $reference = $reference[0];
+        } else {
+            // Selectors can only handle a single var reference
             return;
         }
 
@@ -112,8 +154,13 @@ private function resolveSelectorReferenceAndTimeout()
             // Bad section reference
             return;
         }
+
         $replacement = Section::getElementLocator($sectionName, $elementName);
 
+        if ($replacement == null) {
+            // Bad section reference
+            return;
+        }
         $this->resolvedCustomAttributes['selector'] = str_replace($reference, $replacement, $selector);
         $this->timeout = Section::getElementTimeOut($sectionName, $elementName);
     }
@@ -133,59 +180,70 @@ private function resolveUrlReference()
         }
         $url = $this->actionAttributes['url'];
 
-        $reference = $this->findReference($url);
-        if ($reference == null) {
-            // Nothing to replace
-            return;
-        }
+        foreach ($this->findAllReferences($url) as $reference) {
+            $replacement = null;
 
-        list($pageName) = $this->stripAndSplitReference($reference);
-        $page = Page::getPage($pageName);
-        if ($page == null) {
-            // Bad page reference
-            return;
+            // assume this is a page
+            list($pageName) = $this->stripAndSplitReference($reference);
+            $page = Page::getPage($pageName);
+
+            if ($page != null) {
+                $replacement = Page::getPageUrl($pageName);
+            } else {
+                // try to resolve as data
+                list($entityName, $entityField) = $this->stripAndSplitReference($reference);
+                $replacement = DataManager::getInstance()->getEntity($entityName)->getDataByName($entityField);
+            }
+
+            if ($replacement == null) {
+                continue;
+                // Bad var ref
+            }
+            $url = str_replace($reference, $replacement, $url);
         }
-        $replacement = $_ENV['MAGENTO_BASE_URL'] . Page::getPageUrl($pageName);
 
-        $this->resolvedCustomAttributes['url'] = str_replace($reference, $replacement, $url);
+        $this->resolvedCustomAttributes['url'] = $url;
     }
 
-
     /**
-     * Look up the value for EntityDataObjectName.Key and set it as the userInput attribute in the resolved custom
+     * Look up the value for EntityDataObjectName.Key and set it as the corresponding attribute in the resolved custom
      * attributes.
      *
      * e.g. {{CustomerEntityFoo.FirstName}} becomes Jerry
      *
      * @return void
      */
-    private function resolveUserInputReference()
+    private function resolveDataInputReferences()
     {
-        if (!array_key_exists('userInput', $this->actionAttributes)) {
-            return;
-        }
-        $userInput = $this->actionAttributes['userInput'];
+        $actionAttributeKeys = array_keys($this->actionAttributes);
+        $relevantDataAttributes = array_intersect($actionAttributeKeys, ActionObject::DATA_ENABLED_ATTRIBUTES);
 
-        $reference = $this->findReference($userInput);
-        if ($reference == null) {
-            // Nothing to replace
+        if (empty($relevantDataAttributes)) {
             return;
         }
 
-        list($entityName, $entityKey) = $this->stripAndSplitReference($userInput);
-        $entityObj = DataManager::getInstance()->getEntity($entityName);
-        if ($entityObj == null) {
-            // Bad entity reference
-            return;
-        }
+        foreach ($relevantDataAttributes as $dataAttribute) {
+            $varInput = $this->actionAttributes[$dataAttribute];
 
-        $replacement = $entityObj->getDataByName($entityKey);
-        if ($replacement == null) {
-            // Bad entity.key reference
-            return;
-        }
+            foreach ($this->findAllReferences($varInput) as $reference) {
+                list($entityName, $entityKey) = $this->stripAndSplitReference($reference);
+                $entityObj = DataManager::getInstance()->getEntity($entityName);
+                if ($entityObj == null) {
+                    // Bad entity reference
+                    continue;
+                }
 
-        $this->resolvedCustomAttributes['userInput'] = str_replace($reference, $replacement, $userInput);
+                $replacement = $entityObj->getDataByName($entityKey) ?? null;
+                if ($replacement == null) {
+                    // Bad entity.key reference
+                    return;
+                }
+
+                $varInput  = str_replace($reference, $replacement, $varInput);
+            }
+
+            $this->resolvedCustomAttributes[$dataAttribute] = $varInput;
+        }
     }
 
     /**
@@ -201,16 +259,16 @@ private function stripAndSplitReference($reference)
     }
 
     /**
-     * Return a {{reference.foo}} if it exists in the string.
+     * Return an array of {{reference.foo}} if any exist in the string, otherwise returns an empty array.
      *
      * @param string $str
-     * @return string|null
+     * @return array
      */
-    private function findReference($str)
+    private function findAllReferences($str)
     {
-        preg_match('/{{[\w.]+}}/', $str, $matches);
+        preg_match_all('/{{[\w.]+}}/', $str, $matches);
         if (empty($matches)) {
-            return null;
+            return [];
         } else {
             return $matches[0];
         }