[Imported] Fix DirectThrowSniff false positive (#137)

* Fix DirectThrowSniff false positive

* fix custom exception gives false positive with DirectThrowSniff

* fix coding standard

* Apply suggestions from code review

Co-authored-by: Sergio Vera <[email protected]>

* Fix error

Co-authored-by: MeenakshiSundaram <[email protected]>
Co-authored-by: Sergio Vera <[email protected]>

Author: 3 people

Magento2/Sniffs/Exceptions/DirectThrowSniff.php

@@ -44,7 +44,30 @@ public function process(File $phpcsFile, $stackPtr)
         $tokens = $phpcsFile->getTokens();
         $endOfStatement = $phpcsFile->findEndOfStatement($stackPtr);
         $posOfException = $phpcsFile->findNext(T_STRING, $stackPtr, $endOfStatement);
-        if ($tokens[$posOfException]['content'] === 'Exception') {
+
+        $fullExceptionString = $this->getFullClassNameAndAlias($tokens, $stackPtr, $endOfStatement);
+        $exceptionString = 'Exception';
+        $customExceptionFound = false;
+        foreach ($tokens as $key => $token) {
+            if ($token['code'] !== T_USE) {
+                continue;
+            }
+            $endOfUse = $phpcsFile->findEndOfStatement($key);
+            $useStatementValue = $this->getFullClassNameAndAlias($tokens, $key, $endOfUse);
+            //we safely consider use statement has alias will not be a direct exception class
+            if (empty($useStatementValue['alias'])) {
+                if (substr($useStatementValue['name'], 0, strlen($exceptionString)) !== $exceptionString
+                    && substr($useStatementValue['name'], -strlen($exceptionString)) === $exceptionString
+                    && $useStatementValue['name'] !== $exceptionString
+                ) {
+                    $customExceptionFound = true;
+                    break;
+                }
+            }
+        }
+        if (($tokens[$posOfException]['content'] === 'Exception' && !$customExceptionFound)
+            || $fullExceptionString['name'] === '\Exception'
+        ) {
             $phpcsFile->addWarning(
                 $this->warningMessage,
                 $stackPtr,
@@ -53,4 +76,33 @@ public function process(File $phpcsFile, $stackPtr)
             );
         }
     }
+
+    /**
+     * Get full class name and alias
+     *
+     * @param array $tokens
+     * @param int $start
+     * @param int $end
+     * @return array
+     */
+    private function getFullClassNameAndAlias($tokens, $start, $end): array
+    {
+        $fullName = $alias = '';
+        $foundAlias = false;
+        for ($i = $start; $i <= $end; $i++) {
+            $type = $tokens[$i]['code'];
+            if ($type === T_AS) {
+                $foundAlias = true;
+                continue;
+            }
+            if ($type === T_STRING || $type === T_NS_SEPARATOR) {
+                if (!$foundAlias) {
+                    $fullName .= $tokens[$i]['content'];
+                } else {
+                    $alias = $tokens[$i]['content'];
+                }
+            }
+        }
+        return ['name' => $fullName, 'alias' => $alias];
+    }
 }

Magento2/Tests/Exceptions/DirectThrowUnitTest.inc renamed to Magento2/Tests/Exceptions/DirectThrowUnitTest.1.inc

@@ -0,0 +1,31 @@
+<?php
+namespace Vendor\Module\Anyname;
+
+use Vendor\Module\Anyname\Exception;
+
+class Foo
+{
+    protected $isEnabled = true;
+
+    public function go()
+    {
+        if (!$this->isEnabled) {
+            throw new Exception('Action disabled.');
+        }
+    }
+
+    public function exceptionTest()
+    {
+        if (!$this->isEnabled) {
+            throw new \Exception('Action disabled.');
+        }
+    }
+
+    public function localizedExceptionTest()
+    {
+
+        if (!$this->isEnabled) {
+            throw new LocalizedException('Localized exception.');
+        }
+    }
+}

Magento2/Tests/Exceptions/DirectThrowUnitTest.2.inc

@@ -12,19 +12,26 @@ class DirectThrowUnitTest extends AbstractSniffUnitTest
     /**
      * @inheritdoc
      */
-    public function getErrorList()
+    protected function getErrorList()
     {
         return [];
     }
 
     /**
      * @inheritdoc
      */
-    public function getWarningList()
+    protected function getWarningList($testFile = '')
     {
-        return [
-            10 => 1,
-            17 => 1,
-        ];
+        if ($testFile === 'DirectThrowUnitTest.1.inc') {
+            return [
+                10 => 1,
+                17 => 1,
+            ];
+        } elseif ($testFile === 'DirectThrowUnitTest.2.inc') {
+            return [
+                20 => 1
+            ];
+        }
+        return [];
     }
 }