mirror of
https://github.com/danog/psalm.git
synced 2024-12-11 08:49:52 +01:00
618 lines
20 KiB
PHP
618 lines
20 KiB
PHP
<?php
|
|
|
|
namespace Psalm\Tests\LanguageServer;
|
|
|
|
use LanguageServerProtocol\Position;
|
|
use Psalm\Context;
|
|
use Psalm\Internal\Analyzer\FileAnalyzer;
|
|
use Psalm\Internal\Analyzer\ProjectAnalyzer;
|
|
use Psalm\Internal\Provider\FakeFileProvider;
|
|
use Psalm\Internal\Provider\Providers;
|
|
use Psalm\Tests\Internal\Provider\FakeFileReferenceCacheProvider;
|
|
use Psalm\Tests\Internal\Provider\ParserInstanceCacheProvider;
|
|
use Psalm\Tests\Internal\Provider\ProjectCacheProvider;
|
|
use Psalm\Tests\TestCase;
|
|
use Psalm\Tests\TestConfig;
|
|
|
|
class SymbolLookupTest extends TestCase
|
|
{
|
|
public function setUp(): void
|
|
{
|
|
parent::setUp();
|
|
|
|
$this->file_provider = new FakeFileProvider();
|
|
|
|
$config = new TestConfig();
|
|
|
|
$providers = new Providers(
|
|
$this->file_provider,
|
|
new ParserInstanceCacheProvider(),
|
|
null,
|
|
null,
|
|
new FakeFileReferenceCacheProvider(),
|
|
new ProjectCacheProvider()
|
|
);
|
|
|
|
$this->project_analyzer = new ProjectAnalyzer(
|
|
$config,
|
|
$providers
|
|
);
|
|
|
|
$this->project_analyzer->setPhpVersion('7.3', 'tests');
|
|
$this->project_analyzer->getCodebase()->store_node_types = true;
|
|
}
|
|
|
|
public function testSimpleSymbolLookup(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->globals['$my_global'] = 'string';
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
const APPLE = "🍏";
|
|
|
|
class A {
|
|
/** @var int|null */
|
|
protected $a;
|
|
|
|
const BANANA = "🍌";
|
|
|
|
public function foo() : void {
|
|
$a = 1;
|
|
echo $a;
|
|
}
|
|
}
|
|
|
|
function bar() : int {
|
|
return 5;
|
|
}
|
|
|
|
function baz(int $a) : int {
|
|
return $a;
|
|
}
|
|
|
|
function qux(int $a, int $b) : int {
|
|
return $a + $b;
|
|
}
|
|
|
|
$_SESSION;'
|
|
);
|
|
|
|
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
|
|
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'B\A::foo()');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame('<?php public function foo() : void', $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'B\A::$a');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame('<?php protected int|null $a', $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'B\bar()');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame('<?php function B\bar() : int', $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'B\A::BANANA');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame('<?php BANANA', $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'B\baz()');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame("<?php function B\baz(\n int \$a\n) : int", $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'B\qux()');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame("<?php function B\qux(\n int \$a,\n int \$b\n) : int", $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', '$_SESSION');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame("<?php array<string, mixed>", $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', '$my_global');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame("<?php string", $information['type']);
|
|
}
|
|
|
|
public function testSimpleSymbolLookupGlobalConst(): void
|
|
{
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
define("BANANA", "🍌");
|
|
const APPLE = "🍏";'
|
|
);
|
|
|
|
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
|
|
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'APPLE');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame("<?php const APPLE string", $information['type']);
|
|
|
|
$information = $codebase->getSymbolInformation('somefile.php', 'BANANA');
|
|
$this->assertNotNull($information);
|
|
$this->assertSame("<?php const BANANA string", $information['type']);
|
|
}
|
|
|
|
public function testSimpleSymbolLocation(): void
|
|
{
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
class A {
|
|
/** @var int|null */
|
|
protected $a;
|
|
|
|
const BANANA = "nana";
|
|
|
|
public function foo() : void {
|
|
$a = 1;
|
|
echo $a;
|
|
}
|
|
}
|
|
|
|
function bar() : int {
|
|
return 5;
|
|
}'
|
|
);
|
|
|
|
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
|
|
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$method_symbol_location = $codebase->getSymbolLocation('somefile.php', 'B\A::foo()');
|
|
|
|
$this->assertNotNull($method_symbol_location);
|
|
$this->assertSame(10, $method_symbol_location->getLineNumber());
|
|
$this->assertSame(37, $method_symbol_location->getColumn());
|
|
|
|
$property_symbol_location = $codebase->getSymbolLocation('somefile.php', 'B\A::$a');
|
|
|
|
$this->assertNotNull($property_symbol_location);
|
|
$this->assertSame(6, $property_symbol_location->getLineNumber());
|
|
$this->assertSame(31, $property_symbol_location->getColumn());
|
|
|
|
$constant_symbol_location = $codebase->getSymbolLocation('somefile.php', 'B\A::BANANA');
|
|
|
|
$this->assertNotNull($constant_symbol_location);
|
|
$this->assertSame(8, $constant_symbol_location->getLineNumber());
|
|
$this->assertSame(27, $constant_symbol_location->getColumn());
|
|
|
|
$function_symbol_location = $codebase->getSymbolLocation('somefile.php', 'B\bar()');
|
|
|
|
$this->assertNotNull($function_symbol_location);
|
|
$this->assertSame(16, $function_symbol_location->getLineNumber());
|
|
$this->assertSame(26, $function_symbol_location->getColumn());
|
|
|
|
$function_symbol_location = $codebase->getSymbolLocation('somefile.php', '257-259');
|
|
|
|
$this->assertNotNull($function_symbol_location);
|
|
$this->assertSame(11, $function_symbol_location->getLineNumber());
|
|
$this->assertSame(25, $function_symbol_location->getColumn());
|
|
}
|
|
|
|
public function testSymbolLookupAfterAlteration(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
class A {
|
|
/** @var int|null */
|
|
protected $a;
|
|
|
|
public function foo() : voi {
|
|
$a = 1;
|
|
$b = $this->a;
|
|
$c = $b;
|
|
|
|
echo $a;
|
|
}
|
|
|
|
public function bar() : void {
|
|
$a = 2;
|
|
echo $a;
|
|
}
|
|
}'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$codebase->addTemporaryFileChanges(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
class A {
|
|
/** @var int|null */
|
|
protected $a;
|
|
|
|
public function foo() : void {
|
|
$a = 1;
|
|
$b = $this->a;
|
|
$c = $b;
|
|
|
|
echo $a;
|
|
}
|
|
|
|
public function bar() : void {
|
|
$a = 2;
|
|
echo $a;
|
|
}
|
|
}'
|
|
);
|
|
|
|
$codebase->reloadFiles($this->project_analyzer, ['somefile.php']);
|
|
|
|
$codebase->analyzer->analyzeFiles($this->project_analyzer, 1, false);
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(10, 30));
|
|
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('245-246:int|null', $symbol_at_position[0]);
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(12, 30));
|
|
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('213-214:1', $symbol_at_position[0]);
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(17, 30));
|
|
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('425-426:2', $symbol_at_position[0]);
|
|
}
|
|
|
|
public function testGetSymbolPositionMissingArg(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
class A {
|
|
public function foo(int $i) : string {
|
|
return "hello";
|
|
}
|
|
|
|
public function bar() : void {
|
|
$this->foo();
|
|
}
|
|
}'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(9, 33));
|
|
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('B\A::foo()', $symbol_at_position[0]);
|
|
}
|
|
|
|
public function testGetSymbolPositionGlobalVariable(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$codebase->reportUnusedVariables();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
$config->globals['$my_global'] = 'string';
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
function foo() : void {
|
|
global $my_global;
|
|
echo $my_global;
|
|
}'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(2, 31));
|
|
$this->assertNotNull($symbol_at_position);
|
|
$this->assertSame('$my_global', $symbol_at_position[0]);
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(3, 28));
|
|
$this->assertNotNull($symbol_at_position);
|
|
$this->assertSame('73-82:string', $symbol_at_position[0]);
|
|
}
|
|
|
|
public function testGetSymbolPositionNullableArg(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
class AClass {
|
|
}
|
|
function B( ?AClass $class ) {
|
|
}'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(4, 33));
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('B\AClass', $symbol_at_position[0]);
|
|
}
|
|
|
|
public function testGetSymbolPositionMethodWrongReturnType(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
class AClass {
|
|
/**
|
|
* @return Some
|
|
*/
|
|
protected function get_command() : AClass {
|
|
}
|
|
}
|
|
'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(6, 60));
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('B\AClass', $symbol_at_position[0]);
|
|
}
|
|
|
|
public function testGetSymbolPositionUseStatement(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
use StreamWrapper;
|
|
'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(2, 25));
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('StreamWrapper', $symbol_at_position[0]);
|
|
}
|
|
|
|
public function testGetSymbolPositionRange(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
function foo() : string {
|
|
}
|
|
|
|
$active_symbol = foo();'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
// This is focusing the $active_symbol variable, the LSP Range that is
|
|
// returned should also point to the same variable (that's where hover popovers will show)
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(6, 26));
|
|
|
|
$this->assertNotNull($symbol_at_position);
|
|
$this->assertSame(16, $symbol_at_position[1]->start->character);
|
|
$this->assertSame(30, $symbol_at_position[1]->end->character);
|
|
}
|
|
|
|
public function testGetTypeInDocblock(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
class A {
|
|
/** @var \Exception|null */
|
|
public $prop;
|
|
}'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$symbol_at_position = $codebase->getReferenceAtPosition('somefile.php', new Position(4, 35));
|
|
|
|
$this->assertNotNull($symbol_at_position);
|
|
|
|
$this->assertSame('Exception', $symbol_at_position[0]);
|
|
}
|
|
|
|
/**
|
|
* @return array<int, array{0: Position, 1: ?string, 2: ?int, 3: ?int}>
|
|
*/
|
|
public function providerGetSignatureHelp(): array
|
|
{
|
|
return [
|
|
[new Position(5, 34), null, null, null],
|
|
[new Position(5, 35), 'B\A::foo', 0, 2],
|
|
[new Position(5, 36), null, null, null],
|
|
[new Position(6, 34), null, null, null],
|
|
[new Position(6, 35), 'B\A::foo', 0, 2],
|
|
[new Position(6, 40), 'B\A::foo', 0, 2],
|
|
[new Position(6, 41), 'B\A::foo', 1, 2],
|
|
[new Position(6, 47), 'B\A::foo', 1, 2],
|
|
[new Position(6, 48), null, null, null],
|
|
[new Position(7, 40), 'B\A::foo', 0, 2],
|
|
[new Position(7, 41), 'B\A::foo', 1, 2],
|
|
[new Position(7, 42), 'B\A::foo', 1, 2],
|
|
[new Position(8, 40), 'B\A::foo', 0, 2],
|
|
[new Position(8, 46), 'B\A::bar', 0, 1],
|
|
[new Position(8, 47), 'B\A::foo', 0, 2],
|
|
[new Position(10, 40), 'B\A::staticfoo', 0, 1],
|
|
// [new Position(12, 28), 'B\foo', 0, 1],
|
|
[new Position(14, 30), 'B\A::__construct', 0, 0],
|
|
[new Position(16, 31), 'strlen', 0, 1],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerGetSignatureHelp
|
|
*/
|
|
public function testGetSignatureHelp(
|
|
Position $position,
|
|
?string $expected_symbol,
|
|
?int $expected_argument_number,
|
|
?int $expected_param_count
|
|
): void {
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
|
|
class A {
|
|
public function foo(string $a, array $b) {
|
|
$this->foo();
|
|
$this->foo("Foo", "Bar");
|
|
$this->foo("Foo", );
|
|
$this->foo($this->bar());
|
|
|
|
self::staticFoo();
|
|
|
|
foo();
|
|
|
|
new A();
|
|
|
|
strlen();
|
|
}
|
|
|
|
public function bar(string $a) {}
|
|
|
|
public static function staticFoo(string $a) {}
|
|
|
|
public function __construct() {}
|
|
}
|
|
|
|
function foo(string $a) {
|
|
}'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$reference_location = $codebase->getFunctionArgumentAtPosition('somefile.php', $position);
|
|
|
|
if ($expected_symbol !== null) {
|
|
$this->assertNotNull($reference_location);
|
|
[$symbol, $argument_number] = $reference_location;
|
|
$this->assertSame($expected_symbol, $symbol);
|
|
$this->assertSame($expected_argument_number, $argument_number);
|
|
|
|
$symbol_information = $codebase->getSignatureInformation($reference_location[0]);
|
|
|
|
if ($expected_param_count === null) {
|
|
$this->assertNull($symbol_information);
|
|
} else {
|
|
$this->assertNotNull($symbol_information);
|
|
$this->assertNotNull($symbol_information->parameters);
|
|
$this->assertCount($expected_param_count, $symbol_information->parameters);
|
|
}
|
|
} else {
|
|
$this->assertNull($reference_location);
|
|
}
|
|
}
|
|
|
|
public function testGetSignatureHelpIncludesParamDescription(): void
|
|
{
|
|
$codebase = $this->project_analyzer->getCodebase();
|
|
$config = $codebase->config;
|
|
$config->throw_exception = false;
|
|
|
|
$this->addFile(
|
|
'somefile.php',
|
|
'<?php
|
|
namespace B;
|
|
/**
|
|
* @param string $a The first param, a.
|
|
*/
|
|
function foo(string $a) {
|
|
}
|
|
foo();'
|
|
);
|
|
|
|
$codebase->file_provider->openFile('somefile.php');
|
|
$codebase->scanFiles();
|
|
$this->analyzeFile('somefile.php', new Context());
|
|
|
|
$reference_location = $codebase->getFunctionArgumentAtPosition('somefile.php', new Position(7, 20));
|
|
$this->assertNotNull($reference_location);
|
|
$symbol_information = $codebase->getSignatureInformation($reference_location[0], 'somefile.php');
|
|
$this->assertNotNull($symbol_information);
|
|
$this->assertNotNull($symbol_information->parameters);
|
|
$this->assertEquals('The first param, a.', $symbol_information->parameters[0]->documentation);
|
|
}
|
|
}
|