2018-10-29 16:41:02 +01:00
|
|
|
<?php
|
2019-05-10 00:58:30 +02:00
|
|
|
namespace Psalm\Tests\Config;
|
2018-10-29 16:41:02 +01:00
|
|
|
|
2020-02-13 13:04:02 +01:00
|
|
|
use PhpParser\Node\Expr\FuncCall;
|
|
|
|
use PHPUnit\Framework\MockObject\MockObject;
|
|
|
|
use Psalm\Plugin\Hook\AfterEveryFunctionCallAnalysisInterface;
|
|
|
|
use Psalm\StatementsSource;
|
2019-07-05 22:24:00 +02:00
|
|
|
use function define;
|
|
|
|
use function defined;
|
|
|
|
use const DIRECTORY_SEPARATOR;
|
|
|
|
use function dirname;
|
|
|
|
use function get_class;
|
|
|
|
use function getcwd;
|
|
|
|
use function microtime;
|
2019-02-24 20:11:36 +01:00
|
|
|
use Psalm\Codebase;
|
2018-10-29 16:41:02 +01:00
|
|
|
use Psalm\Config;
|
|
|
|
use Psalm\Context;
|
2019-03-23 19:27:54 +01:00
|
|
|
use Psalm\Internal\Analyzer\FileAnalyzer;
|
2020-07-11 23:17:22 +02:00
|
|
|
use Psalm\Internal\IncludeCollector;
|
2019-02-24 20:11:36 +01:00
|
|
|
use Psalm\Plugin\Hook\AfterCodebasePopulatedInterface;
|
2019-03-23 19:27:54 +01:00
|
|
|
use Psalm\PluginRegistrationSocket;
|
2018-11-12 16:57:05 +01:00
|
|
|
use Psalm\Tests\Internal\Provider;
|
2019-05-10 00:58:30 +02:00
|
|
|
use Psalm\Tests\TestConfig;
|
2019-06-26 22:52:29 +02:00
|
|
|
use function sprintf;
|
2018-10-29 16:41:02 +01:00
|
|
|
|
2019-05-10 00:58:30 +02:00
|
|
|
class PluginTest extends \Psalm\Tests\TestCase
|
2018-10-29 16:41:02 +01:00
|
|
|
{
|
|
|
|
/** @var TestConfig */
|
|
|
|
protected static $config;
|
|
|
|
|
2019-03-22 20:59:10 +01:00
|
|
|
/** @var ?\Psalm\Internal\Analyzer\ProjectAnalyzer */
|
2018-11-11 18:01:14 +01:00
|
|
|
protected $project_analyzer;
|
2018-10-29 16:41:02 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
2019-05-17 00:36:36 +02:00
|
|
|
public static function setUpBeforeClass() : void
|
2018-10-29 16:41:02 +01:00
|
|
|
{
|
|
|
|
self::$config = new TestConfig();
|
|
|
|
|
|
|
|
if (!defined('PSALM_VERSION')) {
|
|
|
|
define('PSALM_VERSION', '2.0.0');
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!defined('PHP_PARSER_VERSION')) {
|
|
|
|
define('PHP_PARSER_VERSION', '4.0.0');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
2019-05-17 00:36:36 +02:00
|
|
|
public function setUp() : void
|
2018-10-29 16:41:02 +01:00
|
|
|
{
|
2018-11-06 03:57:36 +01:00
|
|
|
FileAnalyzer::clearCache();
|
2018-10-29 16:41:02 +01:00
|
|
|
$this->file_provider = new Provider\FakeFileProvider();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Config $config
|
|
|
|
*
|
2018-11-06 03:57:36 +01:00
|
|
|
* @return \Psalm\Internal\Analyzer\ProjectAnalyzer
|
2018-10-29 16:41:02 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
private function getProjectAnalyzerWithConfig(Config $config)
|
2018-10-29 16:41:02 +01:00
|
|
|
{
|
2020-07-11 23:17:22 +02:00
|
|
|
$config->setIncludeCollector(new IncludeCollector());
|
2018-11-06 03:57:36 +01:00
|
|
|
return new \Psalm\Internal\Analyzer\ProjectAnalyzer(
|
2018-10-29 16:41:02 +01:00
|
|
|
$config,
|
2018-11-06 03:57:36 +01:00
|
|
|
new \Psalm\Internal\Provider\Providers(
|
2018-10-29 16:41:02 +01:00
|
|
|
$this->file_provider,
|
|
|
|
new Provider\FakeParserCacheProvider()
|
2019-05-30 16:30:41 +02:00
|
|
|
),
|
2019-06-09 18:37:28 +02:00
|
|
|
new \Psalm\Report\ReportOptions()
|
2018-10-29 16:41:02 +01:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2018-10-29 16:54:25 +01:00
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2018-10-29 16:54:25 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function testStringAnalyzerPlugin()
|
2018-10-29 16:54:25 +01:00
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('InvalidClass');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
2018-10-29 16:54:25 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2018-10-29 16:54:25 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2018-10-29 16:54:25 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2018-11-06 03:57:36 +01:00
|
|
|
<plugin filename="examples/plugins/StringChecker.php" />
|
2018-10-29 16:54:25 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
2018-11-06 03:57:36 +01:00
|
|
|
$a = "Psalm\Internal\Analyzer\ProjectAnalyzer";'
|
2018-10-29 16:54:25 +01:00
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2018-10-29 16:54:25 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function testStringAnalyzerPluginWithClassConstant()
|
2018-10-29 16:54:25 +01:00
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('InvalidClass');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
2018-10-29 16:54:25 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2018-10-29 16:54:25 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2018-10-29 16:54:25 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2018-11-06 03:57:36 +01:00
|
|
|
<plugin filename="examples/plugins/StringChecker.php" />
|
2018-10-29 16:54:25 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
class A {
|
|
|
|
const C = [
|
2018-11-06 03:57:36 +01:00
|
|
|
"foo" => "Psalm\Internal\Analyzer\ProjectAnalyzer",
|
2018-10-29 16:54:25 +01:00
|
|
|
];
|
|
|
|
}'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
2018-10-29 16:41:02 +01:00
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2018-10-29 16:41:02 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function testStringAnalyzerPluginWithClassConstantConcat()
|
2018-10-29 16:41:02 +01:00
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('UndefinedMethod');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
2018-10-29 16:41:02 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2018-10-29 16:41:02 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2018-10-29 16:41:02 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2018-11-06 03:57:36 +01:00
|
|
|
<plugin filename="examples/plugins/StringChecker.php" />
|
2018-10-29 16:41:02 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
2018-10-29 16:41:02 +01:00
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
class A {
|
|
|
|
const C = [
|
2018-11-06 03:57:36 +01:00
|
|
|
"foo" => \Psalm\Internal\Analyzer\ProjectAnalyzer::class . "::foo",
|
2018-10-29 16:41:02 +01:00
|
|
|
];
|
|
|
|
}'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2018-10-29 16:54:25 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function testEchoAnalyzerPluginWithJustHtml()
|
2018-10-29 16:54:25 +01:00
|
|
|
{
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
2018-10-29 16:54:25 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2018-10-29 16:54:25 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2018-10-29 16:54:25 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2018-11-06 03:57:36 +01:00
|
|
|
<plugin filename="examples/plugins/composer-based/echo-checker/EchoChecker.php" />
|
2018-10-29 16:54:25 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<h3>This is a header</h3>'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2018-10-29 16:54:25 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function testEchoAnalyzerPluginWithUnescapedConcatenatedString()
|
2018-10-29 16:54:25 +01:00
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('TypeCoercion');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
2018-10-29 16:54:25 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2018-10-29 16:54:25 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2018-10-29 16:54:25 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2018-11-06 03:57:36 +01:00
|
|
|
<plugin filename="examples/plugins/composer-based/echo-checker/EchoChecker.php" />
|
2018-10-29 16:54:25 +01:00
|
|
|
</plugins>
|
|
|
|
<issueHandlers>
|
|
|
|
<UndefinedGlobalVariable errorLevel="suppress" />
|
|
|
|
<MixedArgument errorLevel="suppress" />
|
|
|
|
<MixedOperand errorLevel="suppress" />
|
|
|
|
</issueHandlers>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?= $unsafe . "safeString" ?>'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2018-10-29 16:54:25 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function testEchoAnalyzerPluginWithUnescapedString()
|
2018-10-29 16:54:25 +01:00
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('TypeCoercion');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
2018-10-29 16:54:25 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2018-10-29 16:54:25 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2018-10-29 16:54:25 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2018-11-06 03:57:36 +01:00
|
|
|
<plugin filename="examples/plugins/composer-based/echo-checker/EchoChecker.php" />
|
2018-10-29 16:54:25 +01:00
|
|
|
</plugins>
|
|
|
|
<issueHandlers>
|
|
|
|
<UndefinedGlobalVariable errorLevel="suppress" />
|
|
|
|
<MixedArgument errorLevel="suppress" />
|
|
|
|
</issueHandlers>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?= $unsafe ?>'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2018-10-29 16:54:25 +01:00
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
public function testEchoAnalyzerPluginWithEscapedString()
|
2018-10-29 16:54:25 +01:00
|
|
|
{
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
2018-10-29 16:54:25 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2018-10-29 16:54:25 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2018-10-29 16:54:25 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2018-11-06 03:57:36 +01:00
|
|
|
<plugin filename="examples/plugins/composer-based/echo-checker/EchoChecker.php" />
|
2018-10-29 16:54:25 +01:00
|
|
|
</plugins>
|
|
|
|
<issueHandlers>
|
|
|
|
<UndefinedGlobalVariable errorLevel="suppress" />
|
|
|
|
<MixedArgument errorLevel="suppress" />
|
|
|
|
</issueHandlers>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
/**
|
|
|
|
* @param mixed $s
|
|
|
|
* @return html-escaped-string
|
|
|
|
*/
|
|
|
|
function escapeHtml($s) : string {
|
|
|
|
if (!is_scalar($s)) {
|
|
|
|
throw new \UnexpectedValueException("bad value passed to escape");
|
|
|
|
}
|
|
|
|
/** @var html-escaped-string */
|
|
|
|
return htmlentities((string) $s);
|
|
|
|
}
|
|
|
|
?>
|
|
|
|
Some text
|
|
|
|
<?= escapeHtml($unsafe) ?>'
|
|
|
|
);
|
2019-01-07 14:38:56 +01:00
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2019-01-07 14:38:56 +01:00
|
|
|
*/
|
|
|
|
public function testFloatCheckerPlugin()
|
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('NoFloatAssignment');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2019-01-07 14:38:56 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-01-07 14:38:56 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-01-07 14:38:56 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
|
|
|
<plugin filename="examples/plugins/PreventFloatAssignmentChecker.php" />
|
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
|
|
|
|
$a = 5.0;'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function testFloatCheckerPluginIssueSuppressionByConfig()
|
|
|
|
{
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-01-07 14:38:56 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-01-07 14:38:56 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
|
|
|
<plugin filename="examples/plugins/PreventFloatAssignmentChecker.php" />
|
|
|
|
</plugins>
|
|
|
|
|
|
|
|
<issueHandlers>
|
|
|
|
<PluginIssue name="NoFloatAssignment" errorLevel="suppress" />
|
|
|
|
<PluginIssue name="SomeOtherCustomIssue" errorLevel="suppress" />
|
|
|
|
</issueHandlers>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
|
|
|
|
$a = 5.0;'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function testFloatCheckerPluginIssueSuppressionByDocblock()
|
|
|
|
{
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-01-07 14:38:56 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-01-07 14:38:56 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
|
|
|
<plugin filename="examples/plugins/PreventFloatAssignmentChecker.php" />
|
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
|
|
|
|
/** @psalm-suppress NoFloatAssignment */
|
|
|
|
$a = 5.0;'
|
|
|
|
);
|
2018-10-29 16:54:25 +01:00
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
2018-11-06 03:57:36 +01:00
|
|
|
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
/** @return void */
|
|
|
|
public function testInheritedHookHandlersAreCalled()
|
|
|
|
{
|
2019-05-10 00:58:30 +02:00
|
|
|
require_once dirname(__DIR__) . '/fixtures/stubs/extending_plugin_entrypoint.php';
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
|
|
|
<pluginClass class="ExtendingPluginRegistration" />
|
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
$this->assertContains(
|
|
|
|
'ExtendingPlugin',
|
2018-11-11 18:01:14 +01:00
|
|
|
$this->project_analyzer->getCodebase()->config->after_function_checks
|
Plugin loading (#855)
* add ability to load plugins by class names
- Plugins need to implement `__invoke(PluginFacade $psalm):void` method
- Plugins are enabled by adding `<pluginClass
class="Qualified\Class\Name"/>`
- `PluginFacade` provides a single point of contact with Psalm, so that
plugins cannot become coupled to Psalm internals
* added `psalm-plugin` cli tool to manage plugins
Available commands:
`psalm-plugin list` - lists available and enabled plugins
`psalm-plugin enable 'Plugin\Class\Name'` - enables plugin (modifies `psalm.xml`)
`psalm-plugin disable 'Plugin\Class\Name'` - disables plugin (modifies `psalm.xml`)
Plugin installation:
`composer install plugin-vendor/plugin-package-name`
Plugin authoring:
Plugins are identified by package `type` field, which should contain
`psalm-plugin` string.
`extra.pluginClass` should refer to the name of the class implementing
`__invoke(PluginFacade $psalm):void` function
Todo:
- better config file search
- better output for `psalm-plugin`
- better formatting for modified xml file
- composer skeleton project for plugins
- ability to refer to plugins by package name (cli only)
- composer plugin to (optionally) enable plugin upon installation
- documentation on plugin installation and authoring
- interfaces for plugin dependencies
- interface for plugin entry point
- migration path for legacy plugins
* documented previously undocumented plugin methods
* split legacy plugin registration into a wrapper class
also added `PluginApi` namespace and `RegistrationInterface`
* reuse psalm's config search algorithm
* enable/disable plugins by composer package name
* allow specifying alternative config file name
* whitelist PluginApi namespace
three times, but well, it works now
* interface for plugin entry points
* psalm-plugin as a symfony console app
* fixed errors found by psalm
* suppressed false positive UnusedMethods
* cs fix
* better psalm-plugin output
* don't leave empty `plugins` node to avoid old schema violation
* removed junk file that shouldn't be there
* cs fix
* fixed phpunit failure (constant redefinition)
* work around missing docblock in on symfony console
* php 7.0 compatibility
* allow `pluginClass` child elements as plugin configuration
* decouple console commands from undelying implementation
- introduce PluginListFactory
- add `PluginList::enable(string $class)` and `PluginList::disable(string $class)`
* PluginList tests
* ComposerLock test
* droppped debugging statement
* added part of console command tests
* added tests for EnableCommand
* added DisableCommand tests
* ignore unused args
* ConfigFile test
* disable travis cache in attempt to fix builds
* nah, that didn't work
* update for upstream changes
* rebase fixes
* namespaced `extra` entry for entry point
* s/PluginFacade/PluginRegistrationSocket/g
* Added $config parameter to PluginEntryPointInterface::__invoke()
* cs fixes
* entry point interface php7.0 compatibility
* cleaned up old cruft
- dropped todos I'm not going to pursues
- locked entry point to be a class implementing entry point interface
* fixed legacy plugins docs
* Added RegistrationInterface::registerHooksFromClass()
It mimics the way old plugins were registered in Psalm\Config, so
handler classes extending Psalm\Plugin should be fully compatible with
it.
Since Psalm\Plugin-style plugin registration was moved to
RegistrationSocket, LegacyPlugin now only load file-based plugins, so it
was renamed to FileBasedPluginAdapter.
* Converted EchoChecker plugin to composer-based format
- Its subfolder is registered as a local composer package in the root
composer.json, so it's directly installable with
```
composer require psalm/echo-checker-plugin
```
- Migration is trivial: drop the plugin into a separate folder, then add
simple composer.json and the entry point class.
* Updated docs
* Don't reject hook handlers that inherit handling methods
* strip void return type in stub file
2018-11-11 05:23:36 +01:00
|
|
|
);
|
|
|
|
}
|
2019-02-24 20:11:36 +01:00
|
|
|
|
|
|
|
/** @return void */
|
|
|
|
public function testAfterCodebasePopulatedHookIsLoaded()
|
|
|
|
{
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-02-24 20:11:36 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-02-24 20:11:36 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2019-03-23 19:27:54 +01:00
|
|
|
$hook = new class implements AfterCodebasePopulatedInterface {
|
2019-02-24 20:11:36 +01:00
|
|
|
/** @return void */
|
|
|
|
public static function afterCodebasePopulated(Codebase $codebase)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2019-03-01 14:57:10 +01:00
|
|
|
$codebase = $this->project_analyzer->getCodebase();
|
2019-02-24 20:11:36 +01:00
|
|
|
|
2019-03-01 14:57:10 +01:00
|
|
|
$config = $codebase->config;
|
|
|
|
|
|
|
|
(new PluginRegistrationSocket($config, $codebase))->registerHooksFromClass(get_class($hook));
|
2019-02-24 20:11:36 +01:00
|
|
|
|
|
|
|
$this->assertContains(
|
|
|
|
get_class($hook),
|
|
|
|
$this->project_analyzer->getCodebase()->config->after_codebase_populated
|
|
|
|
);
|
|
|
|
}
|
2019-03-01 14:57:10 +01:00
|
|
|
|
|
|
|
/** @return void */
|
|
|
|
public function testPropertyProviderHooks()
|
|
|
|
{
|
|
|
|
require_once __DIR__ . '/Plugin/PropertyPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-03-01 14:57:10 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-03-01 14:57:10 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2019-05-10 00:58:30 +02:00
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\PropertyPlugin" />
|
2019-03-01 14:57:10 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
namespace Ns;
|
|
|
|
|
|
|
|
class Foo {}
|
|
|
|
|
|
|
|
$foo = new Foo();
|
|
|
|
echo $foo->magic_property;'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/** @return void */
|
2020-03-23 18:24:36 +01:00
|
|
|
public function testMethodProviderHooksValidArg()
|
2019-03-01 14:57:10 +01:00
|
|
|
{
|
|
|
|
require_once __DIR__ . '/Plugin/MethodPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-03-01 14:57:10 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-03-01 14:57:10 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2019-05-10 00:58:30 +02:00
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\MethodPlugin" />
|
2019-03-01 14:57:10 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
namespace Ns;
|
|
|
|
|
2020-03-23 18:24:36 +01:00
|
|
|
interface I {}
|
|
|
|
class Foo2 implements I {
|
|
|
|
public function id(): int { return 1; }
|
|
|
|
}
|
2019-03-01 14:57:10 +01:00
|
|
|
class Foo {}
|
|
|
|
|
2020-03-23 18:24:36 +01:00
|
|
|
function i(I $i): void {}
|
|
|
|
|
2019-03-01 14:57:10 +01:00
|
|
|
$foo = new Foo();
|
2020-03-23 18:24:36 +01:00
|
|
|
|
2019-03-01 14:57:10 +01:00
|
|
|
echo $foo->magicMethod("hello");
|
2020-03-23 18:24:36 +01:00
|
|
|
echo $foo::magicMethod("hello");
|
|
|
|
|
|
|
|
$foo2 = $foo->magicMethod2("test");
|
|
|
|
$foo2->id();
|
|
|
|
i($foo2);
|
|
|
|
echo $foo2->id();'
|
2019-03-01 14:57:10 +01:00
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/** @return void */
|
|
|
|
public function testFunctionProviderHooks()
|
|
|
|
{
|
|
|
|
require_once __DIR__ . '/Plugin/FunctionPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-03-01 14:57:10 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-03-01 14:57:10 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2019-05-10 00:58:30 +02:00
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\FunctionPlugin" />
|
2019-03-01 14:57:10 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
magicFunction("hello");'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
2019-05-21 05:14:41 +02:00
|
|
|
/** @return void */
|
|
|
|
public function testSqlStringProviderHooks()
|
|
|
|
{
|
|
|
|
require_once __DIR__ . '/Plugin/SqlStringProviderPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-05-21 05:14:41 +02:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\SqlStringProviderPlugin" />
|
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
$a = "select * from videos;";'
|
|
|
|
);
|
|
|
|
|
|
|
|
$context = new Context();
|
|
|
|
$this->analyzeFile($file_path, $context);
|
|
|
|
|
|
|
|
$this->assertTrue(isset($context->vars_in_scope['$a']));
|
|
|
|
|
2020-01-04 18:20:26 +01:00
|
|
|
foreach ($context->vars_in_scope['$a']->getAtomicTypes() as $type) {
|
2019-05-21 05:14:41 +02:00
|
|
|
$this->assertInstanceOf(\Psalm\Test\Config\Plugin\Hook\StringProvider\TSqlSelectString::class, $type);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-03-01 14:57:10 +01:00
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2019-03-01 14:57:10 +01:00
|
|
|
*/
|
|
|
|
public function testPropertyProviderHooksInvalidAssignment()
|
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('InvalidPropertyAssignmentValue');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2019-03-01 14:57:10 +01:00
|
|
|
require_once __DIR__ . '/Plugin/PropertyPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-03-01 14:57:10 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-03-01 14:57:10 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2019-05-10 00:58:30 +02:00
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\PropertyPlugin" />
|
2019-03-01 14:57:10 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
namespace Ns;
|
|
|
|
|
|
|
|
class Foo {}
|
|
|
|
|
|
|
|
$foo = new Foo();
|
|
|
|
$foo->magic_property = 5;'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2019-03-01 14:57:10 +01:00
|
|
|
*/
|
|
|
|
public function testMethodProviderHooksInvalidArg()
|
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('InvalidScalarArgument');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2019-03-01 14:57:10 +01:00
|
|
|
require_once __DIR__ . '/Plugin/MethodPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-03-01 14:57:10 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-03-01 14:57:10 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2019-05-10 00:58:30 +02:00
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\MethodPlugin" />
|
2019-03-01 14:57:10 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
namespace Ns;
|
|
|
|
|
|
|
|
class Foo {}
|
|
|
|
|
|
|
|
$foo = new Foo();
|
|
|
|
echo $foo->magicMethod(5);'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-05-17 00:36:36 +02:00
|
|
|
* @return void
|
2019-03-01 14:57:10 +01:00
|
|
|
*/
|
|
|
|
public function testFunctionProviderHooksInvalidArg()
|
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectExceptionMessage('InvalidScalarArgument');
|
|
|
|
$this->expectException(\Psalm\Exception\CodeException::class);
|
2019-03-01 14:57:10 +01:00
|
|
|
require_once __DIR__ . '/Plugin/FunctionPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-03-01 14:57:10 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-03-01 14:57:10 +01:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2019-05-10 00:58:30 +02:00
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\FunctionPlugin" />
|
2019-03-01 14:57:10 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
magicFunction(5);'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
2019-03-23 17:47:46 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function testAfterAnalysisHooks()
|
|
|
|
{
|
|
|
|
require_once __DIR__ . '/Plugin/AfterAnalysisPlugin.php';
|
|
|
|
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-03-23 17:47:46 +01:00
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-03-23 17:47:46 +01:00
|
|
|
<projectFiles>
|
2019-05-10 00:23:14 +02:00
|
|
|
<directory name="tests/fixtures/DummyProject" />
|
2019-03-23 17:47:46 +01:00
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
2019-05-10 00:58:30 +02:00
|
|
|
<pluginClass class="Psalm\\Test\\Config\\Plugin\\AfterAnalysisPlugin" />
|
2019-03-23 17:47:46 +01:00
|
|
|
</plugins>
|
|
|
|
</psalm>'
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
|
2019-06-09 18:37:28 +02:00
|
|
|
$this->assertNotNull($this->project_analyzer->stdout_report_options);
|
|
|
|
|
|
|
|
$this->project_analyzer->stdout_report_options->format = \Psalm\Report::TYPE_JSON;
|
2019-03-23 17:47:46 +01:00
|
|
|
|
2019-05-10 00:23:14 +02:00
|
|
|
$this->project_analyzer->check('tests/fixtures/DummyProject', true);
|
2019-03-23 17:47:46 +01:00
|
|
|
\Psalm\IssueBuffer::finish($this->project_analyzer, true, microtime(true));
|
|
|
|
}
|
2019-05-03 16:27:09 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function testPluginFilenameCanBeAbsolute()
|
|
|
|
{
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-05-03 16:27:09 +02:00
|
|
|
sprintf(
|
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-05-03 16:27:09 +02:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
|
|
|
<plugin filename="%s/examples/plugins/StringChecker.php" />
|
|
|
|
</plugins>
|
|
|
|
</psalm>',
|
2019-07-05 22:24:00 +02:00
|
|
|
__DIR__ . '/../..'
|
2019-05-03 16:27:09 +02:00
|
|
|
)
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
}
|
|
|
|
|
2019-05-17 00:36:36 +02:00
|
|
|
public function testPluginInvalidAbsoluteFilenameThrowsException() : void
|
2019-05-03 16:27:09 +02:00
|
|
|
{
|
2019-05-17 00:36:36 +02:00
|
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
|
|
$this->expectExceptionMessage('does-not-exist/plugins/StringChecker.php');
|
|
|
|
|
2019-05-03 16:27:09 +02:00
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
2019-05-10 00:58:30 +02:00
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
2019-05-03 16:27:09 +02:00
|
|
|
sprintf(
|
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
>
|
2019-05-03 16:27:09 +02:00
|
|
|
<projectFiles>
|
|
|
|
<directory name="src" />
|
|
|
|
</projectFiles>
|
|
|
|
<plugins>
|
|
|
|
<plugin filename="%s/does-not-exist/plugins/StringChecker.php" />
|
|
|
|
</plugins>
|
|
|
|
</psalm>',
|
2019-07-05 22:24:00 +02:00
|
|
|
__DIR__ . '/..'
|
2019-05-03 16:27:09 +02:00
|
|
|
)
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
}
|
2020-02-13 13:04:02 +01:00
|
|
|
|
|
|
|
public function testAfterEveryFunctionPluginIsCalledInAllCases(): void
|
|
|
|
{
|
|
|
|
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
|
|
|
|
TestConfig::loadFromXML(
|
|
|
|
dirname(__DIR__, 2) . DIRECTORY_SEPARATOR,
|
|
|
|
'<?xml version="1.0"?>
|
2020-03-23 18:24:36 +01:00
|
|
|
<psalm
|
|
|
|
errorLevel="1"
|
|
|
|
></psalm>'
|
2020-02-13 13:04:02 +01:00
|
|
|
)
|
|
|
|
);
|
|
|
|
|
|
|
|
$mock = $this->getMockBuilder(\stdClass::class)->setMethods(['check'])->getMock();
|
2020-06-25 19:05:34 +02:00
|
|
|
$mock->expects($this->exactly(4))
|
2020-02-13 13:04:02 +01:00
|
|
|
->method('check')
|
|
|
|
->withConsecutive(
|
2020-06-25 19:05:34 +02:00
|
|
|
[$this->equalTo('b')],
|
2020-02-13 13:04:02 +01:00
|
|
|
[$this->equalTo('array_map')],
|
|
|
|
[$this->equalTo('fopen')],
|
|
|
|
[$this->equalTo('a')]
|
|
|
|
);
|
|
|
|
$plugin = new class($mock) implements AfterEveryFunctionCallAnalysisInterface {
|
|
|
|
/** @var MockObject */
|
|
|
|
private static $m;
|
|
|
|
|
|
|
|
public function __construct(MockObject $m)
|
|
|
|
{
|
|
|
|
self::$m = $m;
|
|
|
|
}
|
|
|
|
|
|
|
|
public static function afterEveryFunctionCallAnalysis(
|
|
|
|
FuncCall $expr,
|
|
|
|
string $function_id,
|
|
|
|
Context $context,
|
|
|
|
StatementsSource $statements_source,
|
|
|
|
Codebase $codebase
|
|
|
|
): void {
|
|
|
|
/** @psalm-suppress UndefinedInterfaceMethod */
|
|
|
|
self::$m->check($function_id);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
$this->project_analyzer->getCodebase()->config->initializePlugins($this->project_analyzer);
|
|
|
|
$this->project_analyzer->getCodebase()->config->after_every_function_checks[] = get_class($plugin);
|
|
|
|
|
|
|
|
$file_path = getcwd() . '/src/somefile.php';
|
|
|
|
|
|
|
|
$this->addFile(
|
|
|
|
$file_path,
|
|
|
|
'<?php
|
|
|
|
|
|
|
|
function a(): void {}
|
|
|
|
function b(int $e): int { return $e; }
|
|
|
|
|
|
|
|
array_map("b", [1,3,3]);
|
|
|
|
fopen("/tmp/foo.dat", "r");
|
|
|
|
a();
|
|
|
|
'
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->analyzeFile($file_path, new Context());
|
|
|
|
}
|
2018-10-29 16:41:02 +01:00
|
|
|
}
|