AC-659: Create phpcs static check for ModuleXMLTest

Author: svera

Magento2/Sniffs/Legacy/ModuleXMLSniff.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento2\Sniffs\Legacy;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Test for obsolete nodes/attributes in the module.xml
+ */
+class ModuleXMLSniff implements Sniff
+{
+    /**
+     * Error violation code.
+     *
+     * @var string
+     */
+    protected $warningCode = 'FoundObsoleteAttribute';
+    
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_INLINE_HTML
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $xml = simplexml_load_string($phpcsFile->getTokensAsString(0, 999999));
+        
+        if ($xml->xpath('/config/module/@version') !== false) {
+            $phpcsFile->addWarning(
+                'The "version" attribute is obsolete. Use "setup_version" instead.',
+                $stackPtr,
+                $this->warningCode
+            );
+        }
+        
+        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
+            );
+        }
+    }
+}

Magento2/Tests/Legacy/ModuleXMLUnitTest.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Legacy;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class ModuleXMLUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList()
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList()
+    {
+        return [
+            1 => 2
+        ];
+    }
+}

Magento2/Tests/Legacy/ModuleXMLUnitTest.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<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" />
+</config>

Magento2/ruleset.xml

@@ -223,6 +223,13 @@
         <severity>8</severity>
         <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>
+        <severity>8</severity>
+        <type>warning</type>
+    </rule>
 
     <!-- Severity 7 warnings: General code issues. -->
     <rule ref="Generic.Arrays.DisallowLongArraySyntax">

composer.json

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