AC-659: Create phpcs static check for ModuleXMLTest

Author: svera

Magento2/Sniffs/Legacy/ModuleXMLSniff.php

@@ -8,6 +8,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use SimpleXMLElement;
 
 /**
  * Test for obsolete nodes/attributes in the module.xml
@@ -36,22 +37,52 @@ public function register(): array
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $xml = simplexml_load_string($phpcsFile->getTokensAsString(0, 999999));
+        $line = $phpcsFile->getTokens()[$stackPtr]['content'];
+        if (strpos(trim($line), '<module ') === false) {
+            return;
+        }
 
-        if ($xml->xpath('/config/module/@version') !== false) {
-            $phpcsFile->addWarning(
-                'The "version" attribute is obsolete. Use "setup_version" instead.',
-                $stackPtr,
-                $this->warningCode
-            );
+        $xml = simplexml_load_string($phpcsFile->getTokensAsString(0, 999999));
+
+        $foundElements = $xml->xpath('/config/module');
+        if ($foundElements === false) {
+            return;
         }
 
-        if ($xml->xpath('/config/module/@active') !== false) {
-            $phpcsFile->addWarning(
-                'The "active" attribute is obsolete. The list of active modules is defined in deployment configuration.',
-                $stackPtr,
-                $this->warningCode
-            );
+        foreach ($foundElements as $element) {
+            if (!$this->elementIsCurrentlySniffedLine($element, $stackPtr)) {
+                continue;
+            }
+            
+            if (property_exists($element->attributes(), 'version')) {
+                $phpcsFile->addWarning(
+                    'The "version" attribute is obsolete. Use "setup_version" instead.',
+                    $stackPtr,
+                    $this->warningCode
+                );
+            }
+
+            if (property_exists($element->attributes(), 'active')) {
+                $phpcsFile->addWarning(
+                    'The "active" attribute is obsolete. The list of active modules is defined in deployment configuration.',
+                    $stackPtr,
+                    $this->warningCode
+                );
+            }
+        }
+    }
+
+    /**
+     * @param SimpleXMLElement $element
+     * @param int $stackPtr
+     * @return bool
+     */
+    private function elementIsCurrentlySniffedLine(SimpleXMLElement $element, int $stackPtr): bool
+    {
+        $node = dom_import_simplexml($element);
+        if ($node->getLineNo() === $stackPtr+1) {
+            return true;
         }
+        return false;
     }
 }

Magento2/Tests/Legacy/ModuleXMLUnitTest.php

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

Magento2/ruleset.xml

@@ -3,7 +3,7 @@
     <description>Magento Coding Standard</description>
 
     <!-- File extensions to be checked. -->
-    <arg name="extensions" value="php,phtml,graphqls/GraphQL"/>
+    <arg name="extensions" value="php,phtml,graphqls/GraphQL,xml"/>
 
     <!-- Severity 10 errors: Critical code issues. -->
     <rule ref="Generic.Functions.CallTimePassByReference">
@@ -224,9 +224,8 @@
         <type>warning</type>
     </rule>
     <rule ref="Magento2.Legacy.ModuleXML">
-        <exclude-pattern>*\.php$</exclude-pattern>
-        <include-pattern>module.xml</include-pattern>
-        <include-pattern>ModuleXMLUnitTest.xml</include-pattern>
+        <include-pattern>*\/module.xml$</include-pattern>
+        <include-pattern>*\/ModuleXMLUnitTest.xml$</include-pattern>
         <severity>8</severity>
         <type>warning</type>
     </rule>
@@ -265,6 +264,7 @@
         <type>warning</type>
     </rule>
     <rule ref="Generic.PHP.DisallowShortOpenTag">
+        <exclude-pattern>*\.xml$</exclude-pattern>
         <severity>7</severity>
         <type>warning</type>
     </rule>

composer.json

@@ -11,7 +11,8 @@
         "php": ">=7.3",
         "squizlabs/php_codesniffer": "^3.6",
         "webonyx/graphql-php": "^14.9",
-        "ext-simplexml": "*"
+        "ext-simplexml": "*",
+        "ext-dom": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.8"