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

Outside XML Elements

- Adding verification test for filesystem to check error

Author: aljcalandra

dev/tests/util/MftfTestCase.php

@@ -5,13 +5,20 @@
  */
 namespace tests\util;
 
+use Magento\FunctionalTestingFramework\ObjectManager;
 use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
 use Magento\FunctionalTestingFramework\Util\TestGenerator;
 use PHPUnit\Framework\TestCase;
 
 abstract class MftfTestCase extends TestCase
 {
-    const RESOURCES_PATH = __DIR__ . '/../verification/Resources';
+    const RESOURCES_PATH = __DIR__ .
+    DIRECTORY_SEPARATOR .
+    '..' .
+    DIRECTORY_SEPARATOR .
+    'verification' .
+    DIRECTORY_SEPARATOR .
+    'Resources';
 
     /**
      * Private function which takes a test name, generates the test and compares with a correspondingly named txt file
@@ -37,4 +44,57 @@ public function generateAndCompareTest($testName)
             $cestFile
         );
     }
-}
+
+    /**
+     * Private function which attempts to generate tests given an invalid shcema of a various type
+     *
+     * @param string[] $fileContents
+     * @param string $objectType
+     * @param string $expectedError
+     * @throws \Exception
+     */
+    public function validateSchemaErrorWithTest($fileContents, $objectType ,$expectedError)
+    {
+        $this->clearHandler();
+        $fullTestModulePath = TESTS_MODULE_PATH .
+            DIRECTORY_SEPARATOR .
+            'TestModule' .
+            DIRECTORY_SEPARATOR .
+            $objectType .
+            DIRECTORY_SEPARATOR;
+
+        foreach ($fileContents as $fileName => $fileContent) {
+            $tempFile = $fullTestModulePath . $fileName;
+            $handle = fopen($tempFile, 'w') or die('Cannot open file:  ' . $tempFile);
+            fwrite($handle, $fileContent);
+            fclose($handle);
+        }
+        try {
+            $this->expectExceptionMessage($expectedError);
+            TestObjectHandler::getInstance()->getObject("someTest");
+        } finally {
+            foreach (array_keys($fileContents) as $fileName) {
+                unlink($fullTestModulePath . $fileName);
+            }
+            $this->clearHandler();
+        }
+    }
+
+    /**
+     * Clears test handler and object manager to force recollection of test data
+     *
+     * @throws \Exception
+     */
+    private function clearHandler()
+    {
+        // clear test object handler to force recollection of test data
+        $property = new \ReflectionProperty(TestObjectHandler::class, 'testObjectHandler');
+        $property->setAccessible(true);
+        $property->setValue(null);
+
+        // clear test object handler to force recollection of test data
+        $property = new \ReflectionProperty(ObjectManager::class, 'instance');
+        $property->setAccessible(true);
+        $property->setValue(null);
+    }
+}

dev/tests/verification/TestModule/Test/PageReplacementTest.xml

@@ -22,7 +22,4 @@
         <amOnPage stepKey="oneParamAdminPageString" url="{{AdminOneParamPage.url('StringLiteral')}}"/>
         <amOnUrl stepKey="onExternalPage" url="{{ExternalPage.url}}"/>
     </test>
-    <test name="ExternalPageTestBadReference">
-        <amOnPage stepKey="onExternalPage" url="{{ExternalPage.url}}"/>
-    </test>
 </tests>

dev/tests/verification/Tests/SchemaValidationTest.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace tests\verification\Tests;
+
+use tests\util\MftfTestCase;
+
+class SchemaValidationTest extends MftfTestCase
+{
+    /**
+     * Test generation of a test referencing an action group with no arguments
+     *
+     * @throws \Exception
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     */
+    public function testInvalidTestSchema()
+    {
+        $testFile = ['testFile.xml' => "<tests><test name='testName'><annotations>a</annotations></test></tests>"];
+        $expectedError = TESTS_MODULE_PATH .
+            DIRECTORY_SEPARATOR .
+            "TestModule" .
+            DIRECTORY_SEPARATOR .
+            "Test" .
+            DIRECTORY_SEPARATOR .
+            "testFile.xml";
+        $this->validateSchemaErrorWithTest($testFile, 'Test', $expectedError);
+    }
+}