AC-661: Create phpcs static check for XmlTest

Author: jcuerdo

Magento2/Sniffs/Legacy/WidgetXMLSniff.php

@@ -0,0 +1,114 @@
+<?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;
+
+/**
+ * Test for obsolete nodes/attributes in the module.xml
+ */
+class WidgetXMLSniff implements Sniff
+{
+    private const ERROR_CODE_OBSOLETE = 'FoundObsoleteNode';
+    private const ERROR_CODE_FACTORY = 'FoundFactory';
+    private const ERROR_CODE_XML = 'WrongXML';
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_INLINE_HTML
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if($stackPtr > 0) {
+            return;
+        }
+
+        $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(),
+                ),
+                1,
+                self::ERROR_CODE_XML
+            );
+        }
+
+        $foundElements = $xml->xpath('/widgets/*[@type]');
+
+        foreach ($foundElements as $element) {
+            if (property_exists($element->attributes(), 'type')) {
+                $type = $element['type'];
+                if (preg_match('/\//', $type)) {
+                    $phpcsFile->addError(
+                        "Factory name detected: {$type}.",
+                        dom_import_simplexml($element)->getLineNo() - 1,
+                        self::ERROR_CODE_FACTORY
+                    );
+                }
+            }
+        }
+
+        $foundElements = $xml->xpath('/widgets/*/supported_blocks');
+        foreach ($foundElements as $element) {
+            $phpcsFile->addError(
+                "Obsolete node: <supported_blocks>. To be replaced with <supported_containers>",
+                dom_import_simplexml($element)->getLineNo() - 1,
+                self::ERROR_CODE_OBSOLETE
+            );
+        }
+
+        $foundElements = $xml->xpath('/widgets/*/*/*/block_name');
+        foreach ($foundElements as $element) {
+            $phpcsFile->addError(
+                "Obsolete node: <block_name>. To be replaced with <container_name>",
+                dom_import_simplexml($element)->getLineNo() - 1,
+                self::ERROR_CODE_OBSOLETE
+            );
+        }
+    }
+
+    /**
+     * 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);
+
+        return $node->getLineNo() === $stackPtr + 1;
+    }
+
+    /**
+     * 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/WidgetXMLUnitTest.1.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<widgets>
+    <widget type="/Deprecated">
+        <label translate="true">Catalog New Products List</label>
+        <description translate="true">List of Products that are set as New</description>
+        <supported_blocks>Deprecated
+            <block>
+                <block_name>Deprecated</block_name>
+            </block>
+        </supported_blocks>
+    </widget>
+</widgets>
+

Magento2/Tests/Legacy/WidgetXMLUnitTest.php

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