AC-659 Create phpcs static check for ModuleXMLTest

Magento2/Sniffs/Legacy/ModuleXMLSniff.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento2\Sniffs\Legacy;
+
+use DOMDocument;
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SimpleXMLElement;
+
+/**
+ * Test for obsolete nodes/attributes in the module.xml
+ */
+class ModuleXMLSniff implements Sniff
+{
+    private const WARNING_CODE = 'FoundObsoleteAttribute';
+    private const ERROR_CODE = 'WrongXML';
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_INLINE_HTML
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $line = $phpcsFile->getTokens()[$stackPtr]['content'];
+        if (strpos(trim($line), '<module') === false) {
+            return;
+        }
+
+        // We need to format the incoming XML to avoid tags split into several lines. In that case, PHP's DOMElement
+        // returns the position of the closing /> as the position of the tag, and we need the position of <module
+        // instead, as it is the one we compare with $stackPtr later on.
+        $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::ERROR_CODE
+            );
+        }
+
+        $foundElements = $xml->xpath('/config/module');
+        if ($foundElements === false) {
+            return;
+        }
+
+        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,
+                    self::WARNING_CODE
+                );
+            }
+
+            if (property_exists($element->attributes(), 'active')) {
+                $phpcsFile->addWarning(
+                    'The "active" attribute is obsolete. The list of active modules '.
+                    'is defined in deployment configuration.',
+                    $stackPtr,
+                    self::WARNING_CODE
+                );
+            }
+        }
+    }
+
+    /**
+     * Check if the element passed is in the currently sniffed line
+     *
+     * @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;
+    }
+
+    /**
+     * Format the incoming XML to avoid tags split into several lines.
+     *
+     * @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.1.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/Tests/Legacy/ModuleXMLUnitTest.2.xml

@@ -0,0 +1,14 @@
+<?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_TestModule2" 
+            active="true" 
+            version="1" 
+    />
+</config>

Magento2/Tests/Legacy/ModuleXMLUnitTest.3.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_TestModule2" />
+</config>

Magento2/Tests/Legacy/ModuleXMLUnitTest.php

@@ -0,0 +1,40 @@
+<?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($testFile = '')
+    {
+        if ($testFile === 'ModuleXMLUnitTest.1.xml') {
+            return [
+                9 => 2,
+            ];
+        }
+        if ($testFile === 'ModuleXMLUnitTest.2.xml') {
+            return [
+                9 => 2,
+            ];
+        }
+        if ($testFile === 'ModuleXMLUnitTest.3.xml') {
+            return [];
+        }
+        return [];
+    }
+}

Magento2/ruleset.xml

@@ -223,6 +223,11 @@
         <severity>8</severity>
         <type>warning</type>
     </rule>
+    <rule ref="Magento2.Legacy.ModuleXML">
+        <include-pattern>*\/module.xml$</include-pattern>
+        <severity>8</severity>
+        <type>warning</type>
+    </rule>
     <rule ref="Magento2.Legacy.DiConfig">
         <include-pattern>*\/di.xml$</include-pattern>
         <severity>8</severity>

composer.json

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