MQE-247

Author: KevinBKozan

src/Magento/FunctionalTestingFramework/Exceptions/TestReferenceException.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\FunctionalTestingFramework\Exceptions;
+
+/**
+ * Class TestReferenceException
+ */
+class TestReferenceException extends \Exception
+{
+    /**
+     * TestReferenceException constructor.
+     * @param string $message
+     */
+    public function __construct($message)
+    {
+        parent::__construct($message);
+    }
+
+}

src/Magento/FunctionalTestingFramework/Page/Objects/SectionObject.php

@@ -56,14 +56,28 @@ public function getElements()
         return $this->elements;
     }
 
+    /**
+     * Checks to see if this section contains any element by the name of elementName
+     * @param $elementName
+     * @return bool
+     */
+    public function hasElement($elementName)
+    {
+        return array_key_exists($elementName, $this->elements);
+    }
+
     /**
      * Given the name of an element, returns the element object
      *
      * @param string $elementName
-     * @return ElementObject
+     * @return ElementObject | null
      */
     public function getElement($elementName)
     {
-        return $this->elements[$elementName];
+        if ($this->hasElement($elementName)) {
+            return $this->elements[$elementName];
+        }
+
+        return null;
     }
 }

src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php

@@ -12,6 +12,7 @@
 use Magento\FunctionalTestingFramework\Page\Objects\SectionObject;
 use Magento\FunctionalTestingFramework\Page\Handlers\PageObjectHandler;
 use Magento\FunctionalTestingFramework\Page\Handlers\SectionObjectHandler;
