Merge pull request #5109 from magento-mpi/MC-23067

[MPI] Introduce PHPStan code analysis tool to the static build

Author: viktym

composer.json

@@ -92,6 +92,7 @@
         "pdepend/pdepend": "2.5.2",
         "phpcompatibility/php-compatibility": "^9.3",
         "phpmd/phpmd": "@stable",
+        "phpstan/phpstan": "^0.12.2",
         "phpunit/phpunit": "~6.5.0",
         "sebastian/phpcpd": "~3.0.0",
         "squizlabs/php_codesniffer": "~3.4.0"
@@ -341,7 +342,8 @@
             "Magento\\Tools\\": "dev/tools/Magento/Tools/",
             "Magento\\Tools\\Sanity\\": "dev/build/publication/sanity/Magento/Tools/Sanity/",
             "Magento\\TestFramework\\Inspection\\": "dev/tests/static/framework/Magento/TestFramework/Inspection/",
-            "Magento\\TestFramework\\Utility\\": "dev/tests/static/framework/Magento/TestFramework/Utility/"
+            "Magento\\TestFramework\\Utility\\": "dev/tests/static/framework/Magento/TestFramework/Utility/",
+            "Magento\\PhpStan\\": "dev/tests/static/framework/Magento/PhpStan/"
         }
     },
     "prefer-stable": true

composer.lock

@@ -16,7 +16,7 @@ class GeneralTest extends \PHPUnit\Framework\TestCase
     /** @var \Magento\Framework\View\Design\ThemeInterface */
     protected $_theme;
 
-    /** @var \Magento\Theme\Block\Adminhtml\System\Design\Theme\Edit\Tab_General */
+    /** @var \Magento\Theme\Block\Adminhtml\System\Design\Theme\Edit\Tab\General */
     protected $_block;
 
     protected function setUp()

dev/tests/integration/testsuite/Magento/Theme/Block/Adminhtml/System/Design/Theme/Edit/Tab/GeneralTest.php

