MQE-251:[Data Input] Change Data Accessor classes to implement interface

    - change classes to be defined implementations of DataHandler Interface
    - change references to DataHandler interfaces to reference new classes
    - change logic in ActionObject to consolidate parameter resolution.

Author: imeron2433

etc/di.xml

@@ -82,12 +82,12 @@
 
     <virtualType name="Magento\AcceptanceTestFramework\Config\SchemaLocator\Page" type="Magento\AcceptanceTestFramework\Config\SchemaLocator">
         <arguments>
-            <argument name="schemaPath" xsi:type="string">Magento/AcceptanceTestFramework/PageObject/etc/PageObject.xsd</argument>
+            <argument name="schemaPath" xsi:type="string">Magento/AcceptanceTestFramework/Page/etc/PageObject.xsd</argument>
         </arguments>
     </virtualType>
     <virtualType name="Magento\AcceptanceTestFramework\Config\SchemaLocator\Section" type="Magento\AcceptanceTestFramework\Config\SchemaLocator">
         <arguments>
-            <argument name="schemaPath" xsi:type="string">Magento/AcceptanceTestFramework/PageObject/etc/SectionObject.xsd</argument>
+            <argument name="schemaPath" xsi:type="string">Magento/AcceptanceTestFramework/Page/etc/SectionObject.xsd</argument>
         </arguments>
     </virtualType>
     <virtualType name="Magento\AcceptanceTestFramework\Config\Reader\Page" type="Magento\AcceptanceTestFramework\Config\Reader\Filesystem">
@@ -176,7 +176,7 @@
 
     <!-- Configuration for Data Operation Metadata.xml -->
 
-    <type name="Magento\AcceptanceTestFramework\DataGenerator\Parsers\MetadataParser">
+    <type name="Magento\AcceptanceTestFramework\DataGenerator\Parsers\OperationMetadataParser">
         <arguments>
             <argument name="metadata" xsi:type="object">Magento\AcceptanceTestFramework\DataProfile\Config\Metadata</argument>
         </arguments>
@@ -197,9 +197,9 @@
             <argument name="converter" xsi:type="object">Magento\AcceptanceTestFramework\Config\Converter</argument>
             <argument name="schemaLocator" xsi:type="object">Magento\AcceptanceTestFramework\Config\SchemaLocator\Metadata</argument>
             <argument name="idAttributes" xsi:type="array">
-                <item name="/config/metadata" xsi:type="string">name</item>
-                <item name="/config/metadata/entry" xsi:type="string">key</item>
-                <item name="/config/metadata/array" xsi:type="string">key</item>
+                <item name="/config/operation" xsi:type="string">name</item>
+                <item name="/config/operation/entry" xsi:type="string">key</item>
+                <item name="/config/operation/array" xsi:type="string">key</item>
             </argument>
             <argument name="fileName" xsi:type="string">*-meta.xml</argument>
             <argument name="defaultScope" xsi:type="string">Metadata</argument>

src/Magento/AcceptanceTestFramework/DataGenerator/Api/ApiExecutor.php

@@ -2,21 +2,37 @@
 
 namespace Magento\AcceptanceTestFramework\DataGenerator\Api;
 
-use Magento\AcceptanceTestFramework\DataGenerator\Managers\DataManager;
-use Magento\AcceptanceTestFramework\DataGenerator\Managers\JsonDefinitionManager;
+use Magento\AcceptanceTestFramework\DataGenerator\Handlers\DataObjectHandler;
+use Magento\AcceptanceTestFramework\DataGenerator\Handlers\JsonDefinitionObjectHandler;
 use Magento\AcceptanceTestFramework\DataGenerator\Objects\EntityDataObject;
