MQE-307: Added ability to persist same entity data multiple times.

jilu1 · jilu1 · commit 803c744401e3 · 2017-09-11T11:54:23.000-05:00
diff --git a/src/Magento/AcceptanceTestFramework/DataGenerator/Api/ApiExecutor.php b/src/Magento/AcceptanceTestFramework/DataGenerator/Api/ApiExecutor.php
@@ -29,23 +29,34 @@ class ApiExecutor
 
     /**
      * The entity object data being created, updated, or deleted.
+     *
      * @var EntityDataObject $entityObject
      */
     private $entityObject;
 
     /**
      * The json definitions used to map the operation.
+     *
      * @var JsonDefinition $jsonDefinition
      */
     private $jsonDefinition;
 
     /**
      * The array of dependentEntities this class can be given. When finding linked entities, APIExecutor
      * uses this repository before looking for static data.
+     *
      * @var array
      */
     private $dependentEntities = [];
 
+    /**
+     * The array of entity name and number of objects being created,
+     * we don't need to track objects in update and delete operations.
+     *
+     * @var array
+     */
+    private static $entitySequences = [];
+
     /**
      * ApiSubObject constructor.
      * @param string $operation
@@ -82,7 +93,10 @@ public function executeRequest()
 
         if (!empty($matchedParams)) {
             foreach ($matchedParams[0] as $paramKey => $paramValue) {
-                $param = $this->entityObject->getDataByName($matchedParams[1][$paramKey]);
+                $param = $this->entityObject->getDataByName(
+                    $matchedParams[1][$paramKey],
+                    EntityDataObject::CEST_UNIQUE_VALUE
+                );
                 $apiClientUrl = str_replace($paramValue, $param, $apiClientUrl);
             }
         }
@@ -139,6 +153,7 @@ private function getAuthorizationHeader($authUrl)
     private function convertJsonArray($entityObject, $jsonArrayMetadata)
     {
         $jsonArray = [];
+        self::incrementSequence($entityObject->getName());
 
         foreach ($jsonArrayMetadata as $jsonElement) {
             if ($jsonElement->getType() == JsonObjectExtractor::JSON_OBJECT_OBJ_NAME) {
@@ -149,23 +164,21 @@ private function convertJsonArray($entityObject, $jsonArrayMetadata)
             $jsonElementType = $jsonElement->getValue();
 
             if (in_array($jsonElementType, ApiExecutor::PRIMITIVE_TYPES)) {
-                $elementData = $entityObject->getDataByName($jsonElement->getKey());
-                $elementUniquenessData = $entityObject->getUniquenessDataByName($jsonElement->getKey());
-                if ($elementUniquenessData) {
-                    if ($elementUniquenessData == 'prefix') {
-                        if (DataObjectHandler::UNIQUENESS_FUNCTION == 'msq') {
-                            $elementData = msq($entityObject->getName().'.' . $jsonElement->getKey()).$elementData;
-                        } elseif (DataObjectHandler::UNIQUENESS_FUNCTION == 'msqs') {
-                            $elementData = msqs($entityObject->getName().'.' . $jsonElement->getKey()).$elementData;
-                        }
-                    } elseif ($elementUniquenessData == 'suffix') {
-                        if (DataObjectHandler::UNIQUENESS_FUNCTION == 'msq') {
-                            $elementData .= msq($entityObject->getName() . '.'. $jsonElement->getKey());
-                        } elseif (DataObjectHandler::UNIQUENESS_FUNCTION == 'msqs') {
-                            $elementData .= msqs($entityObject->getName() . '.'. $jsonElement->getKey());
-                        }
+                $elementData = $entityObject->getDataByName(
+                    $jsonElement->getKey(),
+                    EntityDataObject::CEST_UNIQUE_VALUE
+                );
+
+                if (array_key_exists($jsonElement->getKey(), $entityObject->getUniquenessData())) {
+                    $uniqueData = $entityObject->getUniquenessDataByName($jsonElement->getKey());
+                    if ($uniqueData === 'suffix') {
+                        $elementData .= (string)self::getSequence($entityObject->getName());
+                    } else {
+                        $elementData = (string)self::getSequence($entityObject->getName())
+                            . $elementData;
                     }
                 }
+
                 $jsonArray[$jsonElement->getKey()] = $this->castValue($jsonElementType, $elementData);
             } else {
                 $entityNamesOfType = $entityObject->getLinkedEntitiesOfType($jsonElementType);
@@ -242,6 +255,35 @@ public function getEncodedJsonString()
         return json_encode($jsonMetadataArray, JSON_PRETTY_PRINT);
     }
 
+    /**
+     * Increment an entity's sequence number by 1.
+     *
+     * @param string $entityName
+     * @return void
+     */
+    private static function incrementSequence($entityName)
+    {
+        if (array_key_exists($entityName, self::$entitySequences)) {
+            self::$entitySequences[$entityName]++;
+        } else {
+            self::$entitySequences[$entityName] = 1;
+        }
+    }
+
+    /**
+     * Get the current sequence number for an entity.
+     *
+     * @param string $entityName
+     * @return int
+     */
+    private static function getSequence($entityName)
+    {
+        if (array_key_exists($entityName, self::$entitySequences)) {
+            return self::$entitySequences[$entityName];
+        }
+        return 0;
+    }
+
     // @codingStandardsIgnoreStart
     /**
      * This function takes a string value and its corresponding type and returns the string cast
diff --git a/src/Magento/AcceptanceTestFramework/DataGenerator/Api/EntityApiHandler.php b/src/Magento/AcceptanceTestFramework/DataGenerator/Api/EntityApiHandler.php
@@ -6,12 +6,10 @@
 
 namespace Magento\AcceptanceTestFramework\DataGenerator\Api;
 
-use Codeception\Test\Cest;
 use Magento\AcceptanceTestFramework\Config\Data;
 use Magento\AcceptanceTestFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\AcceptanceTestFramework\DataGenerator\Objects\EntityDataObject;
 use Magento\AcceptanceTestFramework\Test\Handlers\CestObjectHandler;
-use Magento\AcceptanceTestFramework\Test\Managers\CestArrayProcessor;
 use Magento\AcceptanceTestFramework\Util\TestGenerator;
 
 class EntityApiHandler
@@ -57,10 +55,11 @@ public function createEntity()
         $result = $apiExecutor->executeRequest();
 
         $this->createdObject = new EntityDataObject(
-            '__created' . $this->entityObject->getName(),
+            $this->entityObject->getName(),
             $this->entityObject->getType(),
             json_decode($result, true),
-            null
+            null,
+            null // No uniqueness data is needed to be further processed.
         );
     }
 
@@ -93,7 +92,11 @@ public function getCreatedObject()
      */
     public function getCreatedDataByName($dataName)
     {
-        return $this->createdObject->getDataByName($dataName);
+        $data = $this->createdObject->getDataByName($dataName, EntityDataObject::NO_UNIQUE_PROCESS);
+        if (empty($data)) {
+            $data = $this->entityObject->getDataByName($dataName, EntityDataObject::CEST_UNIQUE_VALUE);
+        }
+        return $data;
     }
 
     // TODO add update function