@@ -0,0 +1,142 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PhpStan\Formatters;
+
+use PHPStan\Command\AnalysisResult;
+use PHPStan\Command\ErrorFormatter\TableErrorFormatter;
+use PHPStan\Command\Output;
+
+/**
+ * To mute the PHPStan error message add a comment above the reported error line.
+ *
+ * Example of usage:
+ *
+ *   // phpstan:ignore "Method Magento\TestModule\TestClass::testMethod() invoked with 1 parameter, 0 required."
+ *   $this->testMethod(1);
+ *
+ * or replace some part of error message with *
+ *
+ *   // phpstan:ignore "Method * invoked with 1 parameter, 0 required."
+ *   $this->testMethod(1);
+ *
+ * or just
+ *
+ *   // phpstan:ignore
+ *   $this->testMethod(1);
+ *
+ * or
+ *
+ *   $this->testMethod(1); // phpstan:ignore
+ *
+ * The error message will be suppressed.
+ *
+ * @see \Magento\PhpStan\Formatters\Fixtures\ClassWithIgnoreAnnotation
+ */
+class FilteredErrorFormatter extends TableErrorFormatter
+{
+    private const MUTE_ERROR_ANNOTATION = 'phpstan:ignore';
+
+    private const NO_ERRORS = 0;
+
+    /**
+     * @inheritdoc
+     */
+    public function formatErrors(AnalysisResult $analysisResult, Output $output): int
+    {
+        if (!$analysisResult->hasErrors()) {
+            $style = $output->getStyle();
+            $style->success('No errors');
+            return self::NO_ERRORS;
+        }
+
+        $fileSpecificErrorsWithoutIgnoredErrors = $this->clearIgnoredErrors(
+            $analysisResult->getFileSpecificErrors()
+        );
+
+        $clearedAnalysisResult = new AnalysisResult(
+            $fileSpecificErrorsWithoutIgnoredErrors,
+            $analysisResult->getNotFileSpecificErrors(),
+            $analysisResult->isDefaultLevelUsed(),
+            $analysisResult->hasInferrablePropertyTypesFromConstructor(),
+            $analysisResult->getProjectConfigFile()
+        );
+
+        return parent::formatErrors($clearedAnalysisResult, $output);
+    }
+
+    /**
+     * Filters error list.
+     *
+     * @param array $fileSpecificErrors
+     * @return array
+     */
+    private function clearIgnoredErrors(array $fileSpecificErrors): array
+    {
+        foreach ($fileSpecificErrors as $index => $error) {
+            $fileName = $error->getFile();
+            // phpcs:ignore Magento2.Functions.DiscouragedFunction
+            if (!file_exists($fileName)) {
+                continue;
+            }
+
+            $line = $error->getLine() ? $this->getLineWithMuteErrorAnnotation($error->getLine(), $fileName) : null;
+            if ($line === null) {
+                continue;
+            }
+
+            $extractErrorPattern = '@' . self::MUTE_ERROR_ANNOTATION . '\s+"(.*?)"@';
+            $errorPattern = preg_match($extractErrorPattern, $line, $result) ? $this->preparePattern($result[1]) : '';
+            if ($errorPattern && !preg_match('@' . $errorPattern . '@i', $error->getMessage())) {
+                continue;
+            }
+
+            unset($fileSpecificErrors[$index]);
+        }
+
+        return $fileSpecificErrors;
+    }
+
+    /**
+     * Returns context of the line with mute error annotation.
+     *
+     * @param int $errorLine
+     * @param string $fileName
+     * @return string|null
+     */
+    private function getLineWithMuteErrorAnnotation(int $errorLine, string $fileName): ?string
+    {
+        $file = new \SplFileObject($fileName);
+        $lineNumbersToCheck = [
+            $errorLine - 2, // the line above to the line that caused the error
+            $errorLine - 1, // the line that caused the error
+            $errorLine - 3, // the line two lines above to the line that caused the error
+        ];
+
+        foreach ($lineNumbersToCheck as $lineNumber) {
+            $file->seek($lineNumber > 0 ? $lineNumber : 0);
+            $line = $file->current();
+            if (strpos($line, self::MUTE_ERROR_ANNOTATION) !== false) {
+                return $line;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Prepares error pattern.
+     *
+     * @param string $errorDescription
+     * @return string
+     */
+    private function preparePattern(string $errorDescription)
+    {
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
+        return str_replace('*', '(?:.*?)', addcslashes(trim($errorDescription), '\()[]'));
+    }
+}

dev/tests/static/framework/Magento/PhpStan/Formatters/FilteredErrorFormatter.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+// phpcs:disable
+
+use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Code\Generator\Io;
+use Magento\Framework\Filesystem\Driver\File;
+use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionAttributesGenerator;
+use Magento\Framework\TestFramework\Unit\Autoloader\ExtensionAttributesInterfaceGenerator;
+use Magento\Framework\TestFramework\Unit\Autoloader\FactoryGenerator;
+use Magento\Framework\TestFramework\Unit\Autoloader\GeneratedClassesAutoloader;
+
+if (!defined('TESTS_TEMP_DIR')) {
+    //phpcs:ignore Magento2.Functions.DiscouragedFunction
+    define('TESTS_TEMP_DIR', dirname(__DIR__) . '/../../tmp');
+}
+
+$generatorIo = new Io(
+    new File(),
+    TESTS_TEMP_DIR . '/' . DirectoryList::getDefaultConfig()[DirectoryList::GENERATED_CODE][DirectoryList::PATH]
+);
+$generatedCodeAutoloader = new GeneratedClassesAutoloader(
+    [
+        new ExtensionAttributesGenerator(),
+        new ExtensionAttributesInterfaceGenerator(),
+        new FactoryGenerator(),
+    ],
+    $generatorIo
+);
+spl_autoload_register([$generatedCodeAutoloader, 'load']);