1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 00:39:38 +01:00
psalm/tests/Config/ConfigTest.php

2010 lines
69 KiB
PHP
Raw Normal View History

2016-12-29 16:24:10 +01:00
<?php
2019-05-10 00:58:30 +02:00
namespace Psalm\Tests\Config;
2016-12-29 16:24:10 +01:00
2021-12-03 20:11:20 +01:00
use Composer\Autoload\ClassLoader;
2021-12-03 21:40:18 +01:00
use ErrorException;
use Psalm\CodeLocation\Raw;
2021-06-08 04:55:21 +02:00
use Psalm\Config;
2021-12-03 20:11:20 +01:00
use Psalm\Config\IssueHandler;
2021-06-08 04:55:21 +02:00
use Psalm\Context;
2021-12-03 20:29:06 +01:00
use Psalm\Exception\CodeException;
use Psalm\Exception\ConfigException;
use Psalm\Internal\Analyzer\FileAnalyzer;
2021-12-03 20:11:20 +01:00
use Psalm\Internal\Analyzer\ProjectAnalyzer;
use Psalm\Internal\ErrorHandler;
use Psalm\Internal\Provider\FakeFileProvider;
2021-12-03 20:11:20 +01:00
use Psalm\Internal\Provider\Providers;
2021-06-08 04:55:21 +02:00
use Psalm\Internal\RuntimeCaches;
use Psalm\Internal\Scanner\FileScanner;
2023-12-12 07:51:21 +01:00
use Psalm\Internal\VersionUtils;
use Psalm\Issue\TooManyArguments;
use Psalm\Issue\UndefinedFunction;
use Psalm\Tests\Config\Plugin\FileTypeSelfRegisteringPlugin;
2021-12-04 21:55:53 +01:00
use Psalm\Tests\Internal\Provider\FakeParserCacheProvider;
2021-12-03 20:11:20 +01:00
use Psalm\Tests\TestCase;
2021-06-08 04:55:21 +02:00
use Psalm\Tests\TestConfig;
2019-07-05 22:24:00 +02:00
use function array_map;
use function define;
use function defined;
use function dirname;
use function error_get_last;
2021-06-08 04:55:21 +02:00
use function get_class;
2019-07-05 22:24:00 +02:00
use function getcwd;
use function implode;
2021-11-28 00:18:13 +01:00
use function in_array;
2019-07-05 22:24:00 +02:00
use function is_array;
use function preg_match;
use function realpath;
use function set_error_handler;
2021-06-08 04:55:21 +02:00
use function sprintf;
use function symlink;
2021-06-08 04:55:21 +02:00
use function uniqid;
2019-07-05 22:24:00 +02:00
use function unlink;
2016-12-29 16:24:10 +01:00
2021-06-08 04:55:21 +02:00
use const DIRECTORY_SEPARATOR;
2021-12-03 20:11:20 +01:00
class ConfigTest extends TestCase
2016-12-29 16:24:10 +01:00
{
2022-12-16 19:58:47 +01:00
protected static TestConfig $config;
2022-12-16 19:58:47 +01:00
protected ProjectAnalyzer $project_analyzer;
/** @var callable(int, string, string=, int=, array=):bool|null */
protected $original_error_handler = null;
public static function setUpBeforeClass(): void
{
self::$config = new TestConfig();
if (!defined('PSALM_VERSION')) {
2023-12-12 07:51:21 +01:00
define('PSALM_VERSION', VersionUtils::getPsalmVersion());
}
if (!defined('PHP_PARSER_VERSION')) {
2023-12-12 07:51:21 +01:00
define('PHP_PARSER_VERSION', VersionUtils::getPhpParserVersion());
}
}
public function setUp(): void
2016-12-29 16:24:10 +01:00
{
Test parallelization (#4045) * Run tests in random order Being able to run tests in any order is a pre-requisite for being able to run them in parallel. * Reset type coverage between tests, fix affected tests * Reset parser and lexer between test runs and on php version change Previously lexer was reset, but parser kept the reference to the old one, and reference to the parser was kept by StatementsProvider. This resulted in order-dependent tests - if the parser was first initialized with phpVersion set to 7.4 then arrow functions worked fine, but were failing when the parser was initially constructed with settings for 7.3 This can be demonstrated on current master by upgrading to nikic/php-parser:4.9 and running: ``` vendor/bin/phpunit --no-coverage --filter="inferredArgArrowFunction" tests/ClosureTest.php ``` Now all tests using PHP 7.4 features must set the PHP version accordingly. * Marked more tests using 7.4 syntax * Reset newline-between-annotation flag between tests * Resolve real paths before passing them to checkPaths When checkPaths is called from psalm.php the paths are resolved, so we just mimicking SUT behaviour here. * Restore newline-between-annotations in DocCommentTest * Tweak Appveyor caches * Tweak TravisCI caches * Tweak CircleCI caches * Run tests in parallel Use `vendor/bin/paratest` instead of `vendor/bin/phpunit` * Use default paratest runner on Windows WrapperRunner is not supported on Windows. * TRAVIS_TAG could be empty * Restore appveyor conditional caching
2020-08-23 16:32:07 +02:00
RuntimeCaches::clearAll();
$this->file_provider = new FakeFileProvider();
$this->original_error_handler = set_error_handler(null);
set_error_handler($this->original_error_handler);
2016-12-29 16:24:10 +01:00
}
2021-12-03 20:11:20 +01:00
private function getProjectAnalyzerWithConfig(Config $config): ProjectAnalyzer
{
2021-12-03 20:11:20 +01:00
$p = new ProjectAnalyzer(
$config,
2021-12-03 20:11:20 +01:00
new Providers(
$this->file_provider,
2022-12-18 17:15:15 +01:00
new FakeParserCacheProvider(),
),
);
2019-02-07 21:27:43 +01:00
$p->setPhpVersion('7.3', 'tests');
2019-02-07 21:27:43 +01:00
return $p;
}
public function testBarebonesConfig(): void
2016-12-29 16:24:10 +01:00
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
(string)getcwd(),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
2016-12-29 16:24:10 +01:00
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
2016-12-29 16:24:10 +01:00
}
public function testIgnoreProjectDirectory(): void
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles>
2018-11-06 03:57:36 +01:00
<directory name="src/Psalm/Internal/Analyzer" />
</ignoreFiles>
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
2018-11-06 03:57:36 +01:00
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
}
2016-12-30 02:07:42 +01:00
public function testIgnoreMissingProjectDirectory(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles allowMissingFiles="true">
<directory name="does/not/exist" />
</ignoreFiles>
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
$this->assertFalse($config->isInProjectDirs(realpath(__DIR__ . '/../../') . '/does/not/exist/FileAnalyzer.php'));
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
}
public function testIgnoreSymlinkedProjectDirectory(): void
{
2019-05-10 00:58:30 +02:00
@unlink(dirname(__DIR__, 1) . '/fixtures/symlinktest/ignored/b');
2021-11-28 00:18:13 +01:00
$no_symlinking_error = [
'symlink(): Cannot create symlink, error code(1314)',
'symlink(): Permission denied',
];
$last_error = error_get_last();
$check_symlink_error =
2019-03-23 19:27:54 +01:00
!is_array($last_error) ||
!isset($last_error['message']) ||
2021-11-28 00:18:13 +01:00
!in_array($last_error['message'], $no_symlinking_error);
2019-05-10 00:58:30 +02:00
@symlink(dirname(__DIR__, 1) . '/fixtures/symlinktest/a', dirname(__DIR__, 1) . '/fixtures/symlinktest/ignored/b');
if ($check_symlink_error) {
$last_error = error_get_last();
2021-11-28 00:18:13 +01:00
if (is_array($last_error) && in_array($last_error['message'], $no_symlinking_error)) {
$this->markTestSkipped($last_error['message']);
}
}
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="tests" />
<ignoreFiles>
<directory name="tests/fixtures/symlinktest/ignored" resolveSymlinks="true" />
</ignoreFiles>
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('tests/AnnotationTest.php')));
$this->assertFalse($config->isInProjectDirs(realpath('tests/fixtures/symlinktest/a/ignoreme.php')));
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
$regex = '/^unlink\([^\)]+\): (?:Permission denied|No such file or directory)$/';
$last_error = error_get_last();
$check_unlink_error =
!is_array($last_error) ||
!preg_match($regex, $last_error['message']);
@unlink(__DIR__ . '/fixtures/symlinktest/ignored/b');
if ($check_unlink_error) {
$last_error = error_get_last();
if (is_array($last_error) && !preg_match($regex, $last_error['message'])) {
2021-12-03 21:40:18 +01:00
throw new ErrorException(
$last_error['message'],
0,
$last_error['type'],
$last_error['file'],
2022-12-18 17:15:15 +01:00
$last_error['line'],
);
}
}
}
public function testIgnoreWildcardProjectDirectory(): void
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles>
<directory name="src/*/Internal/Analyzer" />
</ignoreFiles>
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
2018-11-06 03:57:36 +01:00
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
}
public function testIgnoreRecursiveWildcardProjectDirectory(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles>
<directory name="src/**/BinaryOp*" />
</ignoreFiles>
</projectFiles>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOpAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/OrAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Node/Expr/BinaryOp/VirtualPlus.php')));
}
public function testIgnoreRecursiveDoubleWildcardProjectFiles(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles>
<file name="src/**/*Analyzer.php" />
</ignoreFiles>
</projectFiles>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
}
public function testIgnoreWildcardFiles(): void
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles>
2018-11-06 03:57:36 +01:00
<file name="src/Psalm/Internal/Analyzer/*Analyzer.php" />
</ignoreFiles>
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
2018-11-06 03:57:36 +01:00
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
}
public function testIgnoreWildcardFilesInWildcardFolder(): void
2018-07-22 04:34:22 +02:00
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
2018-07-22 04:34:22 +02:00
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
2018-07-22 04:34:22 +02:00
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="examples" />
<ignoreFiles>
2018-11-06 03:57:36 +01:00
<file name="src/Psalm/**/**/*Analyzer.php" />
<file name="src/Psalm/**/**/**/*Analyzer.php" />
2018-07-22 04:34:22 +02:00
</ignoreFiles>
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
2018-07-22 04:34:22 +02:00
);
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
2018-07-22 04:34:22 +02:00
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
2020-03-15 04:54:42 +01:00
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/PhpVisitor/ReflectorVisitor.php')));
2018-11-06 03:57:36 +01:00
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
$this->assertTrue($config->isInProjectDirs(realpath('examples/plugins/StringChecker.php')));
2018-07-22 04:34:22 +02:00
}
public function testIgnoreWildcardFilesInAllPossibleWildcardFolders(): void
2018-07-22 04:34:22 +02:00
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
2018-07-22 04:34:22 +02:00
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
2018-07-22 04:34:22 +02:00
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="examples" />
<ignoreFiles>
2018-11-06 03:57:36 +01:00
<file name="**/**/**/**/*Analyzer.php" />
<file name="**/**/**/**/**/*Analyzer.php" />
2018-07-22 04:34:22 +02:00
</ignoreFiles>
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
2018-07-22 04:34:22 +02:00
);
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
2018-07-22 04:34:22 +02:00
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
2020-03-15 04:54:42 +01:00
$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/PhpVisitor/ReflectorVisitor.php')));
2018-11-06 03:57:36 +01:00
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
2018-07-22 04:34:22 +02:00
}
public function testIssueHandler(): void
2016-12-30 02:07:42 +01:00
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<MissingReturnType errorLevel="suppress" />
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
2016-12-30 02:07:42 +01:00
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath(__FILE__)));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Type.php')));
2016-12-30 02:07:42 +01:00
}
public function testReportMixedIssues(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertNull($config->show_mixed_issues);
$this->assertTrue($config->reportIssueInFile('MixedArgument', realpath(__FILE__)));
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm reportMixedIssues="false">
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertFalse($config->show_mixed_issues);
$this->assertFalse($config->reportIssueInFile('MixedArgument', realpath(__FILE__)));
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm errorLevel="5">
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertNull($config->show_mixed_issues);
$this->assertFalse($config->reportIssueInFile('MixedArgument', realpath(__FILE__)));
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm errorLevel="5" reportMixedIssues="true">
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->show_mixed_issues);
$this->assertTrue($config->reportIssueInFile('MixedArgument', realpath(__FILE__)));
}
public function testGlobalUndefinedFunctionSuppression(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<UndefinedFunction>
<errorLevel type="suppress">
<referencedFunction name="zzz"/>
</errorLevel>
</UndefinedFunction>
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertSame(
Config::REPORT_SUPPRESS,
2022-12-18 17:15:15 +01:00
$config->getReportingLevelForFunction('UndefinedFunction', 'Some\Namespace\zzz'),
);
}
public function testMultipleIssueHandlers(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<MissingReturnType errorLevel="suppress" />
</issueHandlers>
<issueHandlers>
<UndefinedClass errorLevel="suppress" />
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath(__FILE__)));
$this->assertFalse($config->reportIssueInFile('UndefinedClass', realpath(__FILE__)));
}
public function testIssueHandlerWithCustomErrorLevels(): void
2016-12-30 02:07:42 +01:00
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<MissingReturnType errorLevel="info">
<errorLevel type="suppress">
<directory name="tests" />
</errorLevel>
<errorLevel type="error">
2018-11-06 03:57:36 +01:00
<directory name="src/Psalm/Internal/Analyzer" />
</errorLevel>
</MissingReturnType>
<UndefinedClass>
<errorLevel type="suppress">
<referencedClass name="Psalm\Badger" />
<referencedClass name="Psalm\*Actor" />
<referencedClass name="*MagicFactory" />
</errorLevel>
</UndefinedClass>
<UndefinedMethod>
<errorLevel type="suppress">
<referencedMethod name="Psalm\Bodger::find1" />
<referencedMethod name="*::find2" />
</errorLevel>
</UndefinedMethod>
<UndefinedFunction>
<errorLevel type="suppress">
<referencedFunction name="fooBar" />
</errorLevel>
2019-05-03 23:12:20 +02:00
<errorLevel type="info">
<directory name="examples" />
</errorLevel>
</UndefinedFunction>
2019-05-03 23:12:20 +02:00
<PossiblyInvalidArgument>
<errorLevel type="suppress">
<directory name="tests" />
</errorLevel>
<errorLevel type="info">
<directory name="examples" />
</errorLevel>
</PossiblyInvalidArgument>
<UndefinedPropertyFetch>
<errorLevel type="suppress">
<referencedProperty name="Psalm\Bodger::$find3" />
</errorLevel>
</UndefinedPropertyFetch>
<UndefinedGlobalVariable>
<errorLevel type="suppress">
<referencedVariable name="a" />
</errorLevel>
</UndefinedGlobalVariable>
<InvalidConstantAssignmentValue>
<errorLevel type="suppress">
<referencedConstant name="Psalm\Bodger::FOO" />
</errorLevel>
</InvalidConstantAssignmentValue>
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
2016-12-30 02:07:42 +01:00
2018-11-11 18:01:14 +01:00
$config = $this->project_analyzer->getConfig();
$this->assertSame(
'info',
$config->getReportingLevelForFile(
'MissingReturnType',
2022-12-18 17:15:15 +01:00
realpath('src/Psalm/Type.php'),
),
);
$this->assertSame(
'error',
$config->getReportingLevelForFile(
'MissingReturnType',
2022-12-18 17:15:15 +01:00
realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'),
),
);
2019-05-03 23:12:20 +02:00
$this->assertSame(
'error',
$config->getReportingLevelForFile(
2021-09-23 17:30:30 +02:00
'PossiblyInvalidArgument',
2022-12-18 17:15:15 +01:00
realpath('src/psalm.php'),
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'info',
$config->getReportingLevelForFile(
'PossiblyInvalidArgument',
2022-12-18 17:15:15 +01:00
realpath('examples/TemplateChecker.php'),
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\Badger',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\BadActor',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\GoodActor',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\MagicFactory',
),
2021-09-23 17:30:30 +02:00
);
$this->assertNull(
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::find1',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::find2',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Badger::find2',
),
2021-09-23 17:30:30 +02:00
);
$this->assertNull(
$config->getReportingLevelForProperty(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::$find3',
),
2021-09-23 17:30:30 +02:00
);
$this->assertNull(
$config->getReportingLevelForProperty(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::$find4',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedFunction',
2022-12-18 17:15:15 +01:00
'fooBar',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedFunction',
2022-12-18 17:15:15 +01:00
'foobar',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForVariable(
'UndefinedGlobalVariable',
2022-12-18 17:15:15 +01:00
'a',
),
2021-09-23 17:30:30 +02:00
);
$this->assertNull(
$config->getReportingLevelForVariable(
'UndefinedGlobalVariable',
2022-12-18 17:15:15 +01:00
'b',
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClassConstant(
'InvalidConstantAssignmentValue',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::FOO',
),
);
2021-09-23 17:30:30 +02:00
}
public function testIssueHandlerSetDynamically(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
2021-09-23 17:30:30 +02:00
);
$config = $this->project_analyzer->getConfig();
$config->setAdvancedErrorLevel('MissingReturnType', [
[
'type' => 'suppress',
2022-12-18 17:15:15 +01:00
'directory' => [['name' => 'tests']],
2021-09-23 17:30:30 +02:00
],
[
'type' => 'error',
2022-12-18 17:15:15 +01:00
'directory' => [['name' => 'src/Psalm/Internal/Analyzer']],
],
2021-09-23 17:30:30 +02:00
], 'info');
$config->setAdvancedErrorLevel('UndefinedClass', [
[
'type' => 'suppress',
'referencedClass' => [
['name' => 'Psalm\Badger'],
['name' => 'Psalm\*Actor'],
['name' => '*MagicFactory'],
2022-12-18 17:15:15 +01:00
],
],
2021-09-23 17:30:30 +02:00
]);
$config->setAdvancedErrorLevel('UndefinedMethod', [
[
'type' => 'suppress',
'referencedMethod' => [
['name' => 'Psalm\Bodger::find1'],
['name' => '*::find2'],
2022-12-18 17:15:15 +01:00
],
],
2021-09-23 17:30:30 +02:00
]);
$config->setAdvancedErrorLevel('UndefinedFunction', [
[
'type' => 'suppress',
'referencedFunction' => [
2022-12-18 17:15:15 +01:00
['name' => 'fooBar'],
],
],
2021-09-23 17:30:30 +02:00
]);
$config->setAdvancedErrorLevel('PossiblyInvalidArgument', [
[
'type' => 'suppress',
'directory' => [
['name' => 'tests'],
2022-12-18 17:15:15 +01:00
],
2021-09-23 17:30:30 +02:00
],
[
'type' => 'info',
'directory' => [
['name' => 'examples'],
2022-12-18 17:15:15 +01:00
],
],
2021-09-23 17:30:30 +02:00
]);
$config->setAdvancedErrorLevel('UndefinedPropertyFetch', [
[
'type' => 'suppress',
'referencedProperty' => [
2022-12-18 17:15:15 +01:00
['name' => 'Psalm\Bodger::$find3'],
],
],
2021-09-23 17:30:30 +02:00
]);
$config->setAdvancedErrorLevel('UndefinedGlobalVariable', [
[
'type' => 'suppress',
'referencedVariable' => [
2022-12-18 17:15:15 +01:00
['name' => 'a'],
],
],
2021-09-23 17:30:30 +02:00
]);
$this->assertSame(
'info',
$config->getReportingLevelForFile(
'MissingReturnType',
2022-12-18 17:15:15 +01:00
realpath('src/Psalm/Type.php'),
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'error',
$config->getReportingLevelForFile(
'MissingReturnType',
2022-12-18 17:15:15 +01:00
realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'),
),
2021-09-23 17:30:30 +02:00
);
$this->assertSame(
'error',
$config->getReportingLevelForFile(
2019-05-03 23:12:20 +02:00
'PossiblyInvalidArgument',
2022-12-18 17:15:15 +01:00
realpath('src/psalm.php'),
),
2019-05-03 23:12:20 +02:00
);
$this->assertSame(
'info',
$config->getReportingLevelForFile(
'PossiblyInvalidArgument',
2022-12-18 17:15:15 +01:00
realpath('examples/TemplateChecker.php'),
),
2019-05-03 23:12:20 +02:00
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\Badger',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\BadActor',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\GoodActor',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\MagicFactory',
),
);
2019-07-05 22:24:00 +02:00
$this->assertNull(
$config->getReportingLevelForClass(
'UndefinedClass',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::find1',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::find2',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Badger::find2',
),
);
2019-07-05 22:24:00 +02:00
$this->assertNull(
$config->getReportingLevelForProperty(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::$find3',
),
);
2019-07-05 22:24:00 +02:00
$this->assertNull(
$config->getReportingLevelForProperty(
'UndefinedMethod',
2022-12-18 17:15:15 +01:00
'Psalm\Bodger::$find4',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedFunction',
2022-12-18 17:15:15 +01:00
'fooBar',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForMethod(
'UndefinedFunction',
2022-12-18 17:15:15 +01:00
'foobar',
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForVariable(
'UndefinedGlobalVariable',
2022-12-18 17:15:15 +01:00
'a',
),
);
$this->assertNull(
$config->getReportingLevelForVariable(
'UndefinedGlobalVariable',
2022-12-18 17:15:15 +01:00
'b',
),
);
2016-12-30 02:07:42 +01:00
}
public function testIssueHandlerOverride(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<MissingReturnType errorLevel="error">
<errorLevel type="info">
<directory name="tests" />
</errorLevel>
<errorLevel type="info">
<directory name="src/Psalm/Internal/Analyzer" />
</errorLevel>
</MissingReturnType>
<UndefinedClass errorLevel="error"></UndefinedClass>
</issueHandlers>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$config->setAdvancedErrorLevel('MissingReturnType', [
[
'type' => 'error',
'directory' => [['name' => 'src/Psalm/Internal/Analyzer']],
],
], 'info');
$config->setCustomErrorLevel('UndefinedClass', 'suppress');
$this->assertSame(
'info',
$config->getReportingLevelForFile(
'MissingReturnType',
realpath('src/Psalm/Type.php'),
),
);
$this->assertSame(
'error',
$config->getReportingLevelForFile(
'MissingReturnType',
realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'),
),
);
$this->assertSame(
'suppress',
$config->getReportingLevelForFile(
'UndefinedClass',
realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'),
),
);
}
public function testIssueHandlerSafeOverride(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<MissingReturnType errorLevel="error">
<errorLevel type="info">
<directory name="tests" />
</errorLevel>
<errorLevel type="info">
<directory name="src/Psalm/Internal/Analyzer" />
</errorLevel>
</MissingReturnType>
<UndefinedClass errorLevel="info"></UndefinedClass>
</issueHandlers>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$config->safeSetAdvancedErrorLevel('MissingReturnType', [
[
'type' => 'error',
'directory' => [['name' => 'src/Psalm/Internal/Analyzer']],
],
], 'info');
$config->safeSetCustomErrorLevel('UndefinedClass', 'suppress');
$this->assertSame(
'error',
$config->getReportingLevelForFile(
'MissingReturnType',
realpath('src/Psalm/Type.php'),
),
);
$this->assertSame(
'info',
$config->getReportingLevelForFile(
'MissingReturnType',
realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'),
),
);
$this->assertSame(
'info',
$config->getReportingLevelForFile(
'UndefinedClass',
realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'),
),
);
}
public function testAllPossibleIssues(): void
{
$all_possible_handlers = implode(
' ',
array_map(
2017-01-13 20:14:24 +01:00
/**
* @param string $issue_name
* @return string
*/
2023-10-21 20:45:09 +02:00
static fn($issue_name): string => '<' . $issue_name . ' errorLevel="suppress" />' . "\n",
2022-12-18 17:15:15 +01:00
IssueHandler::getAllIssueTypes(),
),
);
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
<issueHandlers>
' . $all_possible_handlers . '
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
}
public function testImpossibleIssue(): void
{
2019-05-17 00:36:36 +02:00
$this->expectExceptionMessage('This element is not expected');
$this->expectException(ConfigException::class);
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
<issueHandlers>
<ImpossibleIssue errorLevel="suppress" />
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
}
public function testThing(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
<mockClasses>
<class name="MyMockClass" />
</mockClasses>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$file_path = getcwd() . '/src/somefile.php';
$this->addFile(
$file_path,
'<?php
class MyMockClass {}
$a = new MyMockClass();
$a->foo($b = 5);
2022-12-18 17:15:15 +01:00
echo $b;',
);
$this->analyzeFile($file_path, new Context());
}
public function testValidThrowInvalidCatch(): void
{
2019-05-17 00:36:36 +02:00
$this->expectExceptionMessage('InvalidCatch');
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<issueHandlers>
<InvalidThrow>
<errorLevel type="suppress">
<referencedClass name="I" />
</errorLevel>
</InvalidThrow>
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$file_path = getcwd() . '/src/somefile.php';
$this->addFile(
$file_path,
'<?php
interface I {}
class E extends Exception implements I {}
function foo() : void {
throw new E();
}
function handleThrow(I $e) : void {
echo "about to throw";
throw $e;
}
try {
foo();
} catch (I $e) {
handleThrow($e);
2022-12-18 17:15:15 +01:00
}',
);
$this->analyzeFile($file_path, new Context());
}
public function testInvalidThrowValidCatch(): void
{
2019-05-17 00:36:36 +02:00
$this->expectExceptionMessage('InvalidThrow');
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<issueHandlers>
<InvalidCatch>
<errorLevel type="suppress">
<referencedClass name="I" />
</errorLevel>
</InvalidCatch>
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$file_path = getcwd() . '/src/somefile.php';
$this->addFile(
$file_path,
'<?php
interface I {}
class E extends Exception implements I {}
function foo() : void {
throw new E();
}
function handleThrow(I $e) : void {
echo "about to throw";
throw $e;
}
try {
foo();
} catch (I $e) {
handleThrow($e);
2022-12-18 17:15:15 +01:00
}',
);
$this->analyzeFile($file_path, new Context());
}
public function testValidThrowValidCatch(): void
{
2018-11-11 18:01:14 +01:00
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<issueHandlers>
<InvalidCatch>
<errorLevel type="suppress">
<referencedClass name="I" />
</errorLevel>
</InvalidCatch>
<InvalidThrow>
<errorLevel type="suppress">
<referencedClass name="I" />
</errorLevel>
</InvalidThrow>
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$file_path = getcwd() . '/src/somefile.php';
$this->addFile(
$file_path,
'<?php
interface I {}
class E extends Exception implements I {}
function foo() : void {
throw new E();
}
function handleThrow(I $e) : void {
echo "about to throw";
throw $e;
}
try {
foo();
} catch (I $e) {
handleThrow($e);
2022-12-18 17:15:15 +01:00
}',
);
$this->analyzeFile($file_path, new Context());
}
public function testModularConfig(): void
{
$root = __DIR__ . '/../fixtures/ModularConfig';
$config = Config::loadFromXMLFile($root . '/psalm.xml', $root);
$this->assertEquals(
[
realpath($root . '/Bar.php'),
2022-12-18 17:15:15 +01:00
realpath($root . '/Bat.php'),
],
2022-12-18 17:15:15 +01:00
$config->getProjectFiles(),
);
}
public function tearDown(): void
{
set_error_handler($this->original_error_handler);
parent::tearDown();
if ($this->getName() === 'testTemplatedFiles') {
$project_root = dirname(__DIR__, 2);
foreach (['1.xml', '2.xml', '3.xml', '4.xml', '5.xml', '6.xml', '7.xml', '8.xml'] as $file_name) {
@unlink($project_root . DIRECTORY_SEPARATOR . $file_name);
}
}
}
public function testGlobals(): void
2019-03-06 00:08:41 +01:00
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
2019-03-06 00:08:41 +01:00
'<?xml version="1.0"?>
<psalm>
<globals>
<var name="glob1" type="string" />
<var name="glob2" type="array{str:string}" />
2019-03-06 00:08:41 +01:00
<var name="glob3" type="ns\Clazz" />
<var name="glob4" type="string|null" />
<var name="_GET" type="array{str:string}" />
2019-03-06 00:08:41 +01:00
</globals>
2022-12-18 17:15:15 +01:00
</psalm>',
),
2019-03-06 00:08:41 +01:00
);
$file_path = getcwd() . '/src/somefile.php';
$this->addFile(
$file_path,
'<?php
namespace {
ord($glob1);
ord($glob2["str"]);
$glob3->func();
2019-03-06 00:14:07 +01:00
ord($_GET["str"]);
2019-03-06 00:08:41 +01:00
assert($glob4 !== null);
ord($glob4);
function example1(): void {
global $glob1, $glob2, $glob3, $glob4;
ord($glob1);
ord($glob2["str"]);
$glob3->func();
ord($glob4);
2019-03-06 00:14:07 +01:00
ord($_GET["str"]);
2019-03-06 00:08:41 +01:00
}
$z = $glob1;
$z = 0;
error_reporting($z);
2019-03-06 00:08:41 +01:00
$old = $_GET["str"];
2019-03-06 00:14:07 +01:00
$_GET["str"] = 0;
error_reporting($_GET["str"]);
$_GET["str"] = $old;
2019-03-06 00:14:07 +01:00
2019-03-06 00:08:41 +01:00
function example2(): void {
global $z, $glob2, $glob3;
error_reporting($z);
2019-03-06 00:08:41 +01:00
ord($glob2["str"]);
$glob3->func();
2019-03-06 00:14:07 +01:00
ord($_GET["str"]);
2019-03-06 00:08:41 +01:00
}
}
namespace ns {
ord($glob1);
ord($glob2["str"]);
$glob3->func();
2019-03-06 00:14:07 +01:00
ord($_GET["str"]);
2019-03-06 00:08:41 +01:00
class Clazz {
public function func(): void {}
}
function example3(): void {
global $glob1, $glob2, $glob3;
ord($glob1);
ord($glob2["str"]);
$glob3->func();
2019-03-06 00:14:07 +01:00
ord($_GET["str"]);
2019-03-06 00:08:41 +01:00
}
}
namespace ns2 {
/** @psalm-suppress InvalidGlobal */
global $glob1, $glob2, $glob3;
ord($glob1);
ord($glob2["str"]);
$glob3->func();
2019-03-11 14:54:41 +01:00
}
namespace {
2019-08-20 04:45:24 +02:00
ord($glob1 ?: "str");
2019-03-11 14:54:41 +01:00
ord($_GET["str"] ?? "str");
2019-03-14 01:15:29 +01:00
function example4(): void {
global $glob1;
2019-08-20 04:45:24 +02:00
ord($glob1 ?: "str");
2019-03-14 01:15:29 +01:00
ord($_GET["str"] ?? "str");
}
2022-12-18 17:15:15 +01:00
}',
2019-03-06 00:08:41 +01:00
);
$this->analyzeFile($file_path, new Context());
}
public function testIgnoreExceptions(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm checkForThrowsDocblock="true" checkForThrowsInGlobalScope="true">
<ignoreExceptions>
<class name="Exc1" />
<class name="Exc2" onlyGlobalScope="true" />
<classAndDescendants name="Exc3" />
<classAndDescendants name="Exc4" onlyGlobalScope="true" />
<classAndDescendants name="Exc5" />
</ignoreExceptions>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$file_path = getcwd() . '/src/somefile.php';
$this->addFile(
$file_path,
'<?php
class Exc1 extends Exception {}
/** @throws Exc1 */
function throwsExc1(): void {}
class Exc2 extends Exception {}
/** @throws Exc2 */
function throwsExc2(): void {}
class Exc3 extends Exception {}
/** @throws Exc3 */
function throwsExc3(): void {}
class Exc4 extends Exception {}
/** @throws Exc4 */
function throwsExc4(): void {}
interface Exc5 {}
interface Exc6 extends Exc5 {}
/**
* @psalm-suppress InvalidThrow
* @throws Exc6
*/
function throwsExc6() : void {}
throwsExc1();
throwsExc2();
throwsExc3();
throwsExc4();
throwsExc6();
function example() : void {
throwsExc6();
throwsExc1();
throwsExc3();
throwsExc6();
2022-12-18 17:15:15 +01:00
}',
);
$this->analyzeFile($file_path, new Context());
}
public function testNotIgnoredException(): void
{
2021-12-03 20:29:06 +01:00
$this->expectException(CodeException::class);
2019-05-17 00:36:36 +02:00
$this->expectExceptionMessage('MissingThrowsDocblock');
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
2019-05-10 00:58:30 +02:00
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm checkForThrowsDocblock="true" checkForThrowsInGlobalScope="true">
<ignoreExceptions>
<class name="Exc1" />
<class name="Exc2" onlyGlobalScope="true" />
<classAndDescendants name="Exc3" />
<classAndDescendants name="Exc4" onlyGlobalScope="true" />
</ignoreExceptions>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$file_path = getcwd() . '/src/somefile.php';
$this->addFile(
$file_path,
'<?php
class Exc2 extends Exception {}
function example() : void {
throw new Exc2();
2022-12-18 17:15:15 +01:00
}',
);
$this->analyzeFile($file_path, new Context());
}
2019-06-05 06:00:42 +02:00
public function testGetPossiblePsr4Path(): void
2019-06-05 06:00:42 +02:00
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
2019-06-05 06:00:42 +02:00
);
$config = $this->project_analyzer->getConfig();
2021-12-03 20:11:20 +01:00
$classloader = new ClassLoader();
2019-06-05 06:00:42 +02:00
$classloader->addPsr4(
'Psalm\\',
[
dirname(__DIR__, 2)
. DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'composer' . DIRECTORY_SEPARATOR
. '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR
2019-07-05 22:24:00 +02:00
. 'src' . DIRECTORY_SEPARATOR . 'Psalm',
2022-12-18 17:15:15 +01:00
],
2019-06-05 06:00:42 +02:00
);
$classloader->addPsr4(
'Psalm\\Tests\\',
[
dirname(__DIR__, 2)
. DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'composer' . DIRECTORY_SEPARATOR
. '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR
2019-07-05 22:24:00 +02:00
. 'tests',
2022-12-18 17:15:15 +01:00
],
2019-06-05 06:00:42 +02:00
);
$config->setComposerClassLoader($classloader);
$this->assertSame(
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'Psalm' . DIRECTORY_SEPARATOR . 'Foo.php',
2022-12-18 17:15:15 +01:00
$config->getPotentialComposerFilePathForClassLike('Psalm\\Foo'),
2019-06-05 06:00:42 +02:00
);
$this->assertSame(
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'Foo.php',
2022-12-18 17:15:15 +01:00
$config->getPotentialComposerFilePathForClassLike('Psalm\\Tests\\Foo'),
2019-06-05 06:00:42 +02:00
);
}
public function testTakesPhpVersionFromConfigFile(): void
{
$cfg = Config::loadFromXML(
dirname(__DIR__, 2),
2022-12-18 17:15:15 +01:00
'<?xml version="1.0"?><psalm phpVersion="7.1"></psalm>',
);
$this->assertSame('7.1', $cfg->getPhpVersion());
}
public function testReadsComposerJsonForPhpVersion(): void
{
$root = __DIR__ . '/../fixtures/ComposerPhpVersion';
$cfg = Config::loadFromXML($root, "<?xml version=\"1.0\"?><psalm></psalm>");
$this->assertSame('7.2', $cfg->getPhpVersion());
$cfg = Config::loadFromXML($root, "<?xml version=\"1.0\"?><psalm phpVersion='8.0'></psalm>");
$this->assertSame('8.0', $cfg->getPhpVersion());
}
2020-07-17 16:09:42 +02:00
public function testSetsUsePhpStormMetaPath(): void
2020-07-17 16:09:42 +02:00
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm usePhpStormMetaPath="false">
2022-12-18 17:15:15 +01:00
</psalm>',
),
2020-07-17 16:09:42 +02:00
);
$this->assertFalse($this->project_analyzer->getConfig()->use_phpstorm_meta_path);
}
public function testSetsUniversalObjectCrates(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
TestConfig::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<universalObjectCrates>
<class name="DateTime" />
</universalObjectCrates>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$this->assertContains('datetime', $this->project_analyzer->getConfig()->getUniversalObjectCrates());
}
public function testInferPropertyTypesFromConstructorIsRead(): void
{
$cfg = Config::loadFromXML(
dirname(__DIR__, 2),
2022-12-18 17:15:15 +01:00
'<?xml version="1.0"?><psalm inferPropertyTypesFromConstructor="false"></psalm>',
);
$this->assertFalse($cfg->infer_property_types_from_constructor);
}
/**
* @return array<string, array{0: int, 1: int|null}>
*/
public function pluginRegistersScannerAndAnalyzerDataProvider(): array
{
return [
'regular' => [0, null], // flags, expected exception code
'invalid scanner class' => [FileTypeSelfRegisteringPlugin::FLAG_SCANNER_INVALID, 1_622_727_271],
'invalid analyzer class' => [FileTypeSelfRegisteringPlugin::FLAG_ANALYZER_INVALID, 1_622_727_281],
'override scanner' => [FileTypeSelfRegisteringPlugin::FLAG_SCANNER_TWICE, 1_622_727_272],
'override analyzer' => [FileTypeSelfRegisteringPlugin::FLAG_ANALYZER_TWICE, 1_622_727_282],
];
}
/**
* @test
* @dataProvider pluginRegistersScannerAndAnalyzerDataProvider
*/
public function pluginRegistersScannerAndAnalyzer(int $flags, ?int $expectedExceptionCode): void
{
$extension = uniqid('test');
$names = [
'scanner' => uniqid('PsalmTestFileTypeScanner'),
'analyzer' => uniqid('PsalmTestFileTypeAnalyzer'),
'extension' => $extension,
];
$scannerMock = $this->getMockBuilder(FileScanner::class)
->setMockClassName($names['scanner'])
->disableOriginalConstructor()
->getMock();
$analyzerMock = $this->getMockBuilder(FileAnalyzer::class)
->setMockClassName($names['analyzer'])
->disableOriginalConstructor()
->getMock();
FileTypeSelfRegisteringPlugin::$names = $names;
FileTypeSelfRegisteringPlugin::$flags = $flags;
$xml = sprintf(
'<?xml version="1.0"?>
<psalm><plugins><pluginClass class="%s"/></plugins></psalm>',
2022-12-18 17:15:15 +01:00
FileTypeSelfRegisteringPlugin::class,
);
try {
$projectAnalyzer = $this->getProjectAnalyzerWithConfig(
2022-12-18 17:15:15 +01:00
TestConfig::loadFromXML(dirname(__DIR__, 2), $xml),
);
$config = $projectAnalyzer->getConfig();
$config->initializePlugins($projectAnalyzer);
} catch (ConfigException $exception) {
$actualExceptionCode = $exception->getPrevious()
? $exception->getPrevious()->getCode()
: null;
self::assertSame(
$expectedExceptionCode,
$actualExceptionCode,
2022-12-18 17:15:15 +01:00
'Exception code did not match.',
);
return;
}
self::assertContains($extension, $config->getFileExtensions());
self::assertSame(get_class($scannerMock), $config->getFiletypeScanners()[$extension] ?? null);
self::assertSame(get_class($analyzerMock), $config->getFiletypeAnalyzers()[$extension] ?? null);
self::assertNull($expectedExceptionCode, 'Expected exception code was not thrown');
}
public function testTypeStatsForFileReporting(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
(string) getcwd(),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory ignoreTypeStats="true" name="src/Psalm/Config" />
<directory ignoreTypeStats="1" name="src/Psalm/Internal" />
<directory ignoreTypeStats="true1" name="src/Psalm/Issue" />
<directory ignoreTypeStats="false" name="src/Psalm/Node" />
<directory ignoreTypeStats="invalid" name="src/Psalm/Plugin" />
<directory ignoreTypeStats="0" name="src/Psalm/Progress" />
<directory ignoreTypeStats="" name="src/Psalm/Report" />
<directory name="src/Psalm/SourceControl" />
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertFalse($config->reportTypeStatsForFile(realpath('src/Psalm/Config') . DIRECTORY_SEPARATOR));
$this->assertTrue($config->reportTypeStatsForFile(realpath('src/Psalm/Internal') . DIRECTORY_SEPARATOR));
$this->assertTrue($config->reportTypeStatsForFile(realpath('src/Psalm/Issue') . DIRECTORY_SEPARATOR));
$this->assertTrue($config->reportTypeStatsForFile(realpath('src/Psalm/Node') . DIRECTORY_SEPARATOR));
$this->assertTrue($config->reportTypeStatsForFile(realpath('src/Psalm/Plugin') . DIRECTORY_SEPARATOR));
$this->assertTrue($config->reportTypeStatsForFile(realpath('src/Psalm/Progress') . DIRECTORY_SEPARATOR));
$this->assertTrue($config->reportTypeStatsForFile(realpath('src/Psalm/Report') . DIRECTORY_SEPARATOR));
$this->assertTrue($config->reportTypeStatsForFile(realpath('src/Psalm/SourceControl') . DIRECTORY_SEPARATOR));
}
public function testStrictTypesForFileReporting(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
(string) getcwd(),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory useStrictTypes="true" name="src/Psalm/Config" />
<directory useStrictTypes="1" name="src/Psalm/Internal" />
<directory useStrictTypes="true1" name="src/Psalm/Issue" />
<directory useStrictTypes="false" name="src/Psalm/Node" />
<directory useStrictTypes="invalid" name="src/Psalm/Plugin" />
<directory useStrictTypes="0" name="src/Psalm/Progress" />
<directory useStrictTypes="" name="src/Psalm/Report" />
<directory name="src/Psalm/SourceControl" />
</projectFiles>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->useStrictTypesForFile(realpath('src/Psalm/Config') . DIRECTORY_SEPARATOR));
$this->assertFalse($config->useStrictTypesForFile(realpath('src/Psalm/Internal') . DIRECTORY_SEPARATOR));
$this->assertFalse($config->useStrictTypesForFile(realpath('src/Psalm/Issue') . DIRECTORY_SEPARATOR));
$this->assertFalse($config->useStrictTypesForFile(realpath('src/Psalm/Node') . DIRECTORY_SEPARATOR));
$this->assertFalse($config->useStrictTypesForFile(realpath('src/Psalm/Plugin') . DIRECTORY_SEPARATOR));
$this->assertFalse($config->useStrictTypesForFile(realpath('src/Psalm/Progress') . DIRECTORY_SEPARATOR));
$this->assertFalse($config->useStrictTypesForFile(realpath('src/Psalm/Report') . DIRECTORY_SEPARATOR));
$this->assertFalse($config->useStrictTypesForFile(realpath('src/Psalm/SourceControl') . DIRECTORY_SEPARATOR));
}
public function testConfigFileWithXIncludeWithoutFallbackShouldThrowException(): void
{
2022-01-28 16:26:58 +01:00
$this->expectException(ConfigException::class);
$this->expectExceptionMessageMatches('/and no fallback was found/');
ErrorHandler::install();
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm xmlns:xi="http://www.w3.org/2001/XInclude">
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<xi:include href="zz.xml" />
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
);
}
public function testConfigFileWithXIncludeWithFallback(): void
{
ErrorHandler::install();
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm xmlns:xi="http://www.w3.org/2001/XInclude">
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<xi:include href="zz.xml">
<xi:fallback>
<MixedAssignment>
<errorLevel type="suppress">
<file name="src/Psalm/Type.php" />
</errorLevel>
</MixedAssignment>
</xi:fallback>
</xi:include>
</issueHandlers>
2022-12-18 17:15:15 +01:00
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertFalse($config->reportIssueInFile('MixedAssignment', realpath('src/Psalm/Type.php')));
}
public function testConfigFileWithWildcardPathIssueHandler(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<MissingReturnType>
<errorLevel type="suppress">
<file name="src/**/*TypeAlias.php" />
<directory name="src/**/BinaryOp*" />
</errorLevel>
</MissingReturnType>
</issueHandlers>
</psalm>',
),
);
$config = $this->project_analyzer->getConfig();
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath(__FILE__)));
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Type.php')));
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Node/Expr/BinaryOp/VirtualPlus.php')));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/OrAnalyzer.php')));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Type/TypeAlias.php')));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Type/TypeAlias/ClassTypeAlias.php')));
}
/**
* @requires extension apcu
* @deprecated Remove in Psalm 6.
*/
public function testConfigWarnsAboutDeprecatedWayToLoadStubsButLoadsTheStub(): void
{
$config_xml = Config::loadFromXML(
(string)getcwd(),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
</psalm>',
);
$this->project_analyzer = $this->getProjectAnalyzerWithConfig($config_xml);
$codebase = $this->project_analyzer->getCodebase();
$config = $this->project_analyzer->getConfig();
$config->visitStubFiles($codebase);
$this->assertContains(realpath('stubs/extensions/apcu.phpstub'), $config->internal_stubs);
$this->assertContains(
'Psalm 6 will not automatically load stubs for ext-apcu. You should explicitly enable or disable this ext in composer.json or Psalm config.',
$config->config_warnings,
);
}
/**
* @requires extension apcu
* @deprecated Remove deprecation warning part in Psalm 6.
*/
public function testConfigWithDisableExtensionsDoesNotLoadExtensionStubsAndHidesDeprecationWarning(): void
{
$config_xml = Config::loadFromXML(
(string)getcwd(),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
</projectFiles>
<disableExtensions>
<extension name="apcu"/>
</disableExtensions>
</psalm>',
);
$this->project_analyzer = $this->getProjectAnalyzerWithConfig($config_xml);
$codebase = $this->project_analyzer->getCodebase();
$config = $this->project_analyzer->getConfig();
$config->visitStubFiles($codebase);
$this->assertNotContains(realpath('stubs/extensions/apcu.phpstub'), $config->internal_stubs);
$this->assertNotContains(
'Psalm 6 will not automatically load stubs for ext-apcu. You should explicitly enable or disable this ext in composer.json or Psalm config.',
$config->internal_stubs,
);
}
public function testReferencedFunctionAllowsMethods(): void
{
$config_xml = Config::loadFromXML(
(string) getcwd(),
<<<XML
<?xml version="1.0"?>
<psalm>
<issueHandlers>
<TooManyArguments>
<errorLevel type="suppress">
<referencedFunction name="Foo\Bar::baz" />
</errorLevel>
</TooManyArguments>
</issueHandlers>
</psalm>
XML,
);
$this->assertSame(
Config::REPORT_SUPPRESS,
$config_xml->getReportingLevelForIssue(
new TooManyArguments(
'too many',
new Raw('aaa', 'aaa.php', 'aaa.php', 1, 2),
'Foo\Bar::baZ',
),
),
);
}
public function testReferencedFunctionAllowsNamespacedFunctions(): void
{
$config_xml = Config::loadFromXML(
(string) getcwd(),
<<<XML
<?xml version="1.0"?>
<psalm>
<issueHandlers>
<UndefinedFunction>
<errorLevel type="suppress">
<referencedFunction name="Foo\Bar\baz" />
</errorLevel>
</UndefinedFunction>
</issueHandlers>
</psalm>
XML,
);
$this->assertSame(
Config::REPORT_SUPPRESS,
$config_xml->getReportingLevelForIssue(
new UndefinedFunction(
'Function Foo\Bar\baz does not exist',
new Raw('aaa', 'aaa.php', 'aaa.php', 1, 2),
'foo\bar\baz',
),
),
);
}
2016-12-29 16:24:10 +01:00
}