MQE-1561: CreateData action must be able to parse Data entity which references another data

- Added phpdoc blocks

Author: okolesnyk

src/Magento/FunctionalTestingFramework/DataGenerator/Util/GenerationDataReferenceResolver.php

@@ -10,9 +10,15 @@
 use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 
+/**
+ * Class resolves data references in data entities while generating static test files.
+ */
 class GenerationDataReferenceResolver implements DataReferenceResolverInterface
 {
     /**
+     * Returns data uniqueness for data entity field.
+     *
+     *
      * @param string $data
      * @param string $originalDataEntity
      * @return string|null
@@ -44,6 +50,8 @@ public function getDataUniqueness(string $data, string $originalDataEntity)
     }
 
     /**
+     * Returns data by reference if reference exist.
+     *
      * @param string $data
      * @param string $originalDataEntity
      * @return string|null
@@ -69,11 +77,17 @@ public function getDataReference(string $data, string $originalDataEntity)
                 $entityObject = DataObjectHandler::getInstance()->getObject($entity);
                 if ($entityObject === null) {
                     throw new TestReferenceException(
-                        "Could not resolve entity reference \"{$matches['reference']}\" "
-                        . "in Data entity \"{$originalDataEntity}\""
+                        "Could not find data entity by name \"{$entityObject}\" "
+                        . "referenced in Data entity \"{$originalDataEntity}\"" . PHP_EOL
                     );
                 }
                 $entityData = $entityObject->getAllData();
+                if (!isset($entityData[$var])) {
+                    throw new TestReferenceException(
+                        "Could not resolve entity reference \"{$matches['reference']}\" "
+                        . "in Data entity \"{$originalDataEntity}\"" . PHP_EOL
+                    );
+                }
                 $result = $entityData[$var];
         }
 

src/Magento/FunctionalTestingFramework/DataGenerator/Util/RuntimeDataReferenceResolver.php

@@ -11,9 +11,14 @@
 use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 
+/**
+ * Class resolves data references in data entities at the runtime of tests.
+ */
 class RuntimeDataReferenceResolver implements DataReferenceResolverInterface
 {
     /**
+     * Returns data by reference if reference exist.
+     *
      * @param string $data
      * @param string $originalDataEntity
      * @return array|false|string|null
@@ -44,18 +49,26 @@ public function getDataReference(string $data, string $originalDataEntity)
                 $entityObject = DataObjectHandler::getInstance()->getObject($entity);
                 if ($entityObject === null) {
                     throw new TestReferenceException(
-                        "Could not resolve entity reference \"{$matches['reference']}\" "
-                        . "in Data entity \"{$originalDataEntity}\""
+                        "Could not find data entity by name \"{$entityObject}\" "
+                        . "referenced in Data entity \"{$originalDataEntity}\"" . PHP_EOL
                     );
                 }
                 $entityData = $entityObject->getAllData();
+                if (!isset($entityData[$var])) {
+                    throw new TestReferenceException(
+                        "Could not resolve entity reference \"{$matches['reference']}\" "
+                        . "in Data entity \"{$originalDataEntity}\"" . PHP_EOL
+                    );
+                }
                 $result = $entityData[$var];
         }
 
         return $result;
     }
 
     /**
+     * Returns data uniqueness for data entity field.
+     *
      * @param string $data
      * @param string $originalDataEntity
      * @return string|null