AC-670: Create phpcs static check for LayoutTest

Author: svera

Magento2/Sniffs/Legacy/LayoutSniff.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types = 1);
 
 namespace Magento2\Sniffs\Legacy;
 
@@ -20,7 +21,6 @@ class LayoutSniff implements Sniff
     private const ERROR_CODE_NOT_ALLOWED = 'NotAllowed';
     private const ERROR_CODE_OBSOLETE = 'Obsolete';
     private const ERROR_CODE_OBSOLETE_CLASS = 'ObsoleteClass';
-    private const ERROR_CODE_ATTRIBUTE_NOT_VALID = 'AttributeNotValid';
     private const ERROR_CODE_METHOD_NOT_ALLOWED = 'MethodNotAllowed';
     private const ERROR_CODE_HELPER_ATTRIBUTE_CHARACTER_NOT_ALLOWED = 'CharacterNotAllowedInAttribute';
     private const ERROR_CODE_HELPER_ATTRIBUTE_CHARACTER_EXPECTED = 'CharacterExpectedInAttribute';
@@ -229,7 +229,6 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $this->testObsoleteReferences($layout, $phpcsFile);
-        $this->testObsoleteAttributes($layout, $phpcsFile);
         $this->testHeadBlocks($layout, $phpcsFile);
         $this->testOutputAttribute($layout, $phpcsFile);
         $this->testHelperAttribute($layout, $phpcsFile);
