MQE-1017: Better Error Messaging When Non-Whitespace Characters Are

Outside XML Elements

- Abstracted validation code in Filesystem

Author: aljcalandra

src/Magento/FunctionalTestingFramework/Config/Reader/Filesystem.php

@@ -5,6 +5,8 @@
  */
 namespace Magento\FunctionalTestingFramework\Config\Reader;
 
+use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
+
 /**
  * Filesystem configuration loader. Loads configuration from XML files, split by scopes.
  */
@@ -150,24 +152,14 @@ protected function readFiles($fileList)
                 } else {
                     $configMerger->merge($content);
                 }
-                if ($this->validationState->isValidationRequired()) {
-                    $errors = [];
-                    if ($configMerger && !$configMerger->validate($this->schemaFile, $errors)) {
-                        $message = $fileList->getFilename() . PHP_EOL . "Invalid Document \n";
-                        throw new \Exception($message . implode("\n", $errors));
-                    }
+                if (MftfApplicationConfig::getConfig()->debugEnabled()) {
+                    $this->validateSchema($configMerger, $fileList->getFilename());
                 }
             } catch (\Magento\FunctionalTestingFramework\Config\Dom\ValidationException $e) {
                 throw new \Exception("Invalid XML in file " . $fileList->getFilename() . ":\n" . $e->getMessage());
             }
         }
-        if ($this->validationState->isValidationRequired()) {
-            $errors = [];
-            if ($configMerger && !$configMerger->validate($this->schemaFile, $errors)) {
-                $message = "Invalid Document \n";
-                throw new \Exception($message . implode("\n", $errors));
-            }
-        }
+        $this->validateSchema($configMerger);
 
         $output = [];
         if ($configMerger) {
@@ -199,4 +191,23 @@ protected function createConfigMerger($mergerClass, $initialContents)
         }
         return $result;
     }
+
+    /**
+     * Validate read xml against expected schema
+     *
+     * @param string $configMerger
+     * @param string $filename
+     * @throws \Exception
+     * @return void
+     */
+    protected function validateSchema($configMerger, $filename = null)
+    {
+        if ($this->validationState->isValidationRequired()) {
+            $errors = [];
+            if ($configMerger && !$configMerger->validate($this->schemaFile, $errors)) {
+                $message = $filename ? $filename . PHP_EOL . "Invalid Document \n" : PHP_EOL . "Invalid Document \n";
+                throw new \Exception($message . implode("\n", $errors));
+            }
+        }
+    }
 }

src/Magento/FunctionalTestingFramework/Config/Reader/MftfFilesystem.php

@@ -22,7 +22,6 @@ class MftfFilesystem extends \Magento\FunctionalTestingFramework\Config\Reader\F
     public function readFiles($fileList)
     {
         $exceptionCollector = new ExceptionCollector();
-        $errors = [];
         /** @var \Magento\FunctionalTestingFramework\Test\Config\Dom $configMerger */
         $configMerger = null;
         foreach ($fileList as $key => $content) {
@@ -38,24 +37,14 @@ public function readFiles($fileList)
                     $configMerger->merge($content, $fileList->getFilename(), $exceptionCollector);
                 }
                 if (MftfApplicationConfig::getConfig()->debugEnabled()) {
-                    if ($this->validationState->isValidationRequired()) {
-                        if ($configMerger && !$configMerger->validate($this->schemaFile, $errors)) {
-                            $message = "Invalid Document: " . PHP_EOL . $fileList->getFilename() . PHP_EOL;
-                            throw new \Exception($message . implode("\n", $errors));
-                        }
-                    }
+                    $this->validateSchema($configMerger, $fileList->getFilename());
                 }
             } catch (\Magento\FunctionalTestingFramework\Config\Dom\ValidationException $e) {
                 throw new \Exception("Invalid XML in file " . $key . ":\n" . $e->getMessage());
             }
         }
         $exceptionCollector->throwException();
-        if ($this->validationState->isValidationRequired()) {
-            if ($configMerger && !$configMerger->validate($this->schemaFile, $errors)) {
-                $message = "Invalid Document: " . PHP_EOL;
-                throw new \Exception($message . implode("\n", $errors));
-            }
-        }
+        $this->validateSchema($configMerger, $fileList->getFilename());
 
         $output = [];
         if ($configMerger) {