Display target PHP version

Historically it was often not quite clear to users what PHP version Psalm assumes, and why. This PR addresses this issue by printing the version and where we got it from right before scanning the files.
vimeo · Nov 27, 2021 · d19aad7 · d19aad7
1 parent 72de3b6
commit d19aad7
Show file tree

Hide file tree

Showing 31 changed files with 172 additions and 74 deletions.
diff --git a/src/Psalm/Codebase.php b/src/Psalm/Codebase.php
@@ -278,6 +278,9 @@ class Codebase
      */
     public $php_minor_version = PHP_MINOR_VERSION;
 
+    /** @var 'cli'|'config'|'composer'|'tests'|'runtime' */
+    public $php_version_source = 'runtime';
+
     /**
      * @var bool
      */

diff --git a/src/Psalm/Config.php b/src/Psalm/Config.php
@@ -2225,7 +2225,12 @@ public function addPreloadedStubFile(string $stub_file): void
 
     public function getPhpVersion(): ?string
     {
-        return $this->configured_php_version ?? $this->getPHPVersionFromComposerJson();
+        return $this->getPhpVersionFromConfig() ?? $this->getPHPVersionFromComposerJson();
+    }
+
+    public function getPhpVersionFromConfig(): ?string
+    {
+        return $this->configured_php_version;
     }
 
     private function setBooleanAttribute(string $name, bool $value): void
@@ -2237,7 +2242,7 @@ private function setBooleanAttribute(string $name, bool $value): void
      * @psalm-suppress MixedAssignment
      * @psalm-suppress MixedArrayAccess
      */
-    private function getPHPVersionFromComposerJson(): ?string
+    public function getPHPVersionFromComposerJson(): ?string
     {
         $composer_json_path = Composer::getJsonFilePath($this->base_dir);
 

diff --git a/src/Psalm/Internal/Analyzer/ProjectAnalyzer.php b/src/Psalm/Internal/Analyzer/ProjectAnalyzer.php
@@ -544,6 +544,33 @@ public function canReportIssues(string $file_path): bool
         return isset($this->project_files[$file_path]);
     }
 
+    private function generatePHPVersionMessage(): string
+    {
+        $codebase = $this->codebase;
+
+        $version = $codebase->php_major_version . '.' . $codebase->php_minor_version;
+
+        switch ($codebase->php_version_source) {
+            case 'cli':
+                $source = '(set by CLI argument)';
+                break;
+            case 'config':
+                $source = '(set by config file)';
+                break;
+            case 'composer':
+                $source = '(inferred from composer.json)';
+                break;
+            case 'tests':
+                $source = '(set by tests)';
+                break;
+            case 'runtime':
+                $source = '(inferred from current PHP version)';
+                break;
+        }
+
+        return "Target PHP version: $version $source\n";
+    }
+
     public function check(string $base_dir, bool $is_diff = false): void
     {
         $start_checks = (int)microtime(true);
@@ -574,6 +601,7 @@ public function check(string $base_dir, bool $is_diff = false): void
             }
         }
 
+        $this->progress->write($this->generatePHPVersionMessage());
         $this->progress->startScanningFiles();
 
         $diff_no_files = false;
@@ -992,6 +1020,7 @@ public function checkDir(string $dir_name): void
 
         $this->checkDirWithConfig($dir_name, $this->config, true);
 
+        $this->progress->write($this->generatePHPVersionMessage());
         $this->progress->startScanningFiles();
 
         $this->config->initializePlugins($this);
@@ -1123,6 +1152,7 @@ public function checkFile(string $file_path): void
 
         $this->file_reference_provider->loadReferenceCache();
 
+        $this->progress->write($this->generatePHPVersionMessage());
         $this->progress->startScanningFiles();
 
         $this->config->initializePlugins($this);
@@ -1164,6 +1194,7 @@ public function checkPaths(array $paths_to_check): void
 
         $this->file_reference_provider->loadReferenceCache();
 
+        $this->progress->write($this->generatePHPVersionMessage());
         $this->progress->startScanningFiles();
 
         $this->config->initializePlugins($this);
@@ -1262,7 +1293,10 @@ public function refactorCodeAfterCompletion(array $to_refactor): void
         $this->show_issues = false;
     }
 
