AC-659: Create phpcs static check for ModuleXMLTest

Author: svera

Magento2/Sniffs/Legacy/ModuleXMLSniff.php

@@ -6,6 +6,7 @@
 
 namespace Magento2\Sniffs\Legacy;
 
+use DOMDocument;
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use SimpleXMLElement;
@@ -15,10 +16,8 @@
  */
 class ModuleXMLSniff implements Sniff
 {
-    /**
-     * Error violation code.
-     */
-    const WARNING_CODE = 'FoundObsoleteAttribute';
+    private const WARNING_CODE = 'FoundObsoleteAttribute';
+    private const ERROR_CODE = 'WrongXML';
 
     /**
      * @inheritdoc
@@ -36,19 +35,19 @@ public function register(): array
     public function process(File $phpcsFile, $stackPtr)
     {
         $line = $phpcsFile->getTokens()[$stackPtr]['content'];
-        if (strpos(trim($line), '<module ') === false) {
+        if (strpos(trim($line), '<module') === false) {
             return;
         }
-        
-        $xml = simplexml_load_string($phpcsFile->getTokensAsString(0, 999999));
+
+        $xml = simplexml_load_string($this->getFormattedXML($phpcsFile));
         if ($xml === false) {
             $phpcsFile->addError(
                 sprintf(
                     "Couldn't parse contents of '%s', check that they are in valid XML format",
                     $phpcsFile->getFilename(),
                 ),
                 $stackPtr,
-                self::WARNING_CODE
+                self::ERROR_CODE
             );
         }
 
@@ -96,4 +95,16 @@ private function elementIsCurrentlySniffedLine(SimpleXMLElement $element, int $s
         }
         return false;
     }
+
+    /**
+     * @param File $phpcsFile
+     * @return false|string
+     */
+    private function getFormattedXML(File $phpcsFile)
+    {
+        $doc = new DomDocument('1.0');
+        $doc->formatOutput = true;
+        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
+        return $doc->saveXML();
+    }
 }

Magento2/Tests/Legacy/ModuleXMLUnitTest.php

@@ -23,7 +23,8 @@ public function getErrorList()
     public function getWarningList()
     {
         return [
-            9 => 2
+            9 => 2,
+            10 => 2
         ];
     }
 }

Magento2/Tests/Legacy/ModuleXMLUnitTest.xml

@@ -7,4 +7,9 @@
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
     <module name="Magento_TestModule" active="true" version="1" />
+    <module
+            name="Magento_TestModule2" 
+            active="true" 
+            version="1" 
+    />
 </config>