Merge pull request #82 from magento-commerce/imported-loginesta-magento-coding-standard-285

[Imported] AC-674: Create phpcs static check for ObsoleteAclTest

Author: loginesta

Magento2/Sniffs/Legacy/ObsoleteAclSniff.php

@@ -0,0 +1,62 @@
+<?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 to find obsolete acl declaration
+ */
+class ObsoleteAclSniff implements Sniff
+{
+    private const WARNING_OBSOLETE_ACL_STRUCTURE = 'ObsoleteAclStructure';
+
+    /**
+     * @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));
+        $foundElements = $xml->xpath('/config/acl/*[boolean(./children) or boolean(./title)]');
+        foreach ($foundElements as $element) {
+            $phpcsFile->addWarning(
+                'Obsolete acl structure detected in line ' . dom_import_simplexml($element)->getLineNo(),
+                dom_import_simplexml($element)->getLineNo() - 1,
+                self::WARNING_OBSOLETE_ACL_STRUCTURE
+            );
+        }
+    }
+
+    /**
+     * 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/ObsoleteAclUnitTest.php

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

Magento2/Tests/Legacy/ObsoleteAclUnitTest.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/**
+ * 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:Acl/etc/acl.xsd">
+    <children>
+        <title value="foo"/>
+    </children>
+    <title value="bar"/>
+    <children default_policy="deny"/>
+    <acl>
+        <children>
+            <title value="foo"/>
+        </children>
+        <children default_policy="deny"/>
+        <title value="bar"/>
+        <title>
+            <children default_policy="deny"/>
+        </title>
+        <children>
+            <title
+                    value="foo"/>
+        </children>
+    </acl>
+</config>

Magento2/ruleset.xml

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