-    public function setPhpVersion(string $version): void
+    /**
+     * @param 'cli'|'config'|'composer'|'tests' $source
+     */
+    public function setPhpVersion(string $version, string $source): void
     {
         if (!preg_match('/^(5\.[456]|7\.[01234]|8\.[01])(\..*)?$/', $version)) {
             throw new \UnexpectedValueException('Expecting a version number in the format x.y');
@@ -1283,6 +1317,7 @@ public function setPhpVersion(string $version): void
 
         $this->codebase->php_major_version = $php_major_version;
         $this->codebase->php_minor_version = $php_minor_version;
+        $this->codebase->php_version_source = $source;
     }
 
     /**

diff --git a/src/Psalm/Internal/Cli/Psalm.php b/src/Psalm/Internal/Cli/Psalm.php
@@ -332,8 +332,7 @@ function () use ($current_dir, $options, $vendor_dir): ?\Composer\Autoload\Class
             $progress
         );
 
-        self::initPhpVersion($options, $config, $project_analyzer);
-
+        CliUtils::initPhpVersion($options, $config, $project_analyzer);
 
         $start_time = microtime(true);
 
@@ -1071,21 +1070,6 @@ function (array $edges) {
         }
     }
 
-    private static function initPhpVersion(array $options, Config $config, ProjectAnalyzer $project_analyzer): void
-    {
-        if (!isset($options['php-version'])) {
-            $options['php-version'] = $config->getPhpVersion();
-        }
-
-        if (isset($options['php-version'])) {
-            if (!is_string($options['php-version'])) {
-                die('Expecting a version number in the format x.y' . PHP_EOL);
-            }
-
-            $project_analyzer->setPhpVersion($options['php-version']);
-        }
-    }
-
     /** @return false|'always'|'auto' */
     private static function shouldFindUnusedCode(array $options, Config $config)
     {

diff --git a/src/Psalm/Internal/Cli/Psalter.php b/src/Psalm/Internal/Cli/Psalter.php
@@ -281,17 +281,7 @@ function () use ($current_dir, $options, $vendor_dir): ?\Composer\Autoload\Class
             $keyed_issues = [];
         }
 
-        if (!isset($options['php-version'])) {
-            $options['php-version'] = $config->getPhpVersion();
-        }
-
-        if (isset($options['php-version'])) {
-            if (!is_string($options['php-version'])) {
-                die('Expecting a version number in the format x.y' . PHP_EOL);
-            }
-
-            $project_analyzer->setPhpVersion($options['php-version']);
-        }
+        CliUtils::initPhpVersion($options, $config, $project_analyzer);
 
         if (isset($options['codeowner'])) {
             $codeowner_files = self::loadCodeowners($providers);

diff --git a/src/Psalm/Internal/CliUtils.php b/src/Psalm/Internal/CliUtils.php
@@ -5,6 +5,7 @@
 use Composer\Autoload\ClassLoader;
 use Phar;
 use Psalm\Config;
+use Psalm\Internal\Analyzer\ProjectAnalyzer;
 use Psalm\Internal\Composer;
 
 use function assert;
@@ -622,4 +623,25 @@ public static function convertMemoryLimitToBytes(string $limit): int
 
         return (int)$limit;
     }
+
+    public static function initPhpVersion(array $options, Config $config, ProjectAnalyzer $project_analyzer): void
+    {
+        $source = null;
+
+        if (isset($options['php-version'])) {
+            if (!is_string($options['php-version'])) {
+                die('Expecting a version number in the format x.y' . PHP_EOL);
+            }
+            $version = $options['php-version'];
+            $source = 'cli';
+        } elseif ($version = $config->getPhpVersionFromConfig()) {
+            $source = 'config';
+        } elseif ($version = $config->getPHPVersionFromComposerJson()) {
+            $source = 'composer';
+        }
+
+        if ($version !== null && $source !== null) {
+            $project_analyzer->setPhpVersion($version, $source);
+        }
+    }
 }
diff --git a/tests/Config/ConfigTest.php b/tests/Config/ConfigTest.php
@@ -67,7 +67,7 @@ private function getProjectAnalyzerWithConfig(Config $config): \Psalm\Internal\A
             )
         );
 
-        $p->setPhpVersion('7.3');
+        $p->setPhpVersion('7.3', 'tests');
 
         return $p;
     }

diff --git a/tests/DocumentationTest.php b/tests/DocumentationTest.php
@@ -136,7 +136,7 @@ public function setUp() : void
             )
         );
 
-        $this->project_analyzer->setPhpVersion('8.0');
+        $this->project_analyzer->setPhpVersion('8.0', 'tests');
     }
 
     public function testAllIssuesCoveredInConfigSchema(): void
@@ -204,7 +204,7 @@ public function testInvalidCode($code, $error_message, $error_levels = [], $chec
             $this->markTestSkipped();
         }
 
