MQE-1031: Empty files are flagged during generation or dealt with

gracefully

 - Added check for empty file

Author: aljcalandra

dev/tests/unit/Magento/FunctionalTestFramework/Config/Reader/FilesystemTest.php

@@ -0,0 +1,108 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Tests\unit\Magento\FunctionalTestFramework\Test\Config\Reader;
+
+use Magento\FunctionalTestingFramework\Config\FileResolver\Module;
+use Magento\FunctionalTestingFramework\Config\Reader\Filesystem;
+use Magento\FunctionalTestingFramework\Config\ValidationState;
+use Magento\FunctionalTestingFramework\Util\Iterator\File;
+use PHPUnit\Framework\TestCase;
+use AspectMock\Test as AspectMock;
+use tests\unit\Util\TestLoggingUtil;
+
+class FilesystemTest extends TestCase
+{
+    /**
+     * Before test functionality
+     * @return void
+     */
+    public function setUp()
+    {
+        TestLoggingUtil::getInstance()->setMockLoggingUtil();
+    }
+
+    /**
+     * Test Reading Empty Files
+     * @throws \Exception
+     */
+    public function testEmptyXmlFile()
+    {
+        // create mocked items and read the file
+        $someFile = $this->setMockFile("somepath.xml", "");
+        $filesystem = $this->createPseudoFileSystem($someFile);
+        $filesystem->read();
+
+        // validate log statement
+        TestLoggingUtil::getInstance()->validateMockLogStatement(
+            "warning",
+            "XML File is empty.",
+            ["File" => "somepath.xml"]
+        );
+    }
+
+    /**
+     * Function used to set mock for File created in test
+     *
+     * @param string $fileName
+     * @param string $content
+     * @return object
+     * @throws \Exception
+     */
+    public function setMockFile($fileName, $content)
+    {
+        $file = AspectMock::double(
+            File::class,
+            [
+                'current' => "",
+                'count' => 1,
+                'getFilename' => $fileName
+            ]
+        )->make();
+
+        //set mocked data property for File
+        $property = new \ReflectionProperty(File::class, 'data');
+        $property->setAccessible(true);
+        $property->setValue($file, [$fileName => $content]);
+
+        return $file;
+    }
+
+    /**
+     * Function used to set mock for filesystem class during test
+     *
+     * @param string $fileList
+     * @return object
+     * @throws \Exception
+     */
+    public function createPseudoFileSystem($fileList)
+    {
+        $filesystem = AspectMock::double(Filesystem::class)->make();
+
+        //set resolver to use mocked resolver
+        $mockFileResolver = AspectMock::double(Module::class, ['get' => $fileList])->make();
+        $property = new \ReflectionProperty(Filesystem::class, 'fileResolver');
+        $property->setAccessible(true);
+        $property->setValue($filesystem, $mockFileResolver);
+
+        //set validator to use mocked validator
+        $mockValidation = AspectMock::double(ValidationState::class, ['isValidationRequired' => false])->make();
+        $property = new \ReflectionProperty(Filesystem::class, 'validationState');
+        $property->setAccessible(true);
+        $property->setValue($filesystem, $mockValidation);
+
+        return $filesystem;
+    }
+
+    /**
+     * After class functionality
+     * @return void
+     */
+    public static function tearDownAfterClass()
+    {
+        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
+        parent::tearDownAfterClass();
+    }
+}

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

@@ -4,6 +4,8 @@
  * See COPYING.txt for license details.
  */
 namespace Magento\FunctionalTestingFramework\Config\Reader;
+use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
+use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
 
 /**
  * Filesystem configuration loader. Loads configuration from XML files, split by scopes.
@@ -144,6 +146,10 @@ protected function readFiles($fileList)
         /** @var \Magento\FunctionalTestingFramework\Config\Dom $configMerger */
         $configMerger = null;
         foreach ($fileList as $key => $content) {
+            //check if file is empty and continue to next if it is
+            if (!$this->verifyFileStatus($content, $fileList->getFilename())) {
+                continue;
+            }
             try {
                 if (!$configMerger) {
                     $configMerger = $this->createConfigMerger($this->domDocumentClass, $content);
@@ -192,4 +198,24 @@ protected function createConfigMerger($mergerClass, $initialContents)
         }
         return $result;
     }
+
+    /**
+     * Checks if content is empty and logs warning, returns false if file is empty
+     *
+     * @param string $content
+     * @param string $fileName
+     * @return bool
+     */
+    protected function verifyFileStatus($content, $fileName)
+    {
+        if (empty($content)) {
+            if (MftfApplicationConfig::getConfig()->verboseEnabled()) {
+                LoggingUtil::getInstance()->getLogger(Filesystem::class)->warn(
+                    "XML File is empty.", ["File" => $fileName]
+                );
+            }
+            return false;
+        }
+        return true;
+    }
 }

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

@@ -25,6 +25,10 @@ public function readFiles($fileList)
         /** @var \Magento\FunctionalTestingFramework\Test\Config\Dom $configMerger */
         $configMerger = null;
         foreach ($fileList as $key => $content) {
+            //check if file is empty and continue to next if it is
+            if (!parent::verifyFileStatus($content, $fileList->getFilename())) {
+                continue;
+            }
             try {
                 if (!$configMerger) {
                     $configMerger = $this->createConfigMerger(