diff --git a/src/Magento/AcceptanceTestFramework/DataGenerator/Handlers/DataObjectHandler.php b/src/Magento/AcceptanceTestFramework/DataGenerator/Handlers/DataObjectHandler.php
@@ -37,7 +37,6 @@ class DataObjectHandler implements ObjectHandlerInterface
     const DATA_ELEMENT_UNIQUENESS_ATTR = 'unique';
     const DATA_ELEMENT_UNIQUENESS_ATTR_VALUE_PREFIX = 'prefix';
     const DATA_ELEMENT_UNIQUENESS_ATTR_VALUE_SUFFIX = 'suffix';
-    const UNIQUENESS_FUNCTION = 'msq';
 
     const ARRAY_VALUES = 'array';
     const ARRAY_ELEMENT_KEY = 'key';
@@ -130,6 +129,7 @@ private function parseEnvVariables()
                 self::ENV_DATA_OBJECT_NAME,
                 'environment',
                 $envData,
+                null,
                 null
             );
             $this->data[$envDataObject->getName()] = $envDataObject;
diff --git a/src/Magento/AcceptanceTestFramework/DataGenerator/Objects/EntityDataObject.php b/src/Magento/AcceptanceTestFramework/DataGenerator/Objects/EntityDataObject.php
@@ -6,6 +6,8 @@
 
 namespace Magento\AcceptanceTestFramework\DataGenerator\Objects;
 
+use Magento\AcceptanceTestFramework\Exceptions\TestFrameworkException;
+
 /**
  * Class EntityDataObject
  */
@@ -39,6 +41,14 @@ class EntityDataObject
      */
     private $data = [];
 
+    const NO_UNIQUE_PROCESS = 0;
+    const SUITE_UNIQUE_VALUE = 1;
+    const CEST_UNIQUE_VALUE = 2;
+    const SUITE_UNIQUE_NOTATION = 3;
+    const CEST_UNIQUE_NOTATION = 4;
+    const SUITE_UNIQUE_FUNCTION = 'msqs';
+    const CEST_UNIQUE_FUNCTION = 'msq';
+
     /**
      * Array of data name and its uniqueness attribute value.
      *
@@ -54,7 +64,7 @@ class EntityDataObject
      * @param array $linkedEntities
      * @param array $uniquenessData
      */