-        $this->project_analyzer->setPhpVersion($php_version);
+        $this->project_analyzer->setPhpVersion($php_version, 'tests');
 
         if ($check_references) {
             $this->project_analyzer->getCodebase()->reportUnusedCode();

diff --git a/tests/EndToEnd/PsalmEndToEndTest.php b/tests/EndToEnd/PsalmEndToEndTest.php
@@ -115,13 +115,37 @@ public function testPsalm(): void
     {
         $this->runPsalmInit(1);
         $result = $this->runPsalm([], self::$tmpDir, true);
+        $this->assertStringContainsString(
+            'Target PHP version: 7.1 (inferred from composer.json)',
+            $result['STDERR']
+        );
         $this->assertStringContainsString('UnusedParam', $result['STDOUT']);
         $this->assertStringContainsString('InvalidReturnType', $result['STDOUT']);
         $this->assertStringContainsString('InvalidReturnStatement', $result['STDOUT']);
         $this->assertStringContainsString('3 errors', $result['STDOUT']);
         $this->assertSame(2, $result['CODE']);
     }
 
+    public function testPsalmWithPHPVersionOverride(): void
+    {
+        $this->runPsalmInit(1);
+        $result = $this->runPsalm(['--php-version=8.0'], self::$tmpDir, true);
+        $this->assertStringContainsString(
+            'Target PHP version: 8.0 (set by CLI argument)',
+            $result['STDERR']
+        );
+    }
+
+    public function testPsalmWithPHPVersionFromConfig(): void
+    {
+        $this->runPsalmInit(1, '7.4');
+        $result = $this->runPsalm([], self::$tmpDir, true);
+        $this->assertStringContainsString(
+            'Target PHP version: 7.4 (set by config file)',
+            $result['STDERR']
+        );
+    }
+
     public function testPsalmDiff(): void
     {
         if (PHP_VERSION_ID < 70400) {
@@ -212,7 +236,7 @@ public function testLegacyConfigWithoutresolveFromConfigFile(): void
     /**
      * @return array{STDOUT: string, STDERR: string, CODE: int|null}
      */
-    private function runPsalmInit(?int $level = null): array
+    private function runPsalmInit(?int $level = null, ?string $php_version = null): array
     {
         $args = ['--init'];
 
@@ -226,7 +250,9 @@ private function runPsalmInit(?int $level = null): array
         $psalm_config_contents = file_get_contents(self::$tmpDir . '/psalm.xml');
         $psalm_config_contents = \str_replace(
             'errorLevel="1"',
-            'errorLevel="1" cacheDirectory="' . self::$tmpDir . '/cache"',
+            'errorLevel="1" '
+            . 'cacheDirectory="' . self::$tmpDir . '/cache" '
+            . ($php_version ? ('phpVersion="' . $php_version . '"') : ''),
             $psalm_config_contents
         );
         file_put_contents(self::$tmpDir . '/psalm.xml', $psalm_config_contents);

diff --git a/tests/FileManipulation/FileManipulationTestCase.php b/tests/FileManipulation/FileManipulationTestCase.php
@@ -68,7 +68,7 @@ public function testValidCode(
             $input_code
         );
 
-        $this->project_analyzer->setPhpVersion($php_version);
+        $this->project_analyzer->setPhpVersion($php_version, 'tests');
 
         $keyed_issues_to_fix = [];
 

diff --git a/tests/FileReferenceTest.php b/tests/FileReferenceTest.php
@@ -29,7 +29,7 @@ public function setUp() : void
         );
 
         $this->project_analyzer->getCodebase()->collectLocations();
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
     }
 
     /**

diff --git a/tests/FileUpdates/AnalyzedMethodTest.php b/tests/FileUpdates/AnalyzedMethodTest.php
@@ -36,7 +36,7 @@ public function setUp() : void
             $config,
             $providers
         );
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
     }
 
     /**

diff --git a/tests/FileUpdates/CachedStorageTest.php b/tests/FileUpdates/CachedStorageTest.php
@@ -36,7 +36,7 @@ public function setUp() : void
             $config,
             $providers
         );
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
     }
 
     public function testValidInclude(): void

diff --git a/tests/FileUpdates/ErrorAfterUpdateTest.php b/tests/FileUpdates/ErrorAfterUpdateTest.php
@@ -37,7 +37,7 @@ public function setUp() : void
             $config,
             $providers
         );
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
     }
 
     /**

diff --git a/tests/FileUpdates/ErrorFixTest.php b/tests/FileUpdates/ErrorFixTest.php
@@ -37,7 +37,7 @@ public function setUp() : void
             $config,
             $providers
         );
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
     }
 
     /**

diff --git a/tests/FileUpdates/TemporaryUpdateTest.php b/tests/FileUpdates/TemporaryUpdateTest.php
@@ -39,7 +39,7 @@ public function setUp() : void
             $config,
             $providers
         );
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
     }
 
     /**

diff --git a/tests/ForbiddenCodeTest.php b/tests/ForbiddenCodeTest.php
@@ -361,7 +361,7 @@ private function getProjectAnalyzerWithConfig(Config $config): \Psalm\Internal\A
             )
         );
 
-        $p->setPhpVersion('7.4');
+        $p->setPhpVersion('7.4', 'tests');
 
         return $p;
     }

diff --git a/tests/LanguageServer/CompletionTest.php b/tests/LanguageServer/CompletionTest.php
@@ -35,7 +35,7 @@ public function setUp() : void
             $config,
             $providers
         );
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
         $this->project_analyzer->getCodebase()->store_node_types = true;
     }
 

diff --git a/tests/LanguageServer/FileMapTest.php b/tests/LanguageServer/FileMapTest.php
@@ -31,7 +31,7 @@ public function setUp() : void
             $config,
             $providers
         );
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
         $this->project_analyzer->getCodebase()->store_node_types = true;
     }
 

diff --git a/tests/LanguageServer/SymbolLookupTest.php b/tests/LanguageServer/SymbolLookupTest.php
@@ -34,7 +34,7 @@ public function setUp() : void
             $providers
         );
 
-        $this->project_analyzer->setPhpVersion('7.3');
+        $this->project_analyzer->setPhpVersion('7.3', 'tests');
         $this->project_analyzer->getCodebase()->store_node_types = true;
     }