Merge pull request #96 from magento-commerce/imported-eliseacornejo-magento-coding-standard-310

[Imported] AC-676: Create phpcs static check for ObsoleteConnectionTest

Author: eliseacornejo

Magento2/Sniffs/Legacy/ObsoleteConnectionSniff.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types = 1);
+
+namespace Magento2\Sniffs\Legacy;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ObsoleteConnectionSniff implements Sniff
+{
+    private const ERROR_CODE_METHOD = 'FoundObsoleteMethod';
+
+    /**
+     * @var string[]
+     */
+    private $obsoleteMethods = [
+        '_getReadConnection',
+        '_getWriteConnection',
+        '_getReadAdapter',
+        '_getWriteAdapter',
+        'getReadConnection',
+        'getWriteConnection',
+        'getReadAdapter',
+        'getWriteAdapter',
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public function register()
+    {
+        return [
+            T_OBJECT_OPERATOR,
+            T_FUNCTION
+        ];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $this->validateObsoleteMethod($phpcsFile, $stackPtr);
+    }
+
+    /**
+     * Check if obsolete methods are used
+     *
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     */
+    private function validateObsoleteMethod(File $phpcsFile, int $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $stringPos = $phpcsFile->findNext(T_STRING, $stackPtr + 1);
+        
+        foreach ($this->obsoleteMethods as $method) {
+            if ($tokens[$stringPos]['content'] === $method) {
+                $phpcsFile->addWarning(
+                    sprintf("Contains obsolete method: %s. Please use getConnection method instead.", $method),
+                    $stackPtr,
+                    self::ERROR_CODE_METHOD
+                );
+            }
+        }
+    }
+}

Magento2/Tests/Legacy/ObsoleteConnectionUnitTest.inc

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+$this->_getReadConnection();
+
+$connection = new Connection();
+return $connection->_getWriteConnection();
+
+$this->getMethod(
+    function($param){
+        $param->_getWriteAdapter();
+    }
+);
+
+$writeAdapter = $this->getWriteAdapter();
+
+protected function getConnection()
+{
+    return $this->_resource->getReadConnection($this->connection);
+}
+
+return $this->_getReadAdapter();
+
+$this->getReadAdapterMyMehtod();
+
+private function getReadAdapter()
+{
+
+}
+
+$getWriteAdapter = new WriteAdapter();
+
+$getWriteAdapter = $this->getWriteAdapter();

Magento2/Tests/Legacy/ObsoleteConnectionUnitTest.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Legacy;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class ObsoleteConnectionUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList()
+    {
+        return [];
+    }
+    
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList()
+    {
+        return [
+            7 => 1,
+            10 => 1,
+            14 => 1,
+            18 => 1,
+            22 => 1,
+            25 => 1,
+            29 => 1,
+            36 => 1
+        ];
+    }
+}

Magento2/ruleset.xml

@@ -313,6 +313,10 @@
         <severity>8</severity>
         <type>warning</type>
     </rule>
+    <rule ref="Magento2.Legacy.ObsoleteConnection">
+        <severity>8</severity>
+        <type>warning</type>
+    </rule>
 
     <!-- Severity 7 warnings: General code issues. -->
     <rule ref="Generic.Arrays.DisallowLongArraySyntax">