-    public function __construct($entityName, $entityType, $data, $linkedEntities, $uniquenessData = null)
+    public function __construct($entityName, $entityType, $data, $linkedEntities, $uniquenessData)
     {
         $this->name = $entityName;
         $this->type = $entityType;
@@ -108,14 +118,72 @@ public function getData()
      * This function retrieves data from an entity defined in xml.
      *
      * @param string $dataName
+     * @param int $uniDataFormat
      * @return string|null
+     * @throws TestFrameworkException
      */
-    public function getDataByName($dataName)
+    public function getDataByName($dataName, $uniDataFormat)
     {
+        if (!$this->isValidUniqueDataFormat($uniDataFormat)) {
+            throw new TestFrameworkException(
+                sprintf('Invalid unique data format value: %s \n', $uniDataFormat)
+            );
+        }
+
         $name = strtolower($dataName);
 
-        if ($this->data != null && array_key_exists($name, $this->data)) {
-            return $this->data[$name];
+        if ($this->data !== null && array_key_exists($name, $this->data)) {
+            $uniData = $this->getUniquenessDataByName($dataName);
+            if (null === $uniData || $uniDataFormat == self::NO_UNIQUE_PROCESS) {
+                return $this->data[$name];
+            }
+
+            switch ($uniDataFormat) {
+                case self::SUITE_UNIQUE_VALUE:
+                    if (!function_exists(self::SUITE_UNIQUE_FUNCTION)) {
+                        throw new TestFrameworkException(
+                            sprintf(
+                                'Unique data format value: %s can only be used when running cests.\n',
+                                $uniDataFormat
+                            )
+                        );
+                    } elseif ($uniData == 'prefix') {
+                        return msqs($this->getName()) . $this->data[$name];
+                    } else { // $uniData == 'suffix'
+                        return $this->data[$name] . msqs($this->getName());
+                    }
+                    break;
+                case self::CEST_UNIQUE_VALUE:
+                    if (!function_exists(self::CEST_UNIQUE_FUNCTION)) {
+                        throw new TestFrameworkException(
+                            sprintf(
+                                'Unique data format value: %s can only be used when running cests.\n',
+                                $uniDataFormat
+                            )
+                        );
+                    } elseif ($uniData == 'prefix') {
+                        return msq($this->getName()) . $this->data[$name];
+                    } else { // $uniData == 'suffix'
+                        return $this->data[$name] . msq($this->getName());
+                    }
+                    break;
+                case self::SUITE_UNIQUE_NOTATION:
+                    if ($uniData == 'prefix') {
+                        return self::SUITE_UNIQUE_FUNCTION . '("' . $this->getName() . '")' . $this->data[$name];
+                    } else { // $uniData == 'suffix'
+                        return $this->data[$name] . self::SUITE_UNIQUE_FUNCTION . '("' . $this->getName() . '")';
+                    }
+                    break;
+                case self::CEST_UNIQUE_NOTATION:
+                    if ($uniData == 'prefix') {
+                        return self::CEST_UNIQUE_FUNCTION . '("' . $this->getName() . '")' . $this->data[$name];
+                    } else { // $uniData == 'suffix'
+                        return $this->data[$name] . self::CEST_UNIQUE_FUNCTION . '("' . $this->getName() . '")';
+                    }
+                    break;
+                default:
+                    break;
+            }
         }
 
         return null;
@@ -157,4 +225,35 @@ public function getUniquenessDataByName($dataName)
 
         return null;
     }
+
+    /**
+     * This function retrieves uniqueness data.
+     *
+     * @return array|null
+     */
+    public function getUniquenessData()
+    {
+        return $this->uniquenessData;
+    }
+
+    /**
+     * Validate if input value is a valid unique data format.
+     *
+     * @param int $uniDataFormat
+     * @return bool
+     */
+    private function isValidUniqueDataFormat($uniDataFormat)
+    {
+        return in_array(
+            $uniDataFormat,
+            [
+                self::NO_UNIQUE_PROCESS,
+                self::SUITE_UNIQUE_VALUE,
+                self::CEST_UNIQUE_VALUE,
+                self::SUITE_UNIQUE_NOTATION,
+                self::CEST_UNIQUE_NOTATION
+            ],
+            true
+        );
+    }
 }
diff --git a/src/Magento/AcceptanceTestFramework/Exceptions/TestFrameworkException.php b/src/Magento/AcceptanceTestFramework/Exceptions/TestFrameworkException.php
@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\AcceptanceTestFramework\Exceptions;
+
+/**
+ * Class TestFrameworkException
+ */
+class TestFrameworkException extends \Exception
+{
+    /**
+     * TestFrameworkException constructor.
+     * @param string $message
+     */
+    public function __construct($message)
+    {
+        parent::__construct($message);
+    }
+}
diff --git a/src/Magento/AcceptanceTestFramework/Test/Objects/ActionObject.php b/src/Magento/AcceptanceTestFramework/Test/Objects/ActionObject.php
diff --git a/src/Magento/AcceptanceTestFramework/Util/TestGenerator.php b/src/Magento/AcceptanceTestFramework/Util/TestGenerator.php