@@ -240,21 +239,21 @@ public function process(File $phpcsFile, $stackPtr)
     /**
      * Check for obsolete block references
      *
-     * @todo missing test
      * @param SimpleXMLElement $layout
      * @param File $phpcsFile
      */
     private function testObsoleteReferences(SimpleXMLElement $layout, File $phpcsFile): void
     {
         foreach ($layout as $handle) {
-            if (!isset($this->obsoleteReferences[$handle->getName()])) {
+            $attributes = $handle->attributes();
+            if (!isset($this->obsoleteReferences[(string)$attributes->handle])) {
                 continue;
             }
-            foreach ($handle->xpath('reference') as $reference) {
-                if (strpos((string)$reference['name'], $this->obsoleteReferences[$handle->getName()]) !== false) {
+            foreach ($handle->xpath('//reference | //referenceContainer | //referenceBlock') as $reference) {
+                if (in_array((string)$reference['name'], $this->obsoleteReferences[(string)$attributes->handle]) !== false) {
                     $phpcsFile->addError(
                         'The block being referenced is removed.',
-                        dom_import_simplexml($reference)->getLineNo(),
+                        dom_import_simplexml($reference)->getLineNo()-1,
                         self::ERROR_CODE_OBSOLETE
                     );
                 }
@@ -317,45 +316,12 @@ private function testOutputAttribute(SimpleXMLElement $layout, File $phpcsFile):
         if (!empty($elements)) {
             $phpcsFile->addError(
                 'output="toHtml" is obsolete. Use output="1"',
-                dom_import_simplexml($elements[0])->getLineNo(),
+                dom_import_simplexml($elements[0])->getLineNo()-1,
                 self::ERROR_CODE_OBSOLETE
             );
         };
     }
 
-    /**
-     * Tests the attributes of the top-level Layout Node. Verifies there are no longer attributes of "parent" or "owner"
-     *
-     * @todo missing test
-     * @param SimpleXMLElement $layout
-     * @param File $phpcsFile
-     */
-    private function testObsoleteAttributes(SimpleXMLElement $layout, File $phpcsFile): void
-    {
-        $type = $layout['type'];
-        $parent = $layout['parent'];
-        $owner = $layout['owner'];
-
-        if ((string)$type === 'page') {
-            if ($parent) {
-                $phpcsFile->addError(
-                    'Attribute "parent" is not valid',
-                    dom_import_simplexml($parent)->getLineNo(),
-                    self::ERROR_CODE_ATTRIBUTE_NOT_VALID
-                );
-            }
-        }
-        if ((string)$type === 'fragment') {
-            if ($owner) {
-                $phpcsFile->addError(
-                    'Attribute "owner" is not valid',
-                    dom_import_simplexml($owner)->getLineNo(),
-                    self::ERROR_CODE_ATTRIBUTE_NOT_VALID
-                );
-            }
-        }
-    }
-
     /**
      * Returns attribute value by attribute name
      *
@@ -381,14 +347,14 @@ private function testHelperAttribute(SimpleXMLElement $layout, File $phpcsFile):
             if (strpos($this->getAttribute($action, 'helper'), '/') !== false) {
                 $phpcsFile->addError(
                     "'helper' attribute contains '/'",
-                    dom_import_simplexml($action)->getLineNo(),
+                    dom_import_simplexml($action)->getLineNo()-1,
                     self::ERROR_CODE_HELPER_ATTRIBUTE_CHARACTER_NOT_ALLOWED
                 );
             }
             if (strpos($this->getAttribute($action, 'helper'), '::') === false) {
                 $phpcsFile->addError(
                     "'helper' attribute does not contain '::'",
-                    dom_import_simplexml($action)->getLineNo(),
+                    dom_import_simplexml($action)->getLineNo()-1,
                     self::ERROR_CODE_HELPER_ATTRIBUTE_CHARACTER_EXPECTED
                 );
             }
@@ -408,7 +374,7 @@ private function testListText(SimpleXMLElement $layout, File $phpcsFile): void
             $phpcsFile->addError(
                 'The class \Magento\Framework\View\Element\Text\ListText' .
                 ' is not supposed to be used in layout anymore.',
-                dom_import_simplexml($elements[0])->getLineNo(),
+                dom_import_simplexml($elements[0])->getLineNo()-1,
                 self::ERROR_CODE_OBSOLETE_CLASS
             );
         };
@@ -430,7 +396,7 @@ private function testActionNodeMethods(SimpleXMLElement $layout, File $phpcsFile
                     'Call of method "%s" via layout instruction <action> is not allowed.',
                     $attributes['method']
                 ),
-                dom_import_simplexml($node)->getLineNo(),
+                dom_import_simplexml($node)->getLineNo()-1,
                 self::ERROR_CODE_METHOD_NOT_ALLOWED
             );
         }

Magento2/Tests/Legacy/LayoutUnitTest.1.xml

@@ -6,11 +6,11 @@
  */
 -->
 <page layout="3columns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
-    <update handle="default_head_blocks"/>
+    <update handle="adminhtml_user_edit"/>
     <body>
         <attribute name="id" value="html-body"/>
         <block name="require.js" class="Magento\Framework\View\Element\Template" template="Magento_Theme::page/js/require_js.phtml" />
-        <referenceContainer name="after.body.start">
+        <referenceContainer name="adminhtml.permission.user.edit.tabs">
             <block class="Magento\RequireJs\Block\Html\Head\Config" name="requirejs-config"/>
             <block class="Magento\Framework\View\Element\Js\Cookie" name="js_cookies" template="Magento_Theme::js/cookie.phtml">
                 <arguments>
@@ -19,7 +19,7 @@
             </block>
             <block class="Magento\Theme\Block\Html\Notices" name="global_notices" template="Magento_Theme::html/notices.phtml"/>
         </referenceContainer>
-        <referenceBlock name="top.links">
+        <referenceBlock name="adminhtml.permission.user.edit">
             <block class="Magento\Theme\Block\Html\Head\Css">
             </block>
             <block class="Magento\Theme\Block\Html\Header" name="header" as="header" before="-">

Magento2/Tests/Legacy/LayoutUnitTest.php

@@ -16,21 +16,23 @@ public function getErrorList($testFile = '')
     {
         if ($testFile === 'LayoutUnitTest.1.xml') {
             return [
+                13 => 1,
+                22 => 1,
                 23 => 1,
-                146 => 1,
-                149 => 1,
+                145 => 1,
+                148 => 1,
             ];
         }
         if ($testFile === 'LayoutUnitTest.2.xml') {
             return [
-                12 => 1,
-                29 => 1,
+                11 => 1,
+                28 => 1,
             ];
         }
         if ($testFile === 'LayoutUnitTest.3.xml') {
             return [
-                16 => 1,
-                19 => 1,
+                15 => 1,
+                18 => 1,
             ];
         }
         return [];