AC-660: Create phpcs static check for DiConfigTest

- Refactor: Simplify approach

Author: loginesta

Magento2/Sniffs/Legacy/DiConfigSniff.php

@@ -6,29 +6,19 @@
 
 namespace Magento2\Sniffs\Legacy;
 
-use DOMDocument;
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 
 class DiConfigSniff implements Sniff
 {
     private const WARNING_CODE = 'FoundObsoleteAttribute';
-    private const ERROR_CODE = 'WrongXML';
 
     private $xpathObsoleteElems = [
-        'param',
-        'instance',
-        'array',
-        'item[@key]',
-        'value'
-    ];
-
-    private $messages = [
-        'param' => 'The <param> node is obsolete. Instead, use the <argument name="..." xsi:type="...">',
-        'instance' => 'The <instance> node is obsolete. Instead, use the <argument name="..." xsi:type="object">',
-        'array' => 'The <array> node is obsolete. Instead, use the <argument name="..." xsi:type="array">',
-        'item[@key]' => 'The <item key="..."> node is obsolete. Instead, use the <item name="..." xsi:type="...">',
-        'value' => 'The <value> node is obsolete. Instead, provide the actual value as a text literal.'
+        '<param' => 'The <param> node is obsolete. Instead, use the <argument name="..." xsi:type="...">',
+        '<instance' => 'The <instance> node is obsolete. Instead, use the <argument name="..." xsi:type="object">',
+        '<array' => 'The <array> node is obsolete. Instead, use the <argument name="..." xsi:type="array">',
+        '<item key=' => 'The <item key="..."> node is obsolete. Instead, use the <item name="..." xsi:type="...">',
+        '<value' => 'The <value> node is obsolete. Instead, provide the actual value as a text literal.'
     ];
 
     public function register(): array
@@ -40,41 +30,16 @@ public function register(): array
 
     public function process(File $phpcsFile, $stackPtr)
     {
-        $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
-            );
-        }
+        $lineContent = $phpcsFile->getTokensAsString($stackPtr, 1);
 
-        foreach ($this->xpathObsoleteElems as $obsoleteElem) {
-            $found = $xml->xpath($obsoleteElem);
-            if ($found === true) {
+        foreach ($this->xpathObsoleteElems as $elem => $message ) {
+            if (strpos($lineContent, $elem) !== false) {
                 $phpcsFile->addWarning(
-                    $this->messages[$obsoleteElem],
+                    $message,
                     $stackPtr,
                     self::WARNING_CODE
                 );
             }
         }
     }
-
-    /**
-     * 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/DiConfigUnitTest.php

@@ -23,12 +23,11 @@ public function getErrorList(): array
     public function getWarningList(): array
     {
         return [
-            9 => 1,
-            10 => 1,
-            11 => 1,
             12 => 1,
-            13 => 1,
-            15 => 1
+            16 => 1,
+            17 => 1,
+            18 => 1,
+            19 => 1
         ];
     }
-}
+}

Magento2/Tests/Legacy/DiConfigUnitTest.xml

@@ -20,4 +20,4 @@
             </param>
         </array>
     </instance>
-</config>
+</config>

Magento2/ruleset.xml

@@ -225,7 +225,6 @@
     </rule>
     <rule ref="Magento2.Legacy.DiConfig">
         <include-pattern>*\/di.xml$</include-pattern>
-        <include-pattern>*\/DiConfigUnitTest.xml$</include-pattern>
         <severity>8</severity>
         <type>warning</type>
     </rule>

composer.json

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