AC-679: Create phpcs static check for ObsoleteSystemConfigurationTest

Author: eliseacornejo

Magento2/Sniffs/Legacy/ObsoleteSystemConfigurationSniff.php

@@ -0,0 +1,88 @@
+<?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;
+
+class ObsoleteSystemConfigurationSniff implements Sniff
+{
+    private const ERROR_CODE_XML = 'WrongXML';
+    private const WARNING_CODE_OBSOLETE = 'FoundObsoleteSystemConfiguration';
+    
+    public function register()
+    {
+        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) {
+            $this->invalidXML($phpcsFile, $stackPtr);
+            return;
+        }
+        
+        $foundElements = $xml->xpath('/config/tabs|/config/sections');
+        
+        if ($foundElements === false) {
+            return;
+        }
+        
+        foreach ($foundElements as $element) {
+            $phpcsFile->addWarning(
+                "Obsolete system configuration structure detected in file.",
+                dom_import_simplexml($element)->getLineNo() - 1,
+                self::WARNING_CODE_OBSOLETE
+            );
+        }
+    }
+
+    /**
+     * Adds an invalid XML error
+     *
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     */
+    protected function invalidXML(File $phpcsFile, int $stackPtr): void
+    {
+        $phpcsFile->addError(
+            sprintf(
+                "Couldn't parse contents of '%s', check that they are in valid XML format.",
+                $phpcsFile->getFilename(),
+            ),
+            $stackPtr,
+            self::ERROR_CODE_XML
+        );
+    }
+
+    /**
+     * 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/ObsoleteSystemConfigurationUnitTest.1.xml

@@ -0,0 +1,11 @@
+<?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:module:Magento_Config:etc/system_file.xsd">
+    <sections>test sections</sections>
+    <tabs>test tabs</tabs>    
+</config>

Magento2/Tests/Legacy/ObsoleteSystemConfigurationUnitTest.2.xml

@@ -0,0 +1,15 @@
+<?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:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <sections>test no error</sections>
+        <tabs>test no error</tabs>
+        <section id="admin">
+        </section>
+    </system>
+</config>

Magento2/Tests/Legacy/ObsoleteSystemConfigurationUnitTest.php

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

Magento2/ruleset.xml

@@ -283,6 +283,11 @@
         <severity>8</severity>
         <type>warning</type>
     </rule>
+    <rule ref="Magento2.Legacy.ObsoleteSystemConfiguration">
+        <include-pattern>etc/system.xml</include-pattern>
+        <severity>8</severity>
+        <type>warning</type>
+    </rule>
 
     <!-- Severity 7 warnings: General code issues. -->
     <rule ref="Generic.Arrays.DisallowLongArraySyntax">