MC-29289: Adjusting PHPStan configuration based on Magento codebase analysis

- Updated to 0.12.2 version

Author: viktym

composer.json

@@ -92,7 +92,7 @@
         "pdepend/pdepend": "2.5.2",
         "phpcompatibility/php-compatibility": "^9.3",
         "phpmd/phpmd": "@stable",
-        "phpstan/phpstan": "^0.11.19",
+        "phpstan/phpstan": "^0.12.2",
         "phpunit/phpunit": "~6.5.0",
         "sebastian/phpcpd": "~3.0.0",
         "squizlabs/php_codesniffer": "~3.4.0"

composer.lock

@@ -9,8 +9,7 @@
 
 use PHPStan\Command\AnalysisResult;
 use PHPStan\Command\ErrorFormatter\TableErrorFormatter;
-use PHPStan\File\RelativePathHelper;
-use Symfony\Component\Console\Style\OutputStyle;
+use PHPStan\Command\Output;
 
 /**
  * To mute the PHPStan error message add a comment above the reported error line.
@@ -47,10 +46,11 @@ class FilteredErrorFormatter extends TableErrorFormatter
     /**
      * @inheritdoc
      */
-    public function formatErrors(AnalysisResult $analysisResult, OutputStyle $outputStyle): int
+    public function formatErrors(AnalysisResult $analysisResult, Output $output): int
     {
         if (!$analysisResult->hasErrors()) {
-            $outputStyle->success('No errors');
+            $style = $output->getStyle();
+            $style->success('No errors');
             return self::NO_ERRORS;
         }
 
@@ -62,12 +62,11 @@ public function formatErrors(AnalysisResult $analysisResult, OutputStyle $output
             $fileSpecificErrorsWithoutIgnoredErrors,
             $analysisResult->getNotFileSpecificErrors(),
             $analysisResult->isDefaultLevelUsed(),
-            $analysisResult->getCurrentDirectory(),
             $analysisResult->hasInferrablePropertyTypesFromConstructor(),
             $analysisResult->getProjectConfigFile()
         );
 
-        return parent::formatErrors($clearedAnalysisResult, $outputStyle);
+        return parent::formatErrors($clearedAnalysisResult, $output);
     }
 
     /**

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

@@ -16,7 +16,7 @@
 
 if (!defined('TESTS_TEMP_DIR')) {
     //phpcs:ignore Magento2.Functions.DiscouragedFunction
-    define('TESTS_TEMP_DIR', dirname(__DIR__) . '../../tmp');
+    define('TESTS_TEMP_DIR', dirname(__DIR__) . '/../../tmp');
 }
 
 $generatorIo = new Io(

dev/tests/static/framework/Magento/PhpStan/autoload.php

@@ -9,37 +9,16 @@
 
 use PHPStan\Analyser\Error;
 use PHPStan\Command\AnalysisResult;
-use PHPStan\Command\ErrorsConsoleStyle;
 use PHPStan\File\FuzzyRelativePathHelper;
 use PHPStan\ShouldNotHappenException;
-use Symfony\Component\Console\Input\StringInput;
-use Symfony\Component\Console\Output\StreamOutput;
+use PHPStan\Testing\ErrorFormatterTestCase;
 
 /**
  * Tests filter error formatter.
  */
-class FilteredErrorFormatterTest extends \PHPUnit\Framework\TestCase
+class FilteredErrorFormatterTest extends ErrorFormatterTestCase
 {
-    private const DIRECTORY_PATH = __DIR__ . '/Fixtures';
-
-    /** @var StreamOutput */
-    private $outputStream;
-
-    /** @var ErrorsConsoleStyle */
-    private $errorConsoleStyle;
-
-    /**
-     * @throws ShouldNotHappenException
-     */
-    protected function setUp(): void
-    {
-        $resource = fopen('php://memory', 'w', false);
-        if ($resource === false) {
-            throw new ShouldNotHappenException();
-        }
-        $this->outputStream = new StreamOutput($resource);
-        $this->errorConsoleStyle = new ErrorsConsoleStyle(new StringInput(''), $this->outputStream);
-    }
+    protected const DIRECTORY_PATH = __DIR__ . '/Fixtures';
 
     /**
      * Tests errors filtering.
@@ -62,14 +41,14 @@ public function testFormatErrors(
             new FuzzyRelativePathHelper(self::DIRECTORY_PATH, '/', []),
             false,
             false,
-            false
+            false,
+            true
         );
 
         $analysisResult = new AnalysisResult(
             $fileErrors,
             [],
             false,
-            self::DIRECTORY_PATH,
             false,
             null
         );
@@ -78,7 +57,7 @@ public function testFormatErrors(
             $exitCode,
             $formatter->formatErrors(
                 $analysisResult,
-                $this->errorConsoleStyle
+                $this->getOutput()
             ),
             sprintf('%s: response code do not match', $message)
         );
@@ -161,35 +140,4 @@ public function dataFormatterOutputProvider(): array
             ]
         ];
     }
-
-    /**
-     * @return string
-     * @throws ShouldNotHappenException
-     */
-    private function getOutputContent(): string
-    {
-        rewind($this->outputStream->getStream());
-        $contents = stream_get_contents($this->outputStream->getStream());
-        if ($contents === false) {
-            throw new ShouldNotHappenException();
-        }
-
-        return $this->rtrimMultiline($contents);
-    }
-
-    /**
-     * @param string $output
-     * @return string
-     */
-    private function rtrimMultiline(string $output): string
-    {
-        $result = array_map(
-            function (string $line): string {
-                return rtrim($line, " \r\n");
-            },
-            explode("\n", $output)
-        );
-
-        return implode("\n", $result);
-    }
 }

dev/tests/static/framework/tests/unit/testsuite/Magento/PhpStan/Formatters/FilteredErrorFormatterTest.php

@@ -1,6 +1,5 @@
 parameters:
-	featureToggles:
-		missingReturnRule: true
+	checkExplicitMixedMissingReturn: true
 	checkPhpDocMissingReturn: true
 	reportUnmatchedIgnoredErrors: false
 	excludes_analyse:
@@ -9,6 +8,7 @@ parameters:
 		- %rootDir%/../../../dev/tests/functional/*
 		- %rootDir%/../../../dev/tests/*/Fixtures/*
 		- %rootDir%/../../../dev/tests/*/tmp/*
+		- %rootDir%/../../../dev/tests/*/_generated/*
 		- %rootDir%/../../../pub/*
 	autoload_directories:
 		- %rootDir%/../../../dev/tests/static/framework/tests/unit/testsuite/Magento
@@ -35,3 +35,4 @@ services:
 			showTipsOfTheDay: false
 			checkThisOnly: false
 			inferPrivatePropertyTypeFromConstructor: true
+			checkMissingTypehints: %checkMissingTypehints%

dev/tests/static/framework/tmp/.gitignore

@@ -43,6 +43,9 @@ public function generate($className)
      */
     private function isFactory($className)
     {
+        if (!preg_match('/[\\\A-Z]/', substr(ltrim($className), 0, 1))) {
+            return false;
+        }
         $sourceName = rtrim(substr($className, 0, -strlen('Factory')), '\\');
         return $sourceName . 'Factory' == $className;
     }