MQE-1173: [Dev experience] Error on test generation without reference on file

- Added error messaging at Action level
- Extended range of errors caught at Test level
- Added unit tests for Exception catching for TestGenerator and ActionMergeUtil

Author: aljcalandra

dev/tests/unit/Magento/FunctionalTestFramework/Util/ActionMergeUtilTest.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Tests\unit\Magento\FunctionalTestFramework\Test\Handlers;
+
+use AspectMock\Test as AspectMock;
+
+use Go\Aop\Aspect;
+use Magento\FunctionalTestingFramework\ObjectManager;
+use Magento\FunctionalTestingFramework\ObjectManagerFactory;
+use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
+use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
+use Magento\FunctionalTestingFramework\Test\Objects\TestHookObject;
+use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
+use Magento\FunctionalTestingFramework\Test\Parsers\TestDataParser;
+use Magento\FunctionalTestingFramework\Test\Util\ActionMergeUtil;
+use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
+use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
+use Magento\FunctionalTestingFramework\Util\MagentoTestCase;
+use tests\unit\Util\TestDataArrayBuilder;
+
+class ActionMergeUtilTest extends MagentoTestCase
+{
+    /**
+     * Test Exception Handler
+     *
+     * @throws \Exception
+     */
+    public function testMergeActionsException()
+    {
+        $testActionMergeUtil = new ActionMergeUtil(null, null);
+
+        $actionObject = new ActionObject('fakeAction', 'comment', [
+            'userInput' => '{{someEntity.entity}}'
+        ]);
+
+        $this->expectExceptionMessage("Could not resolve entity reference \"{{someEntity.entity}}\" " .
+            "in Action with stepKey \"fakeAction\".\n" .
+            "Exception occurred parsing action at StepKey \"fakeAction\"");
+
+        $testActionMergeUtil->resolveActionSteps(["merge123" => $actionObject]);
+    }
+}

dev/tests/unit/Magento/FunctionalTestFramework/Util/TestGeneratorTest.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Tests\unit\Magento\FunctionalTestFramework\Test\Handlers;
+
+use AspectMock\Test as AspectMock;
+
+use Go\Aop\Aspect;
+use Magento\FunctionalTestingFramework\ObjectManager;
+use Magento\FunctionalTestingFramework\ObjectManagerFactory;
+use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
+use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
+use Magento\FunctionalTestingFramework\Test\Objects\TestHookObject;
+use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
+use Magento\FunctionalTestingFramework\Test\Parsers\TestDataParser;
+use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
+use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
+use Magento\FunctionalTestingFramework\Util\MagentoTestCase;
+use Magento\FunctionalTestingFramework\Util\TestGenerator;
+use tests\unit\Util\TestDataArrayBuilder;
+
+class TestGeneratorTest extends MagentoTestCase
+{
+    /**
+     * Basic test to validate array => test object conversion.
+     *
+     * @throws \Exception
+     */
+    public function testGetTestObject()
+    {
+        $actionObject = new ActionObject('fakeAction', 'comment', [
+            'userInput' => '{{someEntity.entity}}'
+        ]);
+
+        $testObject = new TestObject("sampleTest", ["merge123" => $actionObject], [], [], "filename");
+
+        $testGeneratorObject = TestGenerator::getInstance("", ["sampleTest" => $testObject]);
+
+        AspectMock::double(TestGenerator::class, ['loadAllTestObjects' => ["sampleTest" => $testObject]]);
+
+        $this->expectExceptionMessage("Could not resolve entity reference \"{{someEntity.entity}}\" " .
+            "in Action with stepKey \"fakeAction\".\n" .
+            "Exception occurred parsing action at StepKey \"fakeAction\" in Test \"sampleTest\"");
+
+        $testGeneratorObject->createAllTestFiles(null, []);
+    }
+}

src/Magento/FunctionalTestingFramework/Test/Util/ActionMergeUtil.php

@@ -266,11 +266,19 @@ private function insertReadinessSkips()
     private function sortActions($parsedSteps)
     {
         foreach ($parsedSteps as $parsedStep) {
-            $parsedStep->resolveReferences();
-            if ($parsedStep->getLinkedAction()) {
-                $this->stepsToMerge[$parsedStep->getStepKey()] = $parsedStep;
-            } else {
-                $this->orderedSteps[$parsedStep->getStepKey()] = $parsedStep;
+            try {
+                $parsedStep->resolveReferences();
+
+                if ($parsedStep->getLinkedAction()) {
+                    $this->stepsToMerge[$parsedStep->getStepKey()] = $parsedStep;
+                } else {
+                    $this->orderedSteps[$parsedStep->getStepKey()] = $parsedStep;
+                }
+            } catch (\Exception $e) {
+                throw new TestReferenceException(
+                    $e->getMessage() .
+                    ".\nException occurred parsing action at StepKey \"" . $parsedStep->getStepKey() . "\""
+                );
             }
         }
     }

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1577,7 +1577,7 @@ private function generateTestPhp($test)
         } else {
             try {
                 $steps = $this->generateStepsPhp($test->getOrderedActions());
-            } catch (TestReferenceException $e) {
+            } catch (\Exception $e) {
                 throw new TestReferenceException($e->getMessage() . " in Test \"" . $test->getName() . "\"");
             }
         }