+use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;
 
 /**
  * Class ActionObject
@@ -321,6 +322,9 @@ private function findAndReplaceReferences($objectHandler, $inputString)
                     break;
                 case SectionObject::class:
                     list(,$objField) = $this->stripAndSplitReference($match);
+                    if ($obj->getElement($objField) == null) {
+                        throw new TestReferenceException("Could not resolve entity reference " . $inputString);
+                    }
                     $parameterized = $obj->getElement($objField)->isParameterized();
                     $replacement = $obj->getElement($objField)->getLocator();
                     $this->timeout = $obj->getElement($objField)->getTimeout();
@@ -347,7 +351,7 @@ private function findAndReplaceReferences($objectHandler, $inputString)
             if ($replacement == null && get_class($objectHandler) != DataObjectHandler::class) {
                 return $this->findAndReplaceReferences(DataObjectHandler::getInstance(), $outputString);
             } elseif ($replacement == null) {
-                throw new \Exception("Could not resolve entity reference " . $inputString);
+                throw new TestReferenceException("Could not resolve entity reference " . $inputString);
             }
 
             //If Page or Section's Element is has parameterized = true attribute, attempt to do parameter replacement.
@@ -373,12 +377,12 @@ private function matchParameterReferences($reference, $parameters)
     {
         preg_match_all('/{{[\w.]+}}/', $reference, $varMatches);
         if (count($varMatches[0]) > count($parameters)) {
-            throw new \Exception(
+            throw new TestReferenceException(
                 "Parameter Resolution Failed: Not enough parameters given for reference " .
                 $reference . ". Parameters Given: " . implode(",", $parameters)
             );
         } elseif (count($varMatches[0]) < count($parameters)) {
-            throw new \Exception(
+            throw new TestReferenceException(
                 "Parameter Resolution Failed: Too many parameters given for reference " .
                 $reference . ". Parameters Given: " . implode(",", $parameters)
             );

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -8,6 +8,7 @@
 
 use FilesystemIterator;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;
 use Magento\FunctionalTestingFramework\Test\Handlers\CestObjectHandler;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
@@ -63,7 +64,7 @@ private function rmdirRecursive($directory)
     {
         $it = new RecursiveDirectoryIterator($directory, FilesystemIterator::SKIP_DOTS);
 
-        while($it->valid()) {
+        while ($it->valid()) {
             $path = $directory . DIRECTORY_SEPARATOR . $it->getFilename();
             if ($it->isDir()) {
                 $this->rmDirRecursive($path);
@@ -85,7 +86,7 @@ private function rmdirRecursive($directory)
     public static function getInstance()
     {
         if (!self::$testGenerator) {
-            self::$testGenerator = new TestGenerator(TESTS_MODULE_PATH .  DIRECTORY_SEPARATOR . "_generated");
+            self::$testGenerator = new TestGenerator(TESTS_MODULE_PATH . DIRECTORY_SEPARATOR . "_generated");
         }
 
         return self::$testGenerator;
@@ -152,8 +153,12 @@ private function assembleCestPhp($cestObject)
         $classAnnotationsPhp = $this->generateClassAnnotationsPhp($cestObject->getAnnotations());
         $className = $cestObject->getName();
         $className = str_replace(' ', '', $className);
-        $hookPhp = $this->generateHooksPhp($cestObject->getHooks());
-        $testsPhp = $this->generateTestsPhp($cestObject->getTests());
+        try {
+            $hookPhp = $this->generateHooksPhp($cestObject->getHooks());
+            $testsPhp = $this->generateTestsPhp($cestObject->getTests());
+        } catch (TestReferenceException $e) {
+            throw new TestReferenceException($e->getMessage(). " in Cest \"" . $cestObject->getName() . "\"");
+        }
 
         $cestPhp = "<?php\n";
         $cestPhp .= "namespace Magento\AcceptanceTest\Backend;\n\n";
@@ -376,7 +381,7 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                 foreach ($params as $param) {
                     $paramsWithUniqueness[] = $this->addUniquenessFunctionCall($param);
                 }
-                $parameterArray = '[' . implode(',', $paramsWithUniqueness) .']';
+                $parameterArray = '[' . implode(',', $paramsWithUniqueness) . ']';
             }
 
             if (isset($customActionAttributes['requiredAction'])) {
@@ -865,7 +870,15 @@ private function generateHooksPhp($hookObjects)
                 }
             }
 
-            $steps = $this->generateStepsPhp($hookObject->getActions(), $hookObject->getCustomData(), $createData);
+            try {
+                $steps = $this->generateStepsPhp(
+                    $hookObject->getActions(),
+                    $hookObject->getCustomData(),
+                    $createData
+                );
+            } catch (TestReferenceException $e) {
+                throw new TestReferenceException($e->getMessage() . " in Element \"" . $type . "\"");
+            }
 
             if ($type == "after") {
                 $hooks .= sprintf("\tpublic function _after(%s)\n", $dependencies);
@@ -988,7 +1001,11 @@ private function generateTestsPhp($testsObject)
             $testName = str_replace(' ', '', $testName);
             $testAnnotations = $this->generateTestAnnotationsPhp($test->getAnnotations());
             $dependencies = 'AcceptanceTester $I';
-            $steps = $this->generateStepsPhp($test->getOrderedActions(), $test->getCustomData());
+            try {
+                $steps = $this->generateStepsPhp($test->getOrderedActions(), $test->getCustomData());
+            } catch (TestReferenceException $e) {
+                throw new TestReferenceException($e->getMessage() . " in Test \"" . $test->getName() . "\"");
+            }
 
             $testPhp .= $testAnnotations;
             $testPhp .= sprintf("\tpublic function %s(%s)\n", $testName, $dependencies);
@@ -1014,7 +1031,7 @@ private function addUniquenessFunctionCall($input)
     {
         $output = '';
 
-        preg_match('/' . EntityDataObject::CEST_UNIQUE_FUNCTION .'\("[\w]+"\)/', $input, $matches);
+        preg_match('/' . EntityDataObject::CEST_UNIQUE_FUNCTION . '\("[\w]+"\)/', $input, $matches);
         if (!empty($matches)) {
             $parts = preg_split('/' . EntityDataObject::CEST_UNIQUE_FUNCTION . '\("[\w]+"\)/', $input, -1);
             for ($i = 0; $i < count($parts); $i++) {
@@ -1082,6 +1099,7 @@ private function addDollarSign($input)
     }
 
     // @codingStandardsIgnoreStart
+
     /**
      * Wrap parameters into a function call.
      *