MQE-1118: Handle XML merge failures gracefully (#202)

* MQE-1118: Handle XML merge failures gracefully

- Added filename to error messages for loadXML usage in initDom

* MQE-1118: Handle XML merge failures gracefully

- Added Test and made error a tiny bit more specific (error is caught by child classes given context)

* MQE-1118: Handle XML merge failures gracefully

- Added exception message check in unit test

* MQE-1118: Handle XML merge failures gracefully

- Added check for false returns from loadXML

Author: aljcalandra

dev/tests/unit/Magento/FunctionalTestFramework/Test/Config/ActionGroupDomTest.php

@@ -6,6 +6,7 @@
 namespace Tests\unit\Magento\FunctionalTestFramework\Test\Config;
 
 use Magento\FunctionalTestingFramework\Exceptions\Collector\ExceptionCollector;
+use Magento\FunctionalTestingFramework\Config\Dom\ValidationException;
 use Magento\FunctionalTestingFramework\Test\Config\ActionGroupDom;
 use Magento\FunctionalTestingFramework\Util\MagentoTestCase;
 
@@ -29,4 +30,21 @@ public function testActionGroupDomStepKeyValidation()
         $this->expectException(\Exception::class);
         $exceptionCollector->throwException();
     }
+
+    /**
+     * Test Action Group invalid XML
+     */
+    public function testActionGroupDomInvalidXmlValidation()
+    {
+        $sampleXml = "<actionGroups>
+            <actionGroup name=\"sampleActionGroup\">
+                <wait>
+            </actionGroup>
+         </actionGroups>";
+
+        $exceptionCollector = new ExceptionCollector();
+        $this->expectException(ValidationException::class);
+        $this->expectExceptionMessage("XML Parse Error: invalid.xml\n");
+        new ActionGroupDom($sampleXml, 'invalid.xml', $exceptionCollector);
+    }
 }

src/Magento/FunctionalTestingFramework/Config/Dom.php

@@ -6,6 +6,8 @@
 
 namespace Magento\FunctionalTestingFramework\Config;
 
+use Magento\FunctionalTestingFramework\Config\Dom\ValidationException;
+
 /**
  * Magento configuration XML DOM utility
  */
@@ -354,13 +356,21 @@ public function getDom()
      * Create DOM document based on $xml parameter
      *
      * @param string $xml
+     * @param string $filename
      * @return \DOMDocument
      * @throws \Magento\FunctionalTestingFramework\Config\Dom\ValidationException
      */
-    protected function initDom($xml)
+    protected function initDom($xml, $filename = null)
     {
         $dom = new \DOMDocument();
-        $dom->loadXML($xml);
+        try {
+            $domSuccess = $dom->loadXML($xml);
+            if (!$domSuccess) {
+                throw new \Exception();
+            }
+        } catch (\Exception $exception) {
+            throw new ValidationException("XML Parse Error: $filename\n");
+        }
         if ($this->schemaFile) {
             $errors = self::validateDomDocument($dom, $this->schemaFile, $this->errorFormat);
             if (count($errors)) {

src/Magento/FunctionalTestingFramework/DataGenerator/Config/Dom.php

@@ -65,7 +65,7 @@ public function __construct(
      */
     public function initDom($xml, $filename = null)
     {
-        $dom = parent::initDom($xml);
+        $dom = parent::initDom($xml, $filename);
 
         if (strpos($filename, self::DATA_FILE_NAME_ENDING)) {
             $entityNodes = $dom->getElementsByTagName('entity');

src/Magento/FunctionalTestingFramework/DataGenerator/Config/OperationDom.php

@@ -65,7 +65,7 @@ public function __construct(
      */
     public function initDom($xml, $filename = null)
     {
-        $dom = parent::initDom($xml);
+        $dom = parent::initDom($xml, $filename);
 
         if (strpos($filename, self::METADATA_FILE_NAME_ENDING)) {
             $operationNodes = $dom->getElementsByTagName('operation');

src/Magento/FunctionalTestingFramework/Page/Config/Dom.php

@@ -76,7 +76,7 @@ public function __construct(
      */
     public function initDom($xml, $filename = null)
     {
-        $dom = parent::initDom($xml);
+        $dom = parent::initDom($xml, $filename);
 
         $pagesNode = $dom->getElementsByTagName('pages')->item(0);
         $this->validationUtil->validateChildUniqueness($pagesNode, $filename);

src/Magento/FunctionalTestingFramework/Page/Config/SectionDom.php

@@ -67,7 +67,7 @@ public function __construct(
      */
     public function initDom($xml, $filename = null)
     {
-        $dom = parent::initDom($xml);
+        $dom = parent::initDom($xml, $filename);
         $sectionNodes = $dom->getElementsByTagName('section');
         foreach ($sectionNodes as $sectionNode) {
             $sectionNode->setAttribute(self::SECTION_META_FILENAME_ATTRIBUTE, $filename);

src/Magento/FunctionalTestingFramework/Test/Config/ActionGroupDom.php

@@ -26,7 +26,7 @@ class ActionGroupDom extends Dom
      */
     public function initDom($xml, $filename = null)
     {
-        $dom = parent::initDom($xml);
+        $dom = parent::initDom($xml, $filename);
 
         if (strpos($filename, self::ACTION_GROUP_FILE_NAME_ENDING)) {
             $actionGroupNodes = $dom->getElementsByTagName('actionGroup');

src/Magento/FunctionalTestingFramework/Test/Config/Dom.php

@@ -79,7 +79,7 @@ public function __construct(
      */
     public function initDom($xml, $filename = null)
     {
-        $dom = parent::initDom($xml);
+        $dom = parent::initDom($xml, $filename);
 
         if (strpos($filename, self::TEST_FILE_NAME_ENDING)) {
             $testNodes = $dom->getElementsByTagName('test');