MQE-588: CreatedData should throw Error/Warning when undefined data is returned

- changed to print warning message for backward compatibility

Author: jilu1

dev/tests/unit/Magento/FunctionalTestFramework/DataGenerator/Handlers/PersistedObjectHandlerTest.php

@@ -16,12 +16,22 @@
 use Magento\FunctionalTestingFramework\ObjectManager;
 use Magento\FunctionalTestingFramework\ObjectManagerFactory;
 use Magento\FunctionalTestingFramework\Util\MagentoTestCase;
+use tests\unit\Util\TestLoggingUtil;
 
 /**
  * Class PersistedObjectHandlerTest
  */
 class PersistedObjectHandlerTest extends MagentoTestCase
 {
+    /**
+     * Before test functionality
+     * @return void
+     */
+    public function setUp()
+    {
+        TestLoggingUtil::getInstance()->setMockLoggingUtil();
+    }
+
     public function testCreateSimpleEntity()
     {
         // Test Data and Variables
@@ -389,6 +399,8 @@ public function testRetrieveEntityValidField($name, $key, $value, $type, $scope,
     public function testRetrieveEntityInValidField($name, $key, $value, $type, $scope, $stepKey)
     {
         $invalidDataKey = "invalidDataKey";
+        $warnMsg = "Undefined field {$invalidDataKey} in entity object with a stepKey of {$stepKey}\n";
+        $warnMsg .= "Please fix the invalid reference. This will result in fatal error in next major release.";
 
         $parserOutputOne = [
             'entity' => [
@@ -416,10 +428,15 @@ public function testRetrieveEntityInValidField($name, $key, $value, $type, $scop
         $this->mockCurlHandler($jsonReponseOne);
         $handler->createEntity($stepKey, $scope, $name);
 
-        $this->expectException(\Magento\FunctionalTestingFramework\Exceptions\TestReferenceException::class);
-
         // Call method
         $handler->retrieveEntityField($stepKey, $invalidDataKey, $scope);
+
+        // validate log statement
+        TestLoggingUtil::getInstance()->validateMockLogStatement(
+            "warning",
+            $warnMsg,
+            []
+        );
     }
 
     /**
@@ -478,4 +495,14 @@ public function tearDown()
 
         parent::tearDown(); // TODO: Change the autogenerated stub
     }
+
+    /**
+     * After class functionality
+     * @return void
+     */
+    public static function tearDownAfterClass()
+    {
+        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
+        parent::tearDownAfterClass();
+    }
 }

src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/PersistedObjectHandler.php

@@ -9,6 +9,7 @@
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;
+use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
 
 class PersistedObjectHandler
 {
@@ -178,14 +179,16 @@ public function getEntity($key, $scope, $entity, $dependentObjectKeys = [], $sto
      * @param string $field
      * @param string $scope
      * @return string
-     * @throws TestReferenceException
-     * @throws TestFrameworkException
      */
     public function retrieveEntityField($stepKey, $field, $scope)
     {
         $fieldValue = $this->retrieveEntity($stepKey, $scope)->getCreatedDataByName($field);
         if ($fieldValue === null) {
-            throw new TestReferenceException("Undefined field {$field} in entity object with a stepKey of {$stepKey}");
+            $warnMsg = "Undefined field {$field} in entity object with a stepKey of {$stepKey}\n";
+            $warnMsg .= "Please fix the invalid reference. This will result in fatal error in next major release.";
+            //TODO: change this to throw an exception in next major release
+            LoggingUtil::getInstance()->getLogger(PersistedObjectHandler::class)->warn($warnMsg);
+            print($warnMsg . PHP_EOL);
         }
         return $fieldValue;
     }