Merge branch 'sprint-develop' of github.com:magento-pangolin/magento2-acceptance-test-framework into MQE-148

# Conflicts:
#	src/Magento/AcceptanceTestFramework/DataGenerator/Api/ApiExecutor.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Api/EntityApiHandler.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Managers/DataManager.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Managers/JsonDefinitionManager.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Objects/EntityDataObject.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Objects/JsonDefinition.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Objects/JsonElement.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Parsers/DataProfileSchemaParser.php
#	src/Magento/AcceptanceTestFramework/DataGenerator/Parsers/OperationMetadataParser.php
#	src/Magento/AcceptanceTestFramework/PageObject/Page/Page.php
#	src/Magento/AcceptanceTestFramework/PageObject/Page/PageInterface.php
#	src/Magento/AcceptanceTestFramework/PageObject/Section/Section.php
#	src/Magento/AcceptanceTestFramework/PageObject/Section/SectionInterface.php
#	src/Magento/AcceptanceTestFramework/Test/CestDataConstants.php
#	src/Magento/AcceptanceTestFramework/Test/Handlers/CestObjectHandler.php
#	src/Magento/AcceptanceTestFramework/Test/Objects/ActionObject.php
#	src/Magento/AcceptanceTestFramework/Test/Objects/CestHookObject.php
#	src/Magento/AcceptanceTestFramework/Test/Objects/TestObject.php
#	src/Magento/AcceptanceTestFramework/Test/TestDataParser.php
#	src/Magento/AcceptanceTestFramework/Util/ApiClientUtil.php
#	src/Magento/AcceptanceTestFramework/XmlParser/PageParser.php

Author: okolesnyk

.env.example

@@ -7,8 +7,7 @@
         "php": "~7.0",
         "codeception/codeception": "2.2|2.3",
         "flow/jsonpath": ">0.2",
-        "fzaninotto/faker": "^1.6",
-        "vlucas/phpdotenv": "~2.4"
+        "fzaninotto/faker": "^1.6"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "1.5.3",

bootstrap.php

@@ -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>

composer.json

@@ -1,47 +1,38 @@
 <?php
-/**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
+
 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
 {
     /**
-     * Entity operation root tag.
-     *
-     * @var string
-     */
+     * Describes the operation for the executor ('create','update','delete')
+     * @var string $operation
+     **/
     private $operation;
 
     /**
-     * Entity data object
-     *
-     * @var EntityDataObject
+     * The entity object data being created, updated, or deleted.
+     * @var EntityDataObject $entityObject
      */
     private $entityObject;
 
     /**
-     * Json definition of an object.
-     *
-     * @var \Magento\AcceptanceTestFramework\DataGenerator\Objects\JsonDefinition
+     * The json definitions used to map the operation.
+     * @var JsonDefinition $jsonDefinition
      */
     private $jsonDefinition;
 
-    /**
-     * Primitive types for casting values.
-     *
-     * @var array
-     */
-    private $primitives = ['string', 'boolean', 'integer', 'double', 'array'];
+    const PRIMITIVE_TYPES = ['string', 'boolean', 'integer', 'double', 'array'];
 
     /**
      * ApiSubObject constructor.
+     * @constructor
      * @param string $operation
      * @param EntityDataObject $entityObject
      */
@@ -50,16 +41,15 @@ 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()
         );
     }
 
     /**
-     * Method responsible for execution requests.
-     *
-     * @return string|bool
+     * Executes an api request based on parameters given by constructor.
+     * @return string | null
      */
     public function executeRequest()
     {
@@ -127,7 +117,7 @@ private function getAuthorizationHeader($authUrl)
      */
     private function getJsonDataArray($entityObject, $jsonDefMetadata = null)
     {
-        $jsonArrayMetadata = !$jsonDefMetadata ? JsonDefinitionManager::getInstance()->getJsonDefinition(
+        $jsonArrayMetadata = !$jsonDefMetadata ? JsonDefinitionObjectHandler::getInstance()->getJsonDefinition(
             $this->operation,
             $entityObject->getType()
         )->getJsonMetadata() : $jsonDefMetadata;
@@ -137,7 +127,7 @@ private function getJsonDataArray($entityObject, $jsonDefMetadata = null)
         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())
@@ -146,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') {
@@ -162,24 +152,22 @@ private function getJsonDataArray($entityObject, $jsonDefMetadata = null)
     }
 
     /**
-     * Encodes data to json string.
-     *
+     * This function retrieves an array representative of json body for a request and returns it encoded as a string.
      * @return string
      */
-    private function getEncodedJsonString()
+    public function getEncodedJsonString()
     {
         $jsonArray = $this->getJsonDataArray($this->entityObject, $this->jsonDefinition->getJsonMetadata());
 
         return json_encode([$this->entityObject->getType() => $jsonArray], JSON_PRETTY_PRINT);
     }
 
-    // @codingStandardsIgnoreStart
     /**
-     * Casting value based on type.
-     *
+     * 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 mixed
+     * @return bool|float|int|string
      */
     private function castValue($type, $value)
     {
@@ -201,5 +189,4 @@ private function castValue($type, $value)
 
         return $newVal;
     }
-    // @codingStandardsIgnoreEnd
 }

etc/di.xml

@@ -1,8 +1,4 @@
 <?php
-/**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
 
 namespace Magento\AcceptanceTestFramework\DataGenerator\Api;
 
@@ -11,21 +7,20 @@
 class EntityApiHandler
 {
     /**
-     * Original data object.
-     *
-     * @var EntityDataObject
+     * Entity object data to use for create, delete, or update.
+     * @var EntityDataObject $entityObject
      */
     private $entityObject;
 
     /**
-     * New data object.
-     *
-     * @var EntityDataObject
+     * Resulting created object from create or update.
+     * @var EntityDataObject $createdObject
      */
     private $createdObject;
 
     /**
      * ApiPersistenceHandler constructor.
+     * @constructor
      * @param EntityDataObject $entityObject
      */
     public function __construct($entityObject)
@@ -34,9 +29,8 @@ public function __construct($entityObject)
     }
 
     /**
-     * Method responsible for creating entity.
-     *
-     * @return void
+     * Function which executes a create request based on specific operation metadata
+     * @return string | false
      */
     public function createEntity()
     {
@@ -49,12 +43,13 @@ public function createEntity()
             json_decode($result, true),
             null
         );
+
+        return $result;
     }
 
     /**
-     * Method responsible for deleting entity.
-     *
-     * @return bool|string
+     * Function which executes a delete request based on specific operation metadata
+     * @return string | false
      */
     public function deleteEntity()
     {