+use Magento\AcceptanceTestFramework\DataGenerator\Objects\JsonDefinition;
 use Magento\AcceptanceTestFramework\Util\ApiClientUtil;
 
 class ApiExecutor
 {
+    /**
+     * Describes the operation for the executor ('create','update','delete')
+     * @var string $operation
+     **/
     private $operation;
+
+    /**
+     * 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;
 
-    private $primitives = ['string', 'boolean', 'integer', 'double', 'array'];
+    const PRIMITIVE_TYPES = ['string', 'boolean', 'integer', 'double', 'array'];
 
     /**
      * ApiSubObject constructor.
+     * @constructor
      * @param string $operation
      * @param EntityDataObject $entityObject
      */
@@ -25,12 +41,16 @@ public function __construct($operation, $entityObject)
         $this->operation = $operation;
         $this->entityObject = $entityObject;
 
-        $this->jsonDefinition = JsonDefinitionManager::getInstance()->getJsonDefinition(
+        $this->jsonDefinition = JsonDefinitionObjectHandler::getInstance()->getJsonDefinition(
             $this->operation,
             $this->entityObject->getType()
         );
     }
 
+    /**
+     * Executes an api request based on parameters given by constructor.
+     * @return string | null
+     */
     public function executeRequest()
     {
         $apiClientUrl = $this->jsonDefinition->getApiUrl();
@@ -91,23 +111,23 @@ private function getAuthorizationHeader($authUrl)
      * recursively forming an array which represents the json structure for the api of the desired type.
      *
      * @param EntityDataObject $entityObject
-     * @param Array $jsonDefMetadata
+     * @param array $jsonDefMetadata
      *
      * @return array
      */
     private function getJsonDataArray($entityObject, $jsonDefMetadata = null)
     {
-        $jsonArrayMetadata = !$jsonDefMetadata ? JsonDefinitionManager::getInstance()->getJsonDefinition(
+        $jsonArrayMetadata = !$jsonDefMetadata ? JsonDefinitionObjectHandler::getInstance()->getJsonDefinition(
             $this->operation,
             $entityObject->getType()
         )->getJsonMetadata() : $jsonDefMetadata;
 
-        $jsonArray = array();
+        $jsonArray = [];
 
         foreach ($jsonArrayMetadata as $jsonElement) {
             $jsonElementType = $jsonElement->getValue();
 
-            if (in_array($jsonElementType, $this->primitives)) {
+            if (in_array($jsonElementType, ApiExecutor::PRIMITIVE_TYPES)) {
                 $jsonArray[$jsonElement->getKey()] = $this->castValue(
                     $jsonElementType,
                     $entityObject->getDataByName($jsonElement->getKey())
@@ -116,7 +136,7 @@ private function getJsonDataArray($entityObject, $jsonDefMetadata = null)
                 $entityNamesOfType = $entityObject->getLinkedEntitiesOfType($jsonElementType);
 
                 foreach ($entityNamesOfType as $entityName) {
-                    $linkedEntityObj = DataManager::getInstance()->getEntity($entityName);
+                    $linkedEntityObj = DataObjectHandler::getInstance()->getObject($entityName);
                     $jsonDataSubArray = self::getJsonDataArray($linkedEntityObj);
 
                     if ($jsonElement->getType() == 'array') {
@@ -131,13 +151,24 @@ private function getJsonDataArray($entityObject, $jsonDefMetadata = null)
         return $jsonArray;
     }
 
-    private function getEncodedJsonString()
+    /**
+     * This function retrieves an array representative of json body for a request and returns it encoded as a string.
+     * @return string
+     */
+    public function getEncodedJsonString()
     {
         $jsonArray = $this->getJsonDataArray($this->entityObject, $this->jsonDefinition->getJsonMetadata());
 
         return json_encode([$this->entityObject->getType() => $jsonArray], JSON_PRETTY_PRINT);
     }
 
+    /**
+     * This function takes a string value and its corresponding type and returns the string cast
+     * into its the type passed.
+     * @param string $type
+     * @param string $value
+     * @return bool|float|int|string
+     */
     private function castValue($type, $value)
     {
         $newVal = $value;
@@ -158,4 +189,4 @@ private function castValue($type, $value)
 
         return $newVal;
     }
-}
+}

src/Magento/AcceptanceTestFramework/DataGenerator/Api/EntityApiHandler.php

@@ -6,18 +6,32 @@
 
 class EntityApiHandler
 {
+    /**
+     * Entity object data to use for create, delete, or update.
+     * @var EntityDataObject $entityObject
+     */
     private $entityObject;
+
+    /**
+     * Resulting created object from create or update.
+     * @var EntityDataObject $createdObject
+     */
     private $createdObject;
 
     /**
      * ApiPersistenceHandler constructor.
+     * @constructor
      * @param EntityDataObject $entityObject
      */
     public function __construct($entityObject)
     {
         $this->entityObject = $entityObject;
     }
 
+    /**
+     * Function which executes a create request based on specific operation metadata
+     * @return string | false
+     */
     public function createEntity()
     {
         $apiExecutor = new ApiExecutor('create', $this->entityObject);
@@ -29,8 +43,14 @@ public function createEntity()
             json_decode($result, true),
             null
         );
+
+        return $result;
     }
 
+    /**
+     * Function which executes a delete request based on specific operation metadata
+     * @return string | false
+     */
     public function deleteEntity()
     {
         $apiExecutor = new ApiExecutor('delete', $this->